avg_pool1d

paddle.nn.functional. avg_pool1d ( x, kernel_size, stride=None, padding=0, exclusive=True, ceil_mode=False, name=None ) [source]

This API implements average pooling 1d operation, See more details in api_nn_pooling_AvgPool1d .

Parameters

  • x (Tensor) – The input tensor of pooling operator which is a 3-D tensor with shape [N, C, L]. where N is batch size, C is the number of channels, L is the length of the feature. The data type is float32 or float64.

  • kernel_size (int|list|tuple) – The pool kernel size. If pool kernel size is a tuple or list, it must contain an integer.

  • stride (int|list|tuple) – The pool stride size. If pool stride size is a tuple or list, it must contain an integer.

  • padding (string|int|list|tuple) – The padding size. Padding could be in one of the following forms. 1. A string in [‘valid’, ‘same’]. 2. An int, which means the feature map is zero padded by size of padding on every sides. 3. A list[int] or tuple(int) whose length is 1, which means the feature map is zero padded by the size of padding[0] on every sides. 4. A list[int] or tuple(int) whose length is 2. It has the form [pad_before, pad_after]. 5. A list or tuple of pairs of integers. It has the form [[pad_before, pad_after], [pad_before, pad_after], …]. Note that, the batch dimension and channel dimension should be [0,0] or (0,0). The default value is 0.

  • exclusive (bool) – Whether to exclude padding points in average pooling mode, default is True.

  • ceil_mode (bool) – ${ceil_mode_comment}Whether to use the ceil function to calculate output height and width. If it is set to False, the floor function will be used. The default value is False.

  • name (str, optional) – For detailed information, please refer to Name. Usually name is no need to set and None by default.

Returns

The output tensor of pooling result. The data type is same as input tensor.

Return type

Tensor

Examples

import paddle
import paddle.nn as nn

data = paddle.uniform([1, 3, 32], paddle.float32)
AvgPool1D = nn.AvgPool1D(kernel_size=2, stride=2, padding=0)
pool_out = AvgPool1D(data)
# pool_out shape: [1, 3, 16]