Conv3D

class paddle.nn. Conv3D ( in_channels, out_channels, kernel_size, stride=1, padding=0, dilation=1, groups=1, padding_mode='zeros', weight_attr=None, bias_attr=None, data_format='NCDHW' ) [source]

Convlution3d Layer The convolution3d layer calculates the output based on the input, filter and strides, paddings, dilations, groups parameters. Input(Input) and Output(Output) are multidimensional tensors with a shape of \([N, C, D, H, W]\) . Where N is batch size, C is the number of channels, D is the depth of the feature, H is the height of the feature, and W is the width of the feature. Convlution3D is similar with Convlution2D but adds one dimension(depth). If bias attribution and activation type are provided, bias is added to the output of the convolution, and the corresponding activation function is applied to the final result. For each input \(X\), the equation is:

\[\begin{split}Out = \sigma (W \\ast X + b)\end{split}\]

In the above equation:

  • \(X\): Input value, a tensor with NCDHW or NDHWC format.

  • \(W\): Filter value, a tensor with MCDHW format.

  • \(\\ast\): Convolution operation.

  • \(b\): Bias value, a 2-D tensor with shape [M, 1].

  • \(\\sigma\): Activation function.

  • \(Out\): Output value, the shape of \(Out\) and \(X\) may be different.

Parameters
  • in_channels (int) – The number of input channels in the input image.

  • out_channels (int) – The number of output channels produced by the convolution.

  • kernel_size (int|list|tuple, optional) – The size of the convolving kernel.

  • stride (int|list|tuple, optional) – The stride size. If stride is a tuple, it must contain three integers, (stride_D, stride_H, stride_W). Otherwise, the stride_D = stride_H = stride_W = stride. The default value is 1.

  • padding (int|str|tuple|list, optional) – The padding size. Padding coule be in one of the following forms. 1. a string in [‘valid’, ‘same’]. 2. an int, which means each spartial dimension(depth, height, width) is zero paded by size of padding 3. a list[int] or tuple[int] whose length is the number of spartial dimensions, which contains the amount of padding on each side for each spartial dimension. It has the form [pad_d1, pad_d2, …]. 4. a list[int] or tuple[int] whose length is 2 * number of spartial dimensions. It has the form [pad_before, pad_after, pad_before, pad_after, …] for all spartial dimensions. 5. a list or tuple of pairs of ints. It has the form [[pad_before, pad_after], [pad_before, pad_after], …]. Note that, the batch dimension and channel dimension are also included. Each pair of integers correspond to the amount of padding for a dimension of the input. Padding in batch dimension and channel dimension should be [0, 0] or (0, 0). The default value is 0.

  • dilation (int|list|tuple, optional) – The dilation size. If dilation is a tuple, it must contain three integers, (dilation_D, dilation_H, dilation_W). Otherwise, the dilation_D = dilation_H = dilation_W = dilation. The default value is 1.

  • groups (int, optional) – The groups number of the Conv3D Layer. According to grouped convolution in Alex Krizhevsky’s Deep CNN paper: when group=2, the first half of the filters is only connected to the first half of the input channels, while the second half of the filters is only connected to the second half of the input channels. The default value is 1.

  • padding_mode (str, optional) – 'zeros', 'reflect', 'replicate' or 'circular'. Default: 'zeros'.

  • weight_attr (ParamAttr, optional) – The parameter attribute for learnable parameters/weights of conv3d. If it is set to None or one attribute of ParamAttr, conv3d will create ParamAttr as param_attr. If it is set to None, the parameter is initialized with \(Normal(0.0, std)\), and the \(std\) is \((\\frac{2.0 }{filter\_elem\_num})^{0.5}\). The default value is None.

  • bias_attr (ParamAttr|bool, optional) – The parameter attribute for the bias of conv3d. If it is set to False, no bias will be added to the output units. If it is set to None or one attribute of ParamAttr, conv3d will create ParamAttr as bias_attr. If the Initializer of the bias_attr is not set, the bias is initialized zero. The default value is None.

  • data_format (str, optional) – Data format that specifies the layout of input. It can be “NCDHW” or “NDHWC”. Default: “NCDHW”.

Attribute:

weight (Parameter): the learnable weights of filters of this layer.

bias (Parameter): the learnable bias of this layer.

Shape:

  • x: \((N, C_{in}, D_{in}, H_{in}, W_{in})\)

  • output: \((N, C_{out}, D_{out}, H_{out}, W_{out})\)

Where

\[ \begin{align}\begin{aligned}\begin{split}D_{out}&= \\frac{(D_{in} + 2 * paddings[0] - (dilations[0] * (kernel\_size[0] - 1) + 1))}{strides[0]} + 1\end{split}\\\begin{split}H_{out}&= \\frac{(H_{in} + 2 * paddings[1] - (dilations[1] * (kernel\_size[1] - 1) + 1))}{strides[1]} + 1\end{split}\\\begin{split}W_{out}&= \\frac{(W_{in} + 2 * paddings[2] - (dilations[2] * (kernel\_size[2] - 1) + 1))}{strides[2]} + 1\end{split}\end{aligned}\end{align} \]
Raises

ValueError – If the shapes of input, filter_size, stride, padding and groups mismatch.

Examples

import paddle
import paddle.nn as nn

paddle.disable_static()

x_var = paddle.uniform((2, 4, 8, 8, 8), dtype='float32', min=-1., max=1.)

conv = nn.Conv3D(4, 6, (3, 3, 3))
y_var = conv(x_var)
y_np = y_var.numpy()
print(y_np.shape)
# (2, 6, 6, 6, 6)
forward ( x )

Defines the computation performed at every call. Should be overridden by all subclasses.

Parameters
  • *inputs (tuple) – unpacked tuple arguments

  • **kwargs (dict) – unpacked dict arguments