mindspore.ops.AvgPool3D

class mindspore.ops.AvgPool3D(kernel_size=1, strides=1, pad_mode='valid', pad=0, ceil_mode=False, count_include_pad=True, divisor_override=0, data_format='NCDHW')[源代码]

对输入的多维数据进行三维的平均池化运算。

一般情况下，当输入shape为 $(N, C, D_{i n}, H_{i n}, W_{i n})$ 时，AvgPool3D会在 $(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})$ ，运算如下：

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)

说明

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

参数：

kernel_size (Union[int, tuple[int]]，可选) - 指定池化核尺寸大小。可以是一个整数，其值同时对应深度、高度和宽度；或者是一个tuple，含3个整数，分别对应深度、高度和宽度。默认值： 1 ，取值范围为[1, 255]。
strides (Union[int, tuple[int]]，可选) - 池化操作的移动步长。可以是一个整数，其值同时对应移动深度、高度和宽度；或者是一个tuple，含3个整数，分别对应移动深度、高度和宽度。默认值： 1 ，取值范围为[1, 63]。
pad_mode (str，可选) - 指定填充模式，填充值为0。可选值为 "same" ， "valid" 或 "pad" 。默认值： "valid" 。
- "same"：在输入的深度、高度和宽度维度进行填充，使得当 stride 为 1 时，输入和输出的shape一致。待填充的量由算子内部计算，若为偶数，则均匀地填充在四周，若为奇数，多余的填充量将补充在前方/底部/右侧。如果设置了此模式， pad 必须为0。
- "valid"：不对输入进行填充，返回输出可能的最大深度、高度和宽度，不能构成一个完整stride的额外的像素将被丢弃。如果设置了此模式， pad 必须为0。
- "pad"：对输入填充指定的量。在这种模式下，在输入的深度、高度和宽度方向上填充的量由 pad 参数指定。如果设置此模式， pad 必须大于或等于0。
pad (Union(int, tuple[int], list[int])，可选) - 池化填充方式。默认值： 0 。如果 pad 是一个整数，则头部、尾部、顶部、底部、左边和右边的填充都是相同的，等于 pad 。如果 pad 是六个integer的tuple，则头部、尾部、顶部、底部、左边和右边的填充分别等于填充pad[0]、pad[1]、pad[2]、pad[3]、pad[4]和pad[5]。
ceil_mode (bool，可选) - 是否使用ceil函数计算输出高度和宽度。默认值： False 。
count_include_pad (bool，可选) - 如果为 True ，平均计算将包括零填充。默认值： True 。
divisor_override (int，可选) - 如果指定了该值，它将在平均计算中用作除数，否则将使用kernel_size作为除数。默认值： 0 。
data_format (str，可选) - 输入和输出的数据格式。目前仅支持'NCDHW'。默认值： "NCDHW" 。

输入：

x (Tensor) - shape为 $(N, C, D_{i n}, H_{i n}, W_{i n})$ 的Tensor。数据类型为float16、float32和float64。

输出：

Tensor，其shape为 $(N, C, D_{o u t}, H_{o u t}, W_{o u t})$ ，数据类型与 x 相同。

异常：

TypeError - kernel_size 、 strides 或 pad 既不是int也不是tuple。
TypeError - ceil_mode 或 count_include_pad 不是bool。
TypeError - pad_mode 或 data_format 不是string。
TypeError - divisor_override 不是int。
ValueError - kernel_size 或 strides 中的数字不是正数。
ValueError - kernel_size 或 strides 是长度不等于3的tuple。
ValueError - pad_mode 不是'same'，'valid'，或'pad'。
ValueError - pad 是长度不等于6的tuple。
ValueError - pad 的元素小于0。
ValueError - pad_mode 不等于'pad'且 pad 不等于0或(0, 0, 0, 0, 0, 0)。
ValueError - data_format 不是'NCDHW'。

支持平台：

Ascend GPU CPU

样例：

>>> import mindspore
>>> from mindspore import Tensor, ops
>>> import numpy as np
>>> x = Tensor(np.arange(1 * 2 * 2 * 2 * 3).reshape((1, 2, 2, 2, 3)), mindspore.float16)
>>> avg_pool3d = ops.AvgPool3D(kernel_size=2, strides=1, pad_mode="valid")
>>> output = avg_pool3d(x)
>>> print(output)
[[[[[ 5.  6.]]]
  [[[17. 18.]]]]]