mindspore.nn.Conv2d

class mindspore.nn.Conv2d(in_channels, out_channels, kernel_size, stride=1, pad_mode='same', padding=0, dilation=1, group=1, has_bias=False, weight_init='normal', bias_init='zeros', data_format='NCHW')

二维卷积层。

对输入Tensor计算二维卷积，该Tensor的常见shape为 $(N,C_{in},H_{in},W_{in})$，其中 $N$ 为batch size，$C_{in}$ 为空间维度，$H_{in},W_{in}$ 分别为特征层的高度和宽度。对于每个batch中的Tensor，其shape为 $(C_{in},H_{in},W_{in})$ ，公式定义如下：

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

其中，$ccor$ 为 cross-correlation ， $C_{in}$ 为输入空间维度， $ou{t}_j$ 对应输出的第 $j$ 个空间维度，$j$ 的范围在 $[0，C_{out}-1]$ 内， $\text{weight}(C_{{\text{out}}_j},k)$ 的卷积核切片，其中 $\text{kernel\_size[0]}$ 和 $\text{kernel\_size[1]}$ 分别是卷积核的高度和宽度。 $\text{bias}$ 为偏置参数， $\text{X}$ 为输入Tensor。 完整卷积核的shape为 $(C_{out},C_{in}/\text{group},\text{kernel\_size[0]},\text{kernel\_size[1]})$ ，其中 group 是在空间维度上分割输入 x 的组数。 详细介绍请参考论文 Gradient Based Learning Applied to Document Recognition 。

参数：

• in_channels (int) – Conv2d层输入Tensor的空间维度。

• out_channels (dict) - Conv2d层输出Tensor的空间维度。

• kernel_size (Union[int, tuple[int]]) – 指定二维卷积核的高度和宽度。数据类型为整型或两个整型的tuple。一个整数表示卷积核的高度和宽度均为该值。两个整数的tuple分别表示卷积核的高度和宽度。

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

• pad_mode (str) – 指定填充模式。可选值为”same”、”valid”、”pad”。默认值：”same”。

  • same：输出的高度和宽度分别与输入整除 stride 后的值相同。若设置该模式，padding 的值必须为0。

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

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

• padding (Union[int, tuple[int]]) – 输入的高度和宽度方向上填充的数量。数据类型为int或包含4个整数的tuple。如果 padding 是一个整数，那么上、下、左、右的填充都等于 padding 。如果 padding 是一个有4个整数的tuple，那么上、下、左、右的填充分别等于 padding[0] 、 padding[1] 、 padding[2] 和 padding[3] 。值应该要大于等于0，默认值：0。

• dilation (Union[int, tuple[int]]) – 二维卷积核膨胀尺寸。数据类型为整型或具有两个整型的tuple。若 $k>1$ ，则kernel间隔 k 个元素进行采样。垂直和水平方向上的 k ，其取值范围分别为[1, H]和[1, W]。默认值：1。

• group (int) – 将过滤器拆分为组， in_channels 和 out_channels 必须可被 group 整除。如果组数等于 in_channels 和 out_channels ，这个二维卷积层也被称为二维深度卷积层。默认值：1.

• has_bias (bool) – Conv2d层是否添加偏置参数。默认值：False。

• weight_init (Union[Tensor, str, Initializer, numbers.Number]) - 权重参数的初始化方法。它可以是Tensor，str，Initializer或numbers.Number。当使用str时，可选”TruncatedNormal”，”Normal”，”Uniform”，”HeUniform”和”XavierUniform”分布以及常量”One”和”Zero”分布的值，可接受别名”xavier_uniform”，”he_uniform”，”ones”和”zeros”。上述字符串大小写均可。更多细节请参考Initializer的值。默认值：”normal”。

• bias_init (Union[Tensor, str, Initializer, numbers.Number]) - 偏置参数的初始化方法。可以使用的初始化方法与”weight_init”相同。更多细节请参考Initializer的值。默认值：”zeros”。

• data_format (str) – 数据格式的可选值有”NHWC”，”NCHW”。默认值：”NCHW”。

输入：

x (Tensor) - Shape为 $(N,C_{in},H_{in},W_{in})$ 或者 $(N,H_{in},W_{in},C_{in})$ 的Tensor。

输出：

Tensor，shape为 $(N,C_{out},H_{out},W_{out})$ 或者 $(N,H_{out},W_{out},C_{out})$ 。

pad_mode为”same”时：

$$\begin{array}{r}\begin{array}{l}\\ H_{out}＝\lfloor \frac{H_{in}}{\text{stride[0]}}+1\rfloor \\ W_{out}＝\lfloor \frac{W_{in}}{\text{stride[1]}}+1\rfloor \end{array}\end{array}$$

pad_mode为”valid”时：

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

pad_mode为”pad”时：

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

异常：

• TypeError - 如果 in_channels ， out_channels 或者 group 不是整数。

• TypeError - 如果 kernel_size ， stride，padding 或者 dilation 既不是整数也不是tuple。

• ValueError - 如果 in_channels ， out_channels，kernel_size ， stride 或者 dilation 小于1。

• ValueError - 如果 padding 小于0。

• ValueError - 如果 pad_mode 不是”same”，”valid”或”pad”。

• ValueError - 如果 padding 是一个长度不等于4的tuple。

• ValueError - 如果 pad_mode 不等于”pad”且 padding 不等于(0,0,0,0)。

• ValueError - 如果 data_format 既不是”NCHW”也不是”NHWC”。

支持平台：

Ascend GPU CPU

样例：

>>> net = nn.Conv2d(120, 240, 4, has_bias=False, weight_init='normal')
>>> x = Tensor(np.ones([1, 120, 1024, 640]), mindspore.float32)
>>> output = net(x).shape
>>> print(output)
(1, 240, 1024, 640)