conv3d

paddle.nn.functional. conv3d ( x, weight, bias=None, stride=1, padding=0, dilation=1, groups=1, data_format='NCHW', name=None ) [源代码]

该OP是三维卷积层(convolution3D layer),根据输入、卷积核、步长(stride)、填充(padding)、空洞大小(dilations)一组参数计算得到输出特征层大小。输入和输出是NCDHW或NDWHC格式,其中N是批尺寸,C是通道数,D是特征层深度,H是特征层高度,W是特征层宽度。三维卷积(Convlution3D)和二维卷积(Convlution2D)相似,但多了一维深度信息(depth)。如果bias_attr不为False,卷积计算会添加偏置项。

对每个输入X,有等式:

\[Out = \sigma \left ( W * X + b \right )\]
其中:
  • \(X\) :输入值,NCDHW或NDHWC格式的5-D Tensor

  • \(W\) :卷积核值,MCDHW格式的5-D Tensor

  • \(*\) :卷积操作

  • \(b\) :偏置值,2-D Tensor,形为 [M,1]

  • \(\sigma\) :激活函数

  • \(Out\) :输出值, NCDHW或NDHWC格式的5-D Tensor,和 X 的形状可能不同

示例

  • 输入:

    输入形状: \((N, C_{in}, D_{in}, H_{in}, W_{in})\)

    卷积核形状: \((C_{out}, C_{in}, D_f, H_f, W_f)\)

  • 输出:

    输出形状: \((N, C_{out}, D_{out}, H_{out}, W_{out})\)

参数:
  • x (Tensor) - 输入是形状为 \([N, C, H, W]\)\([N, H, W, C]\) 的4-D Tensor,N是批尺寸,C是通道数,H是特征高度,W是特征宽度,数据类型为float16, float32或float64。

  • weight (Tensor) - 形状为 \([M, C/g, kH, kW]\) 的卷积核(卷积核)。 M是输出通道数, g是分组的个数,kH是卷积核的高度,kW是卷积核的宽度。

  • bias (int|list|tuple) - 偏置项,形状为: \([M,]\)

  • stride (int|list|tuple,可选) - 步长大小。卷积核和输入进行卷积计算时滑动的步长。如果它是一个列表或元组,则必须包含两个整型数:(stride_height,stride_width)。若为一个整数,stride_height = stride_width = stride。默认值:1。

  • padding (int|list|tuple|str,可选) - 填充大小。如果它是一个字符串,可以是"VALID"或者"SAME",表示填充算法,计算细节可参考上述 padding = "SAME"或 padding = "VALID" 时的计算公式。如果它是一个元组或列表,它可以有3种格式:(1)包含5个二元组:当 data_format 为"NCDHW"时为 [[0,0], [0,0], [padding_depth_front, padding_depth_back], [padding_height_top, padding_height_bottom], [padding_width_left, padding_width_right]],当 data_format 为"NDHWC"时为[[0,0], [padding_depth_front, padding_depth_back], [padding_height_top, padding_height_bottom], [padding_width_left, padding_width_right], [0,0]];(2)包含6个整数值:[padding_depth_front, padding_depth_back, padding_height_top, padding_height_bottom, padding_width_left, padding_width_right];(3)包含3个整数值:[padding_depth, padding_height, padding_width],此时 padding_depth_front = padding_depth_back = padding_depth, padding_height_top = padding_height_bottom = padding_height, padding_width_left = padding_width_right = padding_width。若为一个整数,padding_depth = padding_height = padding_width = padding。默认值:0。

  • dilation (int|list|tuple,可选) - 空洞大小。空洞卷积时会使用该参数,卷积核对输入进行卷积时,感受野里每相邻两个特征点之间的空洞信息。如果空洞大小为列表或元组,则必须包含两个整型数:(dilation_height,dilation_width)。若为一个整数,dilation_height = dilation_width = dilation。默认值:1。

  • groups (int,可选) - 二维卷积层的组数。根据Alex Krizhevsky的深度卷积神经网络(CNN)论文中的成组卷积:当group=n,输入和卷积核分别根据通道数量平均分为n组,第一组卷积核和第一组输入进行卷积计算,第二组卷积核和第二组输入进行卷积计算,……,第n组卷积核和第n组输入进行卷积计算。默认值:1。

  • weight_attr (ParamAttr,可选) - 指定权重参数属性的对象。默认值为None,表示使用默认的权重参数属性。具体用法请参见 ParamAttr

  • bias_attr (ParamAttr|bool,可选)- 指定偏置参数属性的对象。若 bias_attr 为bool类型,只支持为False,表示没有偏置参数。默认值为None,表示使用默认的偏置参数属性。具体用法请参见 ParamAttr

  • data_format (str,可选) - 指定输入的数据格式,输出的数据格式将与输入保持一致,可以是"NCHW"和"NHWC"。N是批尺寸,C是通道数,H是特征高度,W是特征宽度。默认值:"NCHW"。

  • name (str,可选) – 具体用法请参见 cn_api_guide_Name ,一般无需设置,默认值:None。

返回:5-D Tensor,数据类型与 input 一致。返回卷积计算的结果。

返回类型:Tensor。

抛出异常:
  • ValueError - 如果 use_cudnn 不是bool值。

  • ValueError - 如果 data_format 既不是"NCDHW"也不是"NDHWC"。

  • ValueError - 如果 input 的通道数未被明确定义。

  • ValueError - 如果 padding 是字符串,既不是"SAME"也不是"VALID"。

  • ValueError - 如果 padding 含有5个二元组,与批尺寸对应维度的值不为0或者与通道对应维度的值不为0。

  • ShapeError - 如果输入不是5-D Tensor。

  • ShapeError - 如果输入和卷积核的维度大小不相同。

  • ShapeError - 如果输入的维度大小与 stride 之差不是2。

  • ShapeError - 如果输出的通道数不能被 groups 整除。

代码示例

import paddle
import paddle.nn.functional as F

x_var = paddle.randn((2, 3, 8, 8, 8), dtype='float32')
w_var = paddle.randn((6, 3, 3, 3, 3), dtype='float32')

y_var = F.conv3d(x_var, w_var)
y_np = y_var.numpy()

print(y_np.shape)
# (2, 6, 6, 6, 6)