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.

PR

Just a small problem.

I can fix it online!

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.max_unpool3d

mindspore.ops.max_unpool3d(x, indices, kernel_size, stride=None, padding=0, output_size=None)

Computes the inverse of mindspore.ops.max_pool3d().

max_unpool3d keeps the maximal value and set all position of non-maximal values to zero. Typically the input is of shape $(N,C,D_{in},H_{in},W_{in})$ or $(C,D_{in},H_{in},W_{in})$, and the output is of shape $(N,C,D_{out},H_{out},W_{out})$ or $(C,D_{out},H_{out},W_{out})$. The operation is as follows.

$$\begin{array}{r}\begin{array}{l}\\ D_{out}=(Din-1)\times stride[0]-2\times padding[0]+kernel\mathrm{\_}size[0]\\ H_{out}=(Hin-1)\times stride[1]-2\times padding[1]+kernel\mathrm{\_}size[1]\\ W_{out}=(Win-1)\times stride[2]-2\times padding[2]+kernel\mathrm{\_}size[2]\end{array}\end{array}$$

Parameters

• x (Tensor) – The input Tensor to invert. Tensor of shape $(N,C,D_{in},H_{in},W_{in})$ or $(C,D_{in},H_{in},W_{in})$.

• indices (Tensor) – Max values' index represented by the indices. Tensor of shape must be same with input 'x'. Values of indices must belong to $[0,D_{in}\times H_{in}\times W_{in}-1]$. Data type must be in int32 or int64.

• kernel_size (Union[int, tuple[int]]) – The size of kernel used to take the maximum value, an int number that represents depth, height and width of the kernel, or a tuple of three int numbers that represent depth, height and width respectively.

• stride (Union[int, tuple[int]]) – The distance of kernel moving, an int number that represents the depth, height and width of movement are both stride, or a tuple of three int numbers that represent depth, height and width of movement respectively. Default: None , which indicates the moving step is kernel_size .

• padding (Union[int, tuple[int]]) – The pad value to be filled. Default: 0 . If padding is an integer, the paddings of depth, height and width are the same, equal to padding. If padding is a tuple of three integers, the padding of depth, height and width equal to padding[0], padding[1] and padding[2] correspondingly.

• output_size (tuple[int], optional) – The output size. Default: None . If output_size == (), then the shape of output computed by kernel_size, stride and padding. If output_size != (), then output_size must be $(N,C,D,H,W)$ or $(C,D,H,W)$ or $(D,H,W)$ and output_size must belong to $[(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])]$.

Returns

Tensor, with shape $(N,C,D_{out},H_{out},W_{out})$ or $(C,D_{out},H_{out},W_{out})$, with the same data type with x.

Raises

• TypeError – If data type of x or indices is not supported.

• TypeError – If kernel_size, stride or padding is neither an int nor a tuple.

• ValueError – If numbers in stride or padding (also support 0 and (0, 0, 0)) or kernel_size is not positive.

• ValueError – If the shape of x and indices are not equal.

• ValueError – If kernel_size, stride or padding is a tuple whose length is not equal to 3.

• ValueError – If x whose length is not 4 or 5.

• ValueError – If output_size whose length is not 0, 4 or 5.

• ValueError – If output_size whose type is not tuple.

• ValueError – If output_size is not close to output size computed by attr kernel_size, stride, padding.

Supported Platforms:

Ascend GPU CPU

Examples

>>> import numpy as np
>>> from mindspore import Tensor, ops
>>> x = Tensor(np.array([[[[[0, 1], [8, 9]]]]]).astype(np.float32))
>>> indices= Tensor(np.array([[[[[0, 1], [2, 3]]]]]).astype(np.int64))
>>> output = ops.max_unpool3d(x, indices, kernel_size=2, stride=1, padding=0)
>>> print(output)
[[[[[0. 1. 8.]
    [9. 0. 0.]
    [0. 0. 0.]]
   [[0. 0. 0.]
    [0. 0. 0.]
    [0. 0. 0.]]]]]