mindspore.nn.MaxUnpool3d

class mindspore.nn.MaxUnpool3d(kernel_size, stride=None, padding=0)[源代码]

MaxPool3d 的部分逆过程。 MaxPool3d 不是完全可逆的，因为非最大值丢失。 MaxUnpool3d 以 MaxPool3d 的输出为输入，包括最大值的索引。在计算 MaxPool3d 部分逆的过程中，非最大值设置为零。支持的输入数据格式为 \((N, C, D_{in}, H_{in}, W_{in})\) 或 \((C, D_{in}, H_{in}, W_{in})\) ，输出数据的个格式为 \((N, C, D_{out}, H_{out}, W_{out})\) 或 \((C, D_{out}, H_{out}, W_{out})\) ，计算公式如下：

\[\begin{split}\begin{array}{ll} \\ D_{out} = (D{in} - 1) \times stride[0] - 2 \times padding[0] + kernel\_size[0] \\ H_{out} = (H{in} - 1) \times stride[1] - 2 \times padding[1] + kernel\_size[1] \\ W_{out} = (W{in} - 1) \times stride[2] - 2 \times padding[2] + kernel\_size[2] \\ \end{array}\end{split}\]

参数：

kernel_size (Union[int, tuple[int]]) - 池化核尺寸大小。int类型表示池化核的深度、长和宽相同。 tuple类型中的三个值分别代表池化核的深度、长和宽。
stride (Union[int, tuple[int]]) - 池化操作的移动步长，int类型表示深度、长和宽方向的移动步长相同。 tuple中的三个值分别代表深度、长和宽方向移动的步长。若取值为 ‘0’ 或者 ‘(0, 0, 0)’ ， stride 值与 kernel_size 相同。默认值：None。
padding (Union[int, tuple[int]]) - 填充值。默认值：0。若为int类型，则深度、长和宽方向的填充大小相同，均为 padding 。若为tuple类型，则tuple中的三个值分别代表深度、长和宽方向填充的大小。

输入：

x (Tensor) - 待求逆的Tensor。shape为 \((N, C, D_{in}, H_{in}, W_{in})\) 或 \((C, D_{in}, H_{in}, W_{in})\) 。
indices (Tensor) - 最大值的索引。shape必须与输入 x 相同。取值范围需满足 \([0, D_{in} \times H_{in} \times W_{in} - 1]\) 。数据类型必须是int32或int64。
output_size (tuple[int], 可选) - 输出shape。默认值：None。如果output_size为()，那么输出shape根据 kernel_size 、 stride 和 padding 计算得出。如果output_size不为()，那么 output_size 必须满足格式 \((N, C, D, H, W)\) 或 \((C, D, H, W)\) ，取值范围需满足： \([(N, C, D_{out} - stride[0], H_{out} - stride[1], W_{out} - stride[2]), (N, C, D_{out} + stride[0], H_{out} + stride[1], W_{out} + stride[2])]\) 。

输出：

shape为 \((N, C, D_{out}, H_{out}, W_{out})\) 或 \((C, D_{out}, H_{out}, W_{out})\) 的Tensor，数据类型与输入 x 相同。

异常：

TypeError - x 或 indices 的数据类型不支持。
TypeError - kernel_size ， stride 或 padding 既不是整数也不是tuple。
ValueError - stride ， kernel_size 或 padding 的值不是非负的。
ValueError - x 和 indices 的shape不一致。
ValueError - kernel_size ， stride 或 padding 为tuple时长度不等于3。
ValueError - x 的长度不为4或5。
ValueError - output_size 的类型不是tuple。
ValueError - output_size 的长度不为0、4或5。
ValueError - output_size 的取值与根据 kernel_size , stride , padding 计算得到的结果差距太大。

支持平台：

GPU CPU

样例：

>>> x = Tensor(np.array([[[[[0, 1], [8, 9]]]]]).astype(np.float32))
>>> indices= Tensor(np.array([[[[[0, 1], [2, 3]]]]]).astype(np.int64))
>>> maxunpool3d = nn.MaxUnpool3d(kernel_size=1, stride=1, padding=0)
>>> output = maxunpool3d(x, indices)
>>> print(output.asnumpy())
[[[[[0. 1.]
    [8. 9.]]]]]