Document feedback

Question document fragment

When a question document fragment contains a formula, it is displayed as a space.

Submission type

issue

It's a little complicated...

I'd like to ask someone.

Please select the submission type

Problem type

Specifications and Common Mistakes

- Specifications and Common Mistakes:

- Misspellings or punctuation mistakes,incorrect formulas, abnormal display.

- Incorrect links, empty cells, or wrong formats.

- Chinese characters in English context.

- Minor inconsistencies between the UI and descriptions.

- Low writing fluency that does not affect understanding.

- Incorrect version numbers, including software package names and version numbers on the UI.

Usability

- Usability:

- Incorrect or missing key steps.

- Missing main function descriptions, keyword explanation, necessary prerequisites, or precautions.

- Ambiguous descriptions, unclear reference, or contradictory context.

- Unclear logic, such as missing classifications, items, and steps.

Correctness

- Correctness:

- Technical principles, function descriptions, supported platforms, parameter types, or exceptions inconsistent with that of software implementation.

- Incorrect schematic or architecture diagrams.

- Incorrect commands or command parameters.

- Incorrect code.

- Commands inconsistent with the functions.

- Wrong screenshots.

- Sample code running error, or running results inconsistent with the expectation.

Risk Warnings

- Risk Warnings:

- Lack of risk warnings for operations that may damage the system or important data.

Content Compliance

- Content Compliance:

- Contents that may violate applicable laws and regulations or geo-cultural context-sensitive words and expressions.

- Copyright infringement.

Please select the type of question

Problem description

Describe the bug so that we can quickly locate the problem.

Submit

Document feedback

mindspore.ops.conv2d

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

2D convolution layer.

Applies a 2D convolution over an input tensor which is typically of shape $(N,C_{in},H_{in},W_{in})$, where $N$ is batch size, $C$ is channel number, $H$ is height, $W$ is width, $X_i$ is the $i^{th}$ input value and $b_i$ indicates the deviation value of the $i^{th}$ input value. For each batch of shape $(C_{in},H_{in},W_{in})$, the formula is defined as:

$$ou{t}_j=\sum _{i=0}^{C_{in}-1}ccor(W_{ij},X_i)+b_j,$$

where $ccor$ is the cross correlation operator, $C_{in}$ is the input channel number, $j$ ranges from $0$ to $C_{out}-1$, $W_{ij}$ corresponds to the $i$-th channel of the $j$-th filter and $ou{t}_j$ corresponds to the $j$-th channel of the output. $W_{ij}$ is a slice of kernel and it has shape $(\text{kernel\_size[0]},\text{kernel\_size[1]})$,where $\text{ kernel\_size[0]}$ and $\text{kernel\_size[1]}$ are the height and width of the convolution kernel. The full kernel has shape $(C_{out},C_{in}/\text{group},\text{kernel\_size[0]},\text{kernel\_size[1]})$, where group is the group number to split the input in the channel dimension.

If the ‘pad_mode’ is set to be “valid”, the output height and width will be $\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] }}\rfloor$ and

$\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] }}\rfloor$ respectively.

Where $dilation$ is Spacing between kernel elements, $stride$ is The step length of each step, $padding$ is zero-padding added to both sides of the input.

The first introduction can be found in paper Gradient Based Learning Applied to Document Recognition. More detailed introduction can be found here: http://cs231n.github.io/convolutional-networks/.

Parameters

• inputs (Tensor) – Tensor of shape $(N,C_{in},H_{in},W_{in})$.

• weight (Tensor) – Set size of kernel is $(\text{kernel\_size[0]},\text{kernel\_size[1]})$, then the shape is $(C_{out},C_{in},\text{kernel\_size[0]},\text{kernel\_size[1]})$.

• pad_mode (str) –

  Specifies padding mode. The optional values are “same”, “valid” and “pad”. Default: “valid”.

  • same: Adopts the way of completion. The height and width of the output will be equal to the input x divided by stride. The padding will be evenly calculated in top and bottom, left and right possibility. Otherwise, the last extra padding will be calculated from the bottom and the right side. If this mode is set, padding must be 0.

  • valid: Adopts the way of discarding. The possible largest height and width of output will be returned without padding. Extra pixels will be discarded. If this mode is set, padding must be 0.

  • pad: Implicit paddings on both sides of the input x. The number of padding will be padded to the input Tensor borders. padding must be greater than or equal to 0.

• padding (Union(int, tuple[int])) – Implicit paddings on both sides of the input x. If padding is one integer, the paddings of top, bottom, left and right are the same, equal to padding. If padding is a tuple with four integers, the paddings of top, bottom, left and right will be equal to padding[0], padding[1], padding[2], and padding[3] accordingly. Default: 0.

• stride (Union(int, tuple[int])) – The distance of kernel moving, an int number that represents the height and width of movement are both strides, or a tuple of two int numbers that represent height and width of movement respectively. Default: 1.

• dilation (Union(int, tuple[int])) – The data type is int or a tuple of 2 integers. Specifies the dilation rate to use for dilated convolution. If set to be $k>1$, there will be $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 inputs into groups. Default: 1.

Returns

Tensor, the value that applied 2D convolution. The shape is $(N,C_{out},H_{out},W_{out})$.

Raises

• 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 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).

Supported Platforms:

Ascend GPU CPU

Examples

>>> x = Tensor(np.ones([10, 32, 32, 32]), mindspore.float32)
>>> weight = Tensor(np.ones([32, 32, 3, 3]), mindspore.float32)
>>> output = ops.conv2d(x, weight)
>>> print(output.shape)
(10, 32, 30, 30)