AvgPool3d

class continual.AvgPool3d(kernel_size, stride=None, padding=0, ceil_mode=False, count_include_pad=True, divisor_override=None, dilation=1, temporal_fill='zeros')

Applies a Continual 3D average pooling over an input signal composed of several input planes.

In the simplest case, the output value of the layer with input size $(N, C, T, H, W)$, output $(N, C, T_{out}, H_{out}, W_{out})$ and kernel_size $(kT, kH, kW)$ can be precisely described as:

$$\begin{aligned} \text{out}(N_i, C_j, d, h, w) ={} & \sum_{k=0}^{kT-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)} {kT \times kH \times kW} \end{aligned}$$

If padding is non-zero, then the input is implicitly zero-padded on all three sides for padding number of points.

Note

When stride > 1, the forward_step will only produce non-None values every stride steps.

Note

When ceil_mode=True, sliding windows are allowed to go off-bounds if they start within the left padding or the input. Sliding windows that would start in the right padded region are ignored.

The parameters kernel_size, stride can either be:

• a single int – in which case the same value is used for the depth, height and width dimension

• a tuple of three ints – in which case, the first int is used for the depth dimension, the second int for the height dimension and the third int for the width dimension

Parameters:

• kernel_size (Union[int, Tuple[int, int, int]]) – the size of the window

• stride (Union[int, Tuple[int, int, int]]) – the stride of the window. Default value is kernel_size

• padding (Union[int, Tuple[int, int, int]]) – implicit zero padding to be added on all three sides

• ceil_mode (bool) – when True, will use ceil instead of floor to compute the output shape

• count_include_pad (bool) – when True, will include the zero-padding in the averaging calculation

• divisor_override (Optional[int]) – if specified, it will be used as divisor, otherwise kernel_size will be used

• dilation (Union[int, Tuple[int, int, int]]) – The stride between elements within a sliding window, must be > 0. Only temporal dimension is supported

• temporal_fill (PaddingMode) – How temporal states are initialized

Shape:

• Input: $(N, C, T_{in}, H_{in}, W_{in})$.

• Output: $(N, C, T_{out}, H_{out}, W_{out})$, where

  $$T_{out} = \left\lfloor\frac{T_{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$$

Examples:

m = co.AvgPool3d((3, 3, 3))
x = torch.randn(20, 16, 50, 44, 31)
assert torch.allclose(m.forward(x), m.forward_steps(x), atol=1e-7)