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)$、输出 $(N, C, D_{out}, H_{out}, W_{out})$ 和 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 类型的值 – 在这种情况下，深度、高度和宽度维度都使用相同的值

• 一个包含三个 `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}$ 减 1。

  同样的规则适用于 $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)