From a483f4857f860abaa8a44313e2835201d9e1e13b Mon Sep 17 00:00:00 2001 From: xuqiang Date: Thu, 25 Aug 2022 11:53:25 +0800 Subject: [PATCH] Modify the input parameter of function conv2d --- .../api_python/ops/mindspore.ops.Conv2D.rst | 44 +------------------ .../ops/mindspore.ops.func_conv2d.rst | 22 +++++----- .../python/mindspore/ops/function/nn_func.py | 21 ++++----- 3 files changed, 20 insertions(+), 67 deletions(-) diff --git a/docs/api/api_python/ops/mindspore.ops.Conv2D.rst b/docs/api/api_python/ops/mindspore.ops.Conv2D.rst index 64dacdeb363..f653fa0ed88 100644 --- a/docs/api/api_python/ops/mindspore.ops.Conv2D.rst +++ b/docs/api/api_python/ops/mindspore.ops.Conv2D.rst @@ -5,46 +5,4 @@ mindspore.ops.Conv2D 二维卷积层。 - 对输入Tensor计算二维卷积，该Tensor的常见shape为 :math:`(N, C_{in}, H_{in}, W_{in})` ，其中 :math:`N` 为batch size，:math:`C_{in}` 为通道数， :math:`H_{in}, W_{in}` 分别为特征层的高度和宽度。 :math:`X_i` 为 :math:`i^{th}` 输入值， :math:`b_i` 为 :math:`i^{th}` 输入值的偏置项。对于每个batch中的Tensor，其shape为 :math:`(C_{in}, H_{in}, W_{in})` ，公式定义如下： - - .. math:: - out_j = \sum_{i=0}^{C_{in} - 1} ccor(W_{ij}, X_i) + b_j, - - 其中， :math:`ccor` 为 `cross-correlation `_ ， :math:`C_{in}` 为输入通道数， :math:`j` 的范围从 :math:`0` 到 :math:`C_{out} - 1` ， :math:`W_{ij}` 对应第 :math:`j` 个过滤器的第 :math:`i` 个通道， :math:`out_{j}` 对应输出的第 :math:`j` 个通道。 :math:`W_{ij}` 为卷积核的切片，其shape为 :math:`(\text{kernel_size[0]},\text{kernel_size[1]})` ，其中 :math:`\text{kernel_size[0]}` 和 :math:`\text{kernel_size[1]}` 是卷积核的高度和宽度。完整卷积核的shape为 :math:`(C_{out}, C_{in} / \text{group}, \text{kernel_size[0]}, \text{kernel_size[1]})` ，其中 `group` 是在通道上分割输入 `x` 的组数。 - - 如果 `pad_mode` 设置为"pad"，则输出高度和宽度将分别为 :math:`\left \lfloor{1 + \frac{H_{in} + \text{padding[0]} + \text{padding[1]} - \text{kernel_size[0]} - (\text{kernel_size[0]} - 1) \times (\text{dilation[0]} - 1) }{\text{stride[0]}}} \right \rfloor` 和 :math:`\left \lfloor{1 + \frac{W_{in} + \text{padding[2]} + \text{padding[3]} - \text{kernel_size[1]} - (\text{kernel_size[1]} - 1) \times (\text{dilation[1]} - 1) }{\text{stride[1]}}} \right \rfloor` 。 - 其中， :math:`dialtion` 为卷积核元素之间的间距， :math:`stride` 为移动步长， :math:`padding` 为添加到输入两侧的零填充。 - - 请参考论文 `Gradient Based Learning Applied to Document Recognition `_ 。更详细的介绍，参见：http://cs231n.github.io/convolutional-networks/。 - - 参数： - - **out_channel** (int) - :math:`C_{out}` 为输出通道数。 - - **kernel_size** (Union[int, tuple[int]]) - 数据类型为int或一个包含2个int组成的元组。指定二维卷积核的高度和宽度。单个整数表示该值同时适用于内核的高度和宽度。包含2个整数的元组表示第一个值用于高度，另一个值用于内核的宽度。 - - **mode** (int) - 指定不同的卷积模式。此值目前未被使用。默认值：1。 - - **pad_mode** (str) - 指定填充模式。取值为"same"，"valid"，或"pad"。默认值："valid"。 - - - **same**: 输出的高度和宽度分别与输入整除 `stride` 后的值相同。填充将被均匀地添加到高和宽的两侧，剩余填充量将被添加到维度末端。若设置该模式，`pad` 的值必须为0。 - - **valid**: 在不填充的前提下返回有效计算所得的输出。不满足计算的多余像素会被丢弃。如果设置此模式，则 `pad` 的值必须为0。 - - **pad**: 对输入 `x` 进行填充。在输入的高度和宽度方向上填充 `pad` 大小的0。如果设置此模式， `pad` 必须大于或等于0。 - - - **pad** (Union(int, tuple[int])) - 输入 `x` 的高度和宽度方向上填充的数量。数据类型为int或包含4个int组成的tuple。如果 `pad` 是一个int，那么上、下、左、右的填充都等于 `pad` 。如果 `pad` 是一个有4个int组成的tuple，那么上、下、左、右的填充分别等于 `pad[0]` 、 `pad[1]` 、 `pad[2]` 和 `pad[3]` 。值应该要大于等于0，默认值：0。 - - **stride** (Union(int, tuple[int])) - 卷积核移动的步长，数据类型为int或两个int组成的tuple。一个int表示在高度和宽度方向的移动步长均为该值。两个int组成的tuple分别表示在高度和宽度方向的移动步长。默认值：1。 - - **dilation** (Union(int, tuple[int])) - 卷积核膨胀尺寸。数据类型为int或由2个int组成的tuple。若 :math:`k > 1` ，则卷积核间隔 `k` 个元素进行采样。垂直和水平方向上的 `k` ，其取值范围分别为[1, H]和[1, W]。默认值：1。 - - **group** (int) - 将过滤器拆分为组。默认值：1。 - - **data_format** (str) - 数据格式的可选值有"NHWC"，"NCHW"。默认值："NCHW"。 - - 输入： - - **x** (Tensor) - shape为 :math:`(N, C_{in}, H_{in}, W_{in})` 的Tensor。 - - **weight** (Tensor) - 设置卷积核的大小为 :math:`(\text{kernel_size[0]}, \text{kernel_size[1]})` ，则shape为 :math:`(C_{out}, C_{in}, \text{kernel_size[0]}, \text{kernel_size[1]})` 。 - - 输出： - Tensor，卷积后的值。shape为 :math:`(N, C_{out}, H_{out}, W_{out})` 。 - - 异常： - - **TypeError** - `kernel_size` 、 `stride` 、 `pad` 或 `dilation` 既不是int也不是tuple。 - - **TypeError** - `out_channel` 或 `group` 不是int。 - - **ValueError** - `kernel_size` 、 `stride` 或 `diation` 小于1。 - - **ValueError** - `pad_mode` 不是"same"、"valid"或"pad"。 - - **ValueError** - `pad` 是一个长度不等于4的tuple。 - - **ValueError** - `pad_mode` 不等于"pad"，`pad` 不等于(0, 0, 0, 0)。 - - **ValueError** - `data_format` 既不是"NCHW"，也不是"NHWC"。 + 更多参考详见 :func:`mindspore.ops.conv2d`。 \ No newline at end of file diff --git a/docs/api/api_python/ops/mindspore.ops.func_conv2d.rst b/docs/api/api_python/ops/mindspore.ops.func_conv2d.rst index 6d6ba51034e..3fa81d62d44 100644 --- a/docs/api/api_python/ops/mindspore.ops.func_conv2d.rst +++ b/docs/api/api_python/ops/mindspore.ops.func_conv2d.rst @@ -1,7 +1,7 @@ mindspore.ops.conv2d ==================== -.. py:function:: mindspore.ops.conv2d(x, weight, kernel_size, mode=1, pad_mode="valid", pad_val=0, stride=1, dilation=1, group=1, date_format="NCHW") +.. py:function:: mindspore.ops.conv2d(inputs, weight, mode=1, pad_mode="valid", padding=0, stride=1, dilation=1, group=1) 二维卷积层。 @@ -18,29 +18,27 @@ mindspore.ops.conv2d 请参考论文 `Gradient Based Learning Applied to Document Recognition `_ 。更详细的介绍，参见：http://cs231n.github.io/convolutional-networks/。 参数： - - **x** (Tensor) - shape为 :math:`(N, C_{in}, H_{in}, W_{in})` 的Tensor. + - **inputs** (Tensor) - shape为 :math:`(N, C_{in}, H_{in}, W_{in})` 的Tensor。 - **weight** (Tensor) - 设置卷积核的大小为 :math:`(\text{kernel_size[0]}, \text{kernel_size[1]})` ，则shape为 :math:`(C_{out}, C_{in}, \text{kernel_size[0]}, \text{kernel_size[1]})` 。 - - **kernel_size** (Union[int, tuple[int]]) - 数据类型为int或一个包含2个int组成的元组。指定二维卷积核的高度和宽度。单个整数表示该值同时适用于内核的高度和宽度。包含2个整数的元组表示第一个值用于高度，另一个值用于内核的宽度。 - **mode** (int) - 指定不同的卷积模式。此值目前未被使用。默认值：1。 - **pad_mode** (str) - 指定填充模式。取值为"same"，"valid"，或"pad"。默认值："valid"。 - - **same**: 输出的高度和宽度分别与输入整除 `stride` 后的值相同。填充将被均匀地添加到高和宽的两侧，剩余填充量将被添加到维度末端。若设置该模式，`pad_val` 的值必须为0。 - - **valid**: 在不填充的前提下返回有效计算所得的输出。不满足计算的多余像素会被丢弃。如果设置此模式，则 `pad_val` 的值必须为0。 - - **pad**: 对输入 `x` 进行填充。在输入的高度和宽度方向上填充 `pad_val` 大小的0。如果设置此模式， `pad_val` 必须大于或等于0。 + - **same**: 输出的高度和宽度分别与输入整除 `stride` 后的值相同。填充将被均匀地添加到高和宽的两侧，剩余填充量将被添加到维度末端。若设置该模式，`padding` 的值必须为0。 + - **valid**: 在不填充的前提下返回有效计算所得的输出。不满足计算的多余像素会被丢弃。如果设置此模式，则 `padding` 的值必须为0。 + - **pad**: 对输入 `x` 进行填充。在输入的高度和宽度方向上填充 `padding` 大小的0。如果设置此模式， `padding` 必须大于或等于0。 - - **pad_val** (Union(int, tuple[int])) - 输入 `x` 的高度和宽度方向上填充的数量。数据类型为int或包含4个int组成的tuple。如果 `pad_val` 是一个int，那么上、下、左、右的填充都等于 `pad_val` 。如果 `pad_val` 是一个有4个int组成的tuple，那么上、下、左、右的填充分别等于 `pad_val[0]` 、 `pad_val[1]` 、 `pad_val[2]` 和 `pad_val[3]` 。值应该要大于等于0，默认值：0。 + - **padding** (Union(int, tuple[int])) - 输入 `x` 的高度和宽度方向上填充的数量。数据类型为int或包含4个int组成的tuple。如果 `padding` 是一个int，那么上、下、左、右的填充都等于 `padding` 。如果 `padding` 是一个有4个int组成的tuple，那么上、下、左、右的填充分别等于 `padding[0]` 、 `padding[1]` 、 `padding[2]` 和 `padding[3]` 。值必须大于等于0，默认值：0。 - **stride** (Union(int, tuple[int])) - 卷积核移动的步长，数据类型为int或两个int组成的tuple。一个int表示在高度和宽度方向的移动步长均为该值。两个int组成的tuple分别表示在高度和宽度方向的移动步长。默认值：1。 - **dilation** (Union(int, tuple[int])) - 卷积核膨胀尺寸。数据类型为int或由2个int组成的tuple。若 :math:`k > 1` ，则卷积核间隔 `k` 个元素进行采样。垂直和水平方向上的 `k` ，其取值范围分别为[1, H]和[1, W]。默认值：1。 - **group** (int) - 将过滤器拆分为组。默认值：1。 - - **data_format** (str) - 数据格式的可选值有"NHWC"，"NCHW"。默认值："NCHW"。 返回： Tensor，卷积后的值。shape为 :math:`(N, C_{out}, H_{out}, W_{out})` 。 异常： - - **TypeError** - `kernel_size` 、 `stride` 、 `pad_val` 或 `dilation` 既不是int也不是tuple。 - - **TypeError** - `out_channel` 或 `group` 不是int。 - - **ValueError** - `kernel_size` 、 `stride` 或 `diation` 小于1。 + - **TypeError** - `stride` 、 `padding` 或 `dilation` 既不是int也不是tuple。 + - **TypeError** - `out_channel` 或 `group` 不是int。 + - **ValueError** - `stride` 或 `diation` 小于1。 - **ValueError** - `pad_mode` 不是"same"、"valid"或"pad"。 - **ValueError** - `padding` 是一个长度不等于4的tuple。 - - **ValueError** - `pad_mode` 不等于"pad"，`pad_val` 不等于(0, 0, 0, 0)。 + - **ValueError** - `pad_mode` 不等于"pad"，`padding` 不等于(0, 0, 0, 0)。 diff --git a/mindspore/python/mindspore/ops/function/nn_func.py b/mindspore/python/mindspore/ops/function/nn_func.py index a829cb5908a..dc4679a13a4 100644 --- a/mindspore/python/mindspore/ops/function/nn_func.py +++ b/mindspore/python/mindspore/ops/function/nn_func.py @@ -2299,7 +2299,7 @@ def conv3d_transpose(inputs, weight, pad_mode='valid', padding=0, stride=1, dila return _conv_3d_transpose(inputs, weight) -def conv2d(x, weight, kernel_size, pad_mode="valid", padding=0, stride=1, dilation=1, group=1): +def conv2d(inputs, weight, pad_mode="valid", padding=0, stride=1, dilation=1, group=1): r""" 2D convolution layer. @@ -2337,13 +2337,9 @@ def conv2d(x, weight, kernel_size, pad_mode="valid", padding=0, stride=1, dilati http://cs231n.github.io/convolutional-networks/. Args: - x (Tensor): Tensor of shape :math:`(N, C_{in}, H_{in}, W_{in})`. + inputs (Tensor): Tensor of shape :math:`(N, C_{in}, H_{in}, W_{in})`. weight (Tensor): Set size of kernel is :math:`(\text{kernel_size[0]}, \text{kernel_size[1]})`, then the shape is :math:`(C_{out}, C_{in}, \text{kernel_size[0]}, \text{kernel_size[1]})`. - kernel_size (Union[int, tuple[int]]): The data type is int or a tuple of 2 integers. Specifies the height - and width of the 2D convolution window. Single int means the value is for both the height and the width of - the kernel. A tuple of 2 ints means the first value is for the height and the other is for the - width of the kernel. pad_mode (str): Specifies padding mode. The optional values are "same", "valid" and "pad". Default: "valid". @@ -2370,15 +2366,15 @@ def conv2d(x, weight, kernel_size, pad_mode="valid", padding=0, stride=1, dilati be :math:`k - 1` pixels skipped for each sampling location. Its value must be greater than or equal to 1 and bounded by the height and width of the input `x`. Default: 1. - group (int): Splits input into groups. Default: 1. + group (int): Splits inputs into groups. Default: 1. Returns: Tensor, the value that applied 2D convolution. The shape is :math:`(N, C_{out}, H_{out}, W_{out})`. Raises: - TypeError: If `kernel_size`, `stride`, `padding` or `dilation` is neither an int nor a tuple. + TypeError: If `stride`, `padding` or `dilation` is neither an int nor a tuple. TypeError: If `out_channel` or `group` is not an int. - ValueError: If `kernel_size`, `stride` or `dilation` is less than 1. + ValueError: If `stride` or `dilation` is less than 1. ValueError: If `pad_mode` is not one of 'same', 'valid' or 'pad'. ValueError: If `padding` is a tuple whose length is not equal to 4. ValueError: If `pad_mode` it not equal to 'pad' and `padding` is not equal to (0, 0, 0, 0). @@ -2389,14 +2385,15 @@ def conv2d(x, weight, kernel_size, pad_mode="valid", padding=0, stride=1, dilati Examples: >>> x = Tensor(np.ones([10, 32, 32, 32]), mindspore.float32) >>> weight = Tensor(np.ones([32, 32, 3, 3]), mindspore.float32) - >>> output = F.Conv2D(x, weight, kernel_size=3, out_channel=32, stride=1) + >>> output = ops.conv2d(x, weight) >>> print(output.shape) (10, 32, 30, 30) """ weight_shape = weight.shape out_channel = weight_shape[0] - conv = _get_cache_prim(P.Conv2D)(out_channel, kernel_size, 1, pad_mode, padding, stride, 1, dilation, group, "NCHW") - output = conv(x, weight) + kernel_size = weight_shape[2:4] + conv = _get_cache_prim(P.Conv2D)(out_channel, kernel_size, 1, pad_mode, padding, stride, dilation, group, "NCHW") + output = conv(inputs, weight) return output