mindspore.ops.avg_pool3d

mindspore.ops.avg_pool3d(input_x, kernel_size=1, stride=1, padding=0, ceil_mode=False, count_include_pad=True, divisor_override=0)[源代码]

在输入Tensor上应用3D平均池化，输入Tensor可以看作是由一系列3D平面组成的。

一般地，输入的shape为 $(N, C, D_{i n}, H_{i n}, W_{i n})$ ，输出 $(D_{i n}, H_{i n}, W_{i n})$ 维度的区域平均值。给定 kernel_size 为 $k s = (d_{k e r}, h_{k e r}, w_{k e r})$ ， stride 为 $s = (s_{0}, s_{1}, s_{2})$ ，运算如下：

\begin{array}{r} \begin{matrix} output (N_{i}, C_{j}, d, h, w) = \frac{1}{d_{k e r} * h_{k e r} * w_{k e r}} \sum_{l = 0}^{d_{k e r} - 1} \sum_{m = 0}^{h_{k e r} - 1} \sum_{n = 0}^{w_{k e r} - 1} \\ input (N_{i}, C_{j}, s_{0} \times d + l, s_{1} \times h + m, s_{2} \times w + n) \end{matrix} \end{array}

警告

kernel_size 取值为[1, 255]范围内的正整数，stride 的取值为[1, 63]范围内的正整数。

说明

该接口暂不支持Atlas A2 训练系列产品。

参数：

input_x (Tensor) - 输入shape为 $(N, C, D_{i n}, H_{i n}, W_{i n})$ 的Tensor，数据类型为float16和float32。
kernel_size (Union[int, tuple[int]], 可选) - 指定池化核尺寸大小，可以是单个整数表示池化核深度、高度、宽度，或者整数tuple分别表示池化核深度、高度、宽度。默认 1 。
stride (Union[int, tuple[int]], 可选) - 池化操作的移动步长，可以是单个整数表示深度、高度、宽度方向的移动步长，或者整数tuple分别表示深度、高度、深度方向的移动步长。默认 1 。
padding (Union(int, tuple[int]), 可选) - 池化填充长度。可以是一个整数表示在头尾上下左右方向的填充长度，或者包含六个整数的tuple，分别表示在头尾上下左右方向的填充长度。默认 0 。
ceil_mode (bool, 可选) - 如果为 True ，用ceil代替floor来计算输出的shape。默认 False 。
count_include_pad (bool, 可选) - 如果为 True ，平均计算将包括零填充。默认 True 。
divisor_override (int, 可选) - 如果指定了该值，它将在平均计算中用作除数，否则将使用 kernel_size 作为除数。默认 0 ，表示未指定该值。

返回：

Tensor，shape为 $(N, C, D_{o u t}, H_{o u t}, W_{o u t})$ ，数据类型与 input_x 一致。

异常：

TypeError - input_x 不是一个Tensor。
TypeError - kernel_size 或 stride 或 padding 既不是int也不是tuple。
TypeError - ceil_mode 或 count_include_pad 不是bool。
TypeError - divisor_override 不是int。
ValueError - input_x 的shape长度不等于5。
ValueError - kernel_size 或 stride 的值不是正整数。
ValueError - kernel_size 或 stride 是长度不等于3的tuple。
ValueError - padding 是tuple时，其长度不等于6。
ValueError - padding 的值小于0。

支持平台：

Ascend GPU CPU

样例：

>>> import mindspore
>>> import numpy as np
>>> from mindspore import Tensor, ops
>>> input_x = Tensor(np.arange(1 * 2 * 2 * 2 * 3).reshape((1, 2, 2, 2, 3)), mindspore.float16)
>>> output = ops.avg_pool3d(input_x, kernel_size=2, stride=1)
>>> print(output)
[[[[[ 5.  6.]]]
  [[[17. 18.]]]]]