AvgPool3d

class torch.nn.AvgPool3d(kernel_size, stride=None, padding=0, ceil_mode=False, count_include_pad=True, divisor_override=None)

对由多个输入平面组成的输入信号应用 3D 平均池化。

在最简单的情况下，具有输入大小 $(N, C, D, H, W)$ 的层和 kernel_size $(kD, kH, kW)$ 的输出值可以精确地描述为

$$\begin{aligned} \text{out}(N_i, C_j, d, h, w) ={} & \sum_{k=0}^{kD-1} \sum_{m=0}^{kH-1} \sum_{n=0}^{kW-1} \\ & \frac{\text{input}(N_i, C_j, \text{stride}[0] \times d + k, \text{stride}[1] \times h + m, \text{stride}[2] \times w + n)} {kD \times kH \times kW} \end{aligned}$$

如果 padding 为非零，则输入将在所有三个侧面隐式地进行零填充，填充的点数为 padding。

注意

当 ceil_mode=True 时，如果滑动窗口在左侧填充或输入内开始，则允许滑动窗口越界。将忽略在右侧填充区域中开始的滑动窗口。

参数 kernel_size、stride 可以是

• 单个 int – 在这种情况下，深度、高度和宽度维度使用相同的值

• 三个整数的 tuple – 在这种情况下，第一个 int 用于深度维度，第二个 int 用于高度维度，第三个 int 用于宽度维度

参数

• kernel_size (Union[int, Tuple[int, int, int]]) – 窗口的大小

• stride (Union[int, Tuple[int, int, int]]) – 窗口的步幅。默认值是 kernel_size

• padding (Union[int, Tuple[int, int, int]]) – 要在所有三个侧面添加的隐式零填充

• ceil_mode (bool) – 当为 True 时，将使用 ceil 而不是 floor 来计算输出形状

• count_include_pad (bool) – 当为 True 时，将在平均计算中包括零填充

• divisor_override (Optional[int]) – 如果指定，它将用作除数，否则将使用 kernel_size

形状

• 输入: $(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})$，其中

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

  根据上述注释，如果 ceil_mode 为 True 并且 $(D_{out} - 1)\times \text{stride}[0]\geq D_{in} + \text{padding}[0]$，我们将跳过最后一个窗口，因为它将从填充区域开始，从而导致 $D_{out}$ 减一。

  同样的道理适用于 $W_{out}$ 和 $H_{out}$。

示例

>>> # pool of square window of size=3, stride=2
>>> m = nn.AvgPool3d(3, stride=2)
>>> # pool of non-square window
>>> m = nn.AvgPool3d((3, 2, 2), stride=(2, 1, 2))
>>> input = torch.randn(20, 16, 50, 44, 31)
>>> output = m(input)