mindspore.ops.conv3d

mindspore.ops.conv3d(inputs, weight, pad_mode='valid', padding=0, stride=1, dilation=1, group=1)

对输入Tensor计算三维卷积。该Tensor的常见shape为 $(N,C_{in},D_{in},H_{in},W_{in})$ ，其中 $N$ 为batch size，$C_{in}$ 为通道数，$D$ 为深度， $H_{in},W_{in}$ 分别为特征层的高度和宽度。 $X_i$ 为 $i^{th}$ 输入值， $b_i$ 为 $i^{th}$ 输入值的偏置项。对于每个batch中的Tensor，其shape为 $(C_{in},D_{in},H_{in},W_{in})$ ，公式定义如下：

$$\mathrm{out}(N_i,C_{{\text{out}}_j})=\mathrm{bias}\left(C_{{\text{out}}_j}\right)+\sum _{k=0}^{C_{in}-1}ccor(\text{weight}(C_{{\text{out}}_j},k),\mathrm{input}(N_i,k))$$

其中，$k$ 为卷积核数，$ccor$ 为 cross-correlation ， $C_{in}$ 为输入通道数， $j$ 的范围从 $0$ 到 $C_{out}-1$ ， $W_{ij}$ 对应第 $j$ 个过滤器的第 $i$ 个通道， $ou{t}_j$ 对应输出的第 $j$ 个通道。 $W_{ij}$ 为卷积核的切片，其shape为 $(\text{kernel\_size[0]},\text{kernel\_size[1]},\text{kernel\_size[2]})$ ，其中 $\text{kernel\_size[1]}$ 和 $\text{kernel\_size[2]}$ 是卷积核的高度和宽度， $\text{kernel\_size[0]}$ 是卷积核的深度。完整卷积核的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 。

说明

在Ascend平台上，目前只支持深度卷积场景下的分组卷积运算。也就是说，当 group>1 的场景下，必须要满足 C_{in} = C_{out} = group 的约束条件。

参数：

• inputs (Tensor) - shape为 $(N,C_{in},D_{in},H_{in},W_{in})$ 的Tensor。

• weight (Tensor) - 设置卷积核的大小为 $(\text{kernel\_size[0]},\text{kernel\_size[1]},\text{kernel\_size[2]})$ ，则shape为 $(C_{out},C_{in},\text{kernel\_size[0]},\text{kernel\_size[1]},\text{kernel\_size[2]})$ 。

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

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

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

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

• padding (Union[int, tuple[int]]，可选) - 输入 inputs 的深度、高度和宽度方向上填充的数量。数据类型为int或包含6个int组成的tuple。如果 padding 是一个int，那么前、后、上、下、左、右的填充都等于 padding 。如果 padding 是一个有6个int组成的tuple，那么前、后、上、下、左、右的填充分别等于 padding[0] 、 padding[1] 、 padding[2] 、 padding[3] 、padding[4] 和 padding[5] 。值必须大于等于0，默认值：0。

• stride (Union[int, tuple[int]]，可选) - 卷积核移动的步长，数据类型为int或两个int组成的tuple。一个int表示在高度和宽度方向的移动步长均为该值。两个int组成的tuple分别表示在高度和宽度方向的移动步长。默认值：1。

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

• group (int，可选) - 将筛选器拆分为组，默认值：1。当前仅支持值为1。

返回：

Tensor，卷积后的值。shape为 $(N,C_{out},D_{out},H_{out},W_{out})$ 。

pad_mode 为”same”时：

$$\begin{array}{r}\begin{array}{l}\\ D_{out}＝\lceil \frac{D_{in}}{\text{stride[0]}}\rceil \\ H_{out}＝\lceil \frac{H_{in}}{\text{stride[1]}}\rceil \\ W_{out}＝\lceil \frac{W_{in}}{\text{stride[2]}}\rceil \end{array}\end{array}$$

pad_mode 为”valid”时：

$$\begin{array}{r}\begin{array}{l}\\ D_{out}＝\lfloor \frac{D_{in}-\text{dilation[0]}\times (\text{kernel\_size[0]}-1)}{\text{stride[0]}}+1\rfloor \\ H_{out}＝\lfloor \frac{H_{in}-\text{dilation[1]}\times (\text{kernel\_size[1]}-1)}{\text{stride[1]}}+1\rfloor \\ W_{out}＝\lfloor \frac{W_{in}-\text{dilation[2]}\times (\text{kernel\_size[2]}-1)}{\text{stride[2]}}+1\rfloor \end{array}\end{array}$$

pad_mode 为”pad”时：

$$\begin{array}{r}\begin{array}{l}\\ D_{out}＝\lfloor \frac{D_{in}+padding[0]+padding[1]-(\text{dilation[0]}-1)\times \text{kernel\_size[0]}-1}{\text{stride[0]}}+1\rfloor \\ H_{out}＝\lfloor \frac{H_{in}+padding[2]+padding[3]-(\text{dilation[1]}-1)\times \text{kernel\_size[1]}-1}{\text{stride[1]}}+1\rfloor \\ W_{out}＝\lfloor \frac{W_{in}+padding[4]+padding[5]-(\text{dilation[2]}-1)\times \text{kernel\_size[2]}-1}{\text{stride[2]}}+1\rfloor \end{array}\end{array}$$

异常：

• TypeError - stride 、 padding 或 dilation 既不是int也不是tuple。

• TypeError - out_channel 或 group 不是int。

• ValueError - stride 或 diation 小于1。

• ValueError - pad_mode 不是”same”、”valid”或”pad”。

• ValueError - padding 是一个长度不等于6的tuple。

• ValueError - pad_mode 不等于”pad”，padding 不等于(0, 0, 0, 0, 0, 0)。

支持平台：

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)
>>> output = ops.conv3d(x, weight)
>>> print(output.shape)
(16, 32, 7, 30, 30)