文档反馈

问题文档片段

问题文档片段包含公式时，显示为空格。

提交类型

issue

有点复杂...

找人问问吧。

请选择提交类型

问题类型

规范和低错类

- 规范和低错类：

- 错别字或拼写错误，标点符号使用错误、公式错误或显示异常。

- 链接错误、空单元格、格式错误。

- 英文中包含中文字符。

- 界面和描述不一致，但不影响操作。

- 表述不通顺，但不影响理解。

- 版本号不匹配：如软件包名称、界面版本号。

易用性

- 易用性：

- 关键步骤错误或缺失，无法指导用户完成任务。

- 缺少主要功能描述、关键词解释、必要前提条件、注意事项等。

- 描述内容存在歧义指代不明、上下文矛盾。

- 逻辑不清晰，该分类、分项、分步骤的没有给出。

正确性

- 正确性：

- 技术原理、功能、支持平台、参数类型、异常报错等描述和软件实现不一致。

- 原理图、架构图等存在错误。

- 命令、命令参数等错误。

- 代码片段错误。

- 命令无法完成对应功能。

- 界面错误，无法指导操作。

- 代码样例运行报错、运行结果不符。

风险提示

- 风险提示：

- 对重要数据或系统存在风险的操作，缺少安全提示。

内容合规

- 内容合规：

- 违反法律法规，涉及政治、领土主权等敏感词。

- 内容侵权。

请选择问题类型

问题描述

点击输入详细问题描述，以帮助我们快速定位问题。

提交

文档反馈

mindspore.nn.AvgPool3d

class mindspore.nn.AvgPool3d(kernel_size=1, stride=1, pad_mode='valid', padding=0, ceil_mode=False, count_include_pad=True, divisor_override=None)

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

通常，输入的shape为 $(N_{in},C_{in},D_{in},H_{in},W_{in})$ ，AvgPool3D输出 $(D_{in},H_{in},W_{in})$ 维度的区域平均值。给定 kernel_size 为 $ks=(d_{ker},h_{ker},w_{ker})$ 和 stride 为 $s=(s_0,s_1,s_2)$，公式如下。

警告

kernel_size 在[1, 255]的范围内取值。stride 在[1, 63]的范围内取值。

$$\text{output}(N_i,C_j,d,h,w)=\frac{1}{d_{ker}\ast h_{ker}\ast w_{ker}}\sum _{l=0}^{d_{ker}-1}\sum _{m=0}^{h_{ker}-1}\sum _{n=0}^{w_{ker}-1}\text{input}(N_i,C_j,s_0\times d+l,s_1\times h+m,s_2\times w+n)$$

参数：

• kernel_size (Union[int, tuple[int]]，可选) - 指定池化核尺寸大小。如果为整数或单元素tuple，则同时代表池化核的深度，高度和宽度。如果为tuple且长度不为1，其值必须包含三个正整数，分别表示池化核的深度，高度和宽度。默认值：1。

• stride (Union[int, tuple[int]]，可选) - 池化操作的移动步长。如果为整数或单元素tuple，则同时代表池化核的深度，高度和宽度方向上的移动步长。如果为tuple且长度不为1，其值必须包含三个整数值，分别表示池化核的深度，高度和宽度方向上的移动步长。取值必须为正整数。默认值：1。

• pad_mode (str，可选) - 指定池化的填充方式，可选值为”same”，”valid”或”pad”，不区分大小写。默认值：”valid”。

  • same: 输出的深度、高度和宽度分别与输入整除 stride 后的值相同。

  • valid: 在不填充的前提下返回有效计算所得的输出。不满足计算的多余像素会被丢弃。

  • pad: 对输入进行填充。在输入的前后上下左右分别填充 padding 大小的0。如果设置此模式， padding 必须大于或等于0。

• padding (Union(int, tuple[int], list[int])，可选) - 池化填充值，只有 pad_mode 为”pad”时才能设置为非0。默认值：0。只支持以下情况：

  • padding 为一个整数或包含一个整数的tuple/list，此情况下分别在输入的前后上下左右六个方向进行 padding 次的填充。

  • padding 为一个包含三个int的tuple/list，此情况下在输入的前后进行 padding[0] 次的填充，上下进行 padding[1] 次的填充，在输入的左右进行 padding[2] 次的填充。

• ceil_mode (bool，可选) - 若为True，使用ceil来计算输出shape。若为False，使用floor来计算输出shape。默认值：False。

• count_include_pad (bool，可选) - 平均计算是否包括零填充。默认值：True。

• divisor_override (int，可选) - 如果被指定为非0参数，该参数将会在平均计算中被用作除数，否则将会使用 kernel_size 作为除数，默认值：None。

输入：

• x (Tensor) - shape为 $(N,C,D_{in},H_{in},W_{in})$ 或者 $(C,D_{in},H_{in},W_{in})$ 的Tensor。数据类型必须为float16或者float32。

输出：

shape为 $(N,C,D_{out},H_{out},W_{out})$ 或者 $(C,D_{out},H_{out},W_{out})$ 的Tensor。数据类型与 x 一致。

其中，如果 pad_mode 为 pad 模式时，输出的shape计算公式如下：

$$D_{out}=\lfloor \frac{D_{in}+2\times \text{padding}[0]-\text{kernel\_size}[0]}{\text{stride}[0]}+1\rfloor$$

$$H_{out}=\lfloor \frac{H_{in}+2\times \text{padding}[1]-\text{kernel\_size}[1]}{\text{stride}[1]}+1\rfloor$$

$$W_{out}=\lfloor \frac{W_{in}+2\times \text{padding}[2]-\text{kernel\_size}[2]}{\text{stride}[2]}+1\rfloor$$

异常：

• TypeError - kernel_size 既不是整数也不是元组。

• TypeError - stride 既不是整数也不是元组。

• TypeError - padding 既不是整数也不是元组/列表。

• TypeError - ceil_mode 或 count_include_pad 不是bool。

• TypeError - divisor_override 不是整数。

• ValueError - kernel_size 或者 stride 中的数字不是正数。

• ValueError - kernel_size 或 stride 是一个长度不为3的tuple。

• ValueError - padding 为一个tuple/list时，长度不为1或者3。

• ValueError - padding 的元素小于0。

• ValueError - x 的shape长度不等于4或5。

• ValueError - divisor_override 小于等于0。

• ValueError - pad_mode 不为 “pad” 的时候 padding 为非0。

支持平台：

Ascend GPU CPU

样例：

>>> import mindspore as ms
>>> import mindspore.nn as nn
>>> import mindspore.ops as ops
>>> pool = nn.AvgPool3d(kernel_size=3, stride=1)
>>> x = ops.randn(1, 2, 4, 4, 5).astype(ms.float32)
>>> output = pool(x)
>>> print(output.shape)
(1, 2, 2, 2, 3)
>>> x1 = ops.randn(6, 5, 7, 7, 5).astype(ms.float32)
>>> pool2 = nn.AvgPool3d(4, stride=2, pad_mode='pad', padding=(2, 2, 1), divisor_override=10)
>>> output2 = pool2(x1)
>>> print(output2.shape)
(6, 5, 4, 4, 2)