mindspore.ops.Conv3D

class mindspore.ops.Conv3D(out_channel, kernel_size, mode=1, pad_mode='valid', pad=0, stride=1, dilation=1, group=1, data_format='NCDHW')[源代码]

对输入Tensor计算三维卷积。通常,输入Tensor的shape为 \((N, C_{in}, D_{in}, H_{in}, W_{in})\) ,输出 shape为 \((N, C_{out}, D_{out}, H_{out}, W_{out})\) 。其中 \(N\) 为batch size,\(C\) 为通道数,\(D\) 为深度, \(H, W\) 分别为特征层的高度和宽度。 对于一个特征层,其输出结果由如下公式计算:

\[\operatorname{out}\left(N_{i}, C_{\text {out}_j}\right)=\operatorname{bias}\left(C_{\text {out}_j}\right)+ \sum_{k=0}^{C_{in}-1} ccor(\text {weight}\left(C_{\text {out}_j}, k\right), \operatorname{input}\left(N_{i}, k\right))\]

其中,\(k\) 为卷积核数,\(ccor\)cross-correlation\(C_{in}\) 为输入通道数, \(j\) 的范围从 \(0\)\(C_{out} - 1\)\(out_{j}\) 对应输出的第 \(j\) 个通道。 \(\text{weight}(C_{\text{out}_j}, k)\) 为卷积核的切片,其shape为 \((\text{kernel_size[0]}, \text{kernel_size[1]}, \text{kernel_size[2]})\) ,其中 \(\text{kernel_size[0]}\), \(\text{kernel_size[1]}\)\(\text{kernel_size[2]}\) 分别是卷积核的深度、高度和宽度。 \(\text{bias}\) 是偏置参数, \(\text{X}\) 是输入Tensor。 完整卷积核的shape为 \((C_{out}, C_{in} / \text{group}, \text{kernel_size[0]}, \text{kernel_size[1]}, \text{kernel_size[2]})\) ,其中 group 是在通道上分割输入 inputs 的组数。

详细内容请参考论文 Gradient Based Learning Applied to Document Recognition

如果指定 pad_mode 为 “valid”,则输出的深度、高度和宽度分别为 \(\left \lfloor{1 + \frac{D_{in} + 2 \times \text{padding} - \text{ks_d} - (\text{ks_d} - 1) \times (\text{dilation} - 1) }{\text{stride}}} \right \rfloor\)\(\left \lfloor{1 + \frac{H_{in} + 2 \times \text{padding} - \text{ks_h} - (\text{ks_h} - 1) \times (\text{dilation} - 1) }{\text{stride}}} \right \rfloor\) 以及 \(\left \lfloor{1 + \frac{W_{in} + 2 \times \text{padding} - \text{ks_w} - (\text{ks_w} - 1) \times (\text{dilation} - 1) }{\text{stride}}} \right \rfloor\) ,其中 \(dilation\) 为三维卷积核膨胀尺寸, \(stride\) 为移动步长, \(padding\) 为在输入两侧的填充长度。

说明

在Ascend平台上,目前只支持 \(group=1\)

参数:
  • out_channel (int) - 输出的通道数 \(C_{out}\)

  • kernel_size (Union[int, tuple[int]]) - 指定三维卷积核的深度、高度和宽度。可以为单个int或包含三个整数的Tuple。一个整数表示卷积核的深度、高度和宽度均为该值。包含三个整数的Tuple分别表示卷积核的深度、高度和宽度。

  • mode (int) - 指定不同的卷积模式。此值目前未被使用。默认值:1。

  • stride (Union[int, tuple[int]],可选) - 卷积核移动的步长,可以为单个int或三个int组成的tuple。一个int表示在深度、高度和宽度方向的移动步长均为该值。三个int组成的tuple分别表示在深度、高度和宽度方向的移动步长。默认值:1。

  • pad_mode (str,可选) - 指定填充模式。取值为”same”,”valid”,或”pad”。默认值:”valid”。

    • “same”: 输出的高度和宽度分别与输入整除 stride 后的值相同。填充将被均匀地添加到高和宽的两侧,剩余填充量将被添加到维度末端。若设置该模式, pad 的值必须为0。

    • “valid”: 在不填充的前提下返回有效计算所得的输出。不满足计算的多余像素会被丢弃。如果设置此模式,则 pad 的值必须为0。

    • “pad”: 对输入 input 进行填充。在输入的高度和宽度方向上填充 pad 大小的0。如果设置此模式, pad 必须大于或等于0。

  • pad (Union(int, tuple[int])) - 填充值。如果 pad 是一个整数,则前部、后部、顶部,底部,左边和右边的填充都等于 pad 。如果 pad 是6个整数的Tuple,则前部、后部、顶部、底部、左边和右边的填充分别等于填充 pad[0]pad[1]pad[2]pad[3]pad[4]pad[5] 。默认值:0。

  • dilation (Union[int, tuple[int]],可选) - 卷积核膨胀尺寸。数据类型为int或由3个int组成的tuple: \((dilation_d, dilation_h, dilation_w)\)。目前在Ascend后端,只支持该值为1。若 \(k > 1\) ,则卷积核间隔 k 个元素进行采样。前后、垂直和水平方向上,其取值范围分别为[1, D]、[1, H]和[1, W]。默认值:1。

  • group (int,可选) - 将过滤器拆分的组数, in_channelsout_channels 必须可被 group 整除。默认值:1。

  • data_format (str) - 支持的数据模式。目前仅支持”NCDHW”。

输入:
  • x (Tensor) - shape为 \((N, C_{in}, D_{in}, H_{in}, W_{in})\) 的Tensor。目前数据类型仅支持float16和float32。

  • weight (Tensor) - 若kernel shape为 \((k_d, K_h, K_w)\) ,则weight shape应为 \((C_{out}, C_{in}/groups, k_d, K_h, K_w)\) 。目前数据类型仅支持float16和float32。

  • bias (Tensor) - shape为 \(C_{in}\) 的Tensor。目前仅支持None。默认值:None。

输出:

Tensor,shape为 \((N, C_{out}, D_{out}, H_{out}, W_{out})\)

异常:
  • TypeError - out_channelgroup 不是int。

  • TypeError - kernel_sizestridepaddilation 既不是int也不是Tuple。

  • ValueError - out_channelkernel_sizestridedilation 小于1。

  • ValueError - pad 小于0。

  • ValueError - pad_mode 取值非”same”、”valid”或”pad”。

  • ValueError - pad 为长度不等于6的Tuple。

  • ValueError - pad_mode 未设定为”pad”且 pad 不等于(0, 0, 0, 0, 0, 0)。

  • ValueError - data_format 取值非”NCDHW”。

支持平台:

Ascend GPU CPU

样例:

>>> x = Tensor(np.ones([16, 3, 10, 32, 32]), mindspore.float16)
>>> weight = Tensor(np.ones([32, 3, 4, 3, 3]), mindspore.float16)
>>> conv3d = ops.Conv3D(out_channel=32, kernel_size=(4, 3, 3))
>>> output = conv3d(x, weight)
>>> print(output.shape)
(16, 32, 7, 30, 30)