mindspore/docs/api/api_python/ops/mindspore.ops.Conv3DTranspose.rst

mindspore.ops.Conv3DTranspose
=============================

.. py:class:: mindspore.ops.Conv3DTranspose(in_channel, out_channel, kernel_size, mode=1, stride=1, pad_mode='valid', pad=0, dilation=1, group=1, output_padding=0, data_format='NCDHW')

    计算三维转置卷积，也称为反卷积（实际不是真正的反卷积）。

    输入的shape通常为 :math:`(N, C, D, H, W)`, 其中 :math:`N` 为batch size，:math:`C` 是空间维度，:math:`D` 、 :math:`H` 和 :math:`W` 分别为特征层的深度、高度和宽度。

    若 `pad_mode` 被设定为 "pad"，则输出的深度，高度和宽度被定义为：

    .. math::
        D_{out} = (D_{in} - 1) \times \text{stride}[0] - 2 \times \text{pad}[0] + \text{dilation}[0]
        \times (\text{kernel_size}[0] - 1) + \text{output_padding}[0] + 1

        H_{out} = (H_{in} - 1) \times \text{stride}[1] - 2 \times \text{pad}[1] + \text{dilation}[1]
        \times (\text{kernel_size}[1] - 1) + \text{output_padding}[1] + 1

        W_{out} = (W_{in} - 1) \times \text{stride}[2] - 2 \times \text{pad}[2] + \text{dilation}[2]
        \times (\text{kernel_size}[2] - 1) + \text{output_padding}[2] + 1

    **参数：**

    - **in_channel** (int) - 输入 `dout` 的通道数。
    - **out_channel** (int) - 输入 `weight` 的通道数。
    - **kernel_size** (Union[int, tuple[int]]) - 指定三维卷积核的深度、高度和宽度。数据类型为int或包含三个int值的Tuple。为int时表示卷积核的深度、高度和宽度均为该值。包含三个int值的Tuple分别表示卷积核的深度、高度和宽度。
    - **mode** (int) - 指定不同的卷积模式。此值目前未被使用。默认值： 1。
    - **pad_mode** (str) - 指定填充模式。可选值为"same"、"valid"、"pad"。默认值: "valid"。

      - same: 填充输入。输出的深度、高度和宽度分别与对应输入整除 `stride` 后的值相同。
        同一维度的padding将被尽可能均匀填充在两侧，额外的padding将被填充在维度末端。
        若设置该模式，`pad` 的值必须为0。

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

      - pad: 在输入深度、高度和宽度各维度两侧添加 `pad` 数量的填充。如果设置此模式， `pad` 的值必须大于或等于0。
      
    - **pad** (Union(int, tuple[int])) - 在输入各维度两侧填充的数量。如果 `pad` 是一个整数，则前部、后部、顶部，底部，左边和右边的填充都等于 `pad` 。如果 `pad` 是6个整数的Tuple，则前部、后部、顶部、底部、左边和右边的填充分别等于填充 `pad[0]` 、 `pad[1]` 、 `pad[2]` 、 `pad[3]` 、 `pad[4]` 和 `pad[5]` 。默认值：0。
    - **stride** (Union(int, tuple[int])) - 三维卷积核的移动步长。数据类型为整型或三个整型的Tuple。一个整数表示在深度、高度和宽度方向的移动步长均为该值。三个整数的Tuple分别表示在深度、高度和宽度方向的移动步长。默认值：1。
    - **dilation** (Union(int, tuple[int])) - 卷积核膨胀尺寸，指定应用卷积核的间隔。默认值: 1。
    - **group** (int) - 将过滤器拆分为组。默认值: 1。目前仅支持取值1。
    - **output_padding** (Union(int, tuple[int])) - 为输出的各个维度添加额外长度。默认值: 0。
    - **data_format** (str) - 支持的数据模式。目前仅支持"NCDHW"。

    **输入：**

    - **dout** (Tensor) - 卷积操作的输出的梯度Tensor。shape： :math:`(N, C_{in}, D_{out}, H_{out}, W_{out})` 。目前数据类型仅支持float16和float32。
    - **weight** (Tensor) - 若kernel shape为 :math:`(K_d, K_h, K_w)` ，则weight shape应为 :math:`(C_{in}, C_{out}//group, K_d, K_h, K_w)` ，其中 :math:`group` 为算子参数。:math:`//` 为整数除法操作。目前数据类型仅支持float16和float32。
    - **bias** (Tensor) - shape为 :math:`C_{out}` 的Tensor。目前仅支持None。默认值：None。

    **输出：**

    卷积操作的输入的梯度Tensor，shape： :math:`(N, C_{out}//group, D_{out}, H_{out}, W_{out})` ，其中 :math:`group` 为算子参数。

    **异常：**

    - **TypeError** - `in_channel` 、 `out_channel` 或 `group` 不是int。
    - **TypeError** - `kernel_size` 、 `stride` 、 `pad` 、 `dilation` 或 `output_padding` 既不是int也不是Tuple。
    - **ValueError** - `in_channel` 、 `out_channel` 、 `kernel_size` 、 `stride` 或 `dilation` 小于1。
    - **ValueError** - `pad` 小于0。
    - **ValueError** - `pad_mode` 取值非"same"、"valid"或"pad"。
    - **ValueError** - `pad` 为长度不等于6的Tuple。
    - **ValueError** - `pad_mode` 未设定为"pad"且 `pad` 不等于(0, 0, 0, 0, 0, 0)。
    - **ValueError** - `data_format` 取值非"NCDHW"。
    - **TypeError** - `dout` 或 `weight` 的数据类型不是float16。
    - **ValueError** - `bias` 不为None。 `dout` 或 `weight` 的秩不为5。