mindspore/docs/api/api_python/ops/mindspore.ops.MaxPool.rst

42 lines
2.5 KiB
ReStructuredText
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

mindspore.ops.MaxPool
=====================
.. py:class:: mindspore.ops.MaxPool(kernel_size=1, strides=1, pad_mode="valid", data_format="NCHW")
对输入的多维数据进行二维的最大池化运算。
在一个输入Tensor上应用2D max pooling可被视为2D输入平面。
通常输入的shape为 :math:`(N_{in}, C_{in}, H_{in}, W_{in})` MaxPool在 :math:`(H_{in}, W_{in})` 维度输出区域最大值。给定 `kernel_size`:math:`ks = (h_{ker}, w_{ker})``stride` :math:`s = (s_0, s_1)` ,运算如下:
.. math::
\text{output}(N_i, C_j, h, w) = \max_{m=0, \ldots, h_{ker}-1} \max_{n=0, \ldots, w_{ker}-1}
\text{input}(N_i, C_j, s_0 \times h + m, s_1 \times w + n)
参数:
- **kernel_size** (Union[int, tuple[int]]) - 指定池化核尺寸大小。由一个整数或者是两个整数组成的tuple表示高和宽。默认值 ``1``
- **strides** (Union[int, tuple[int]]) - 池化操作的移动步长由一个整数或者是两个整数组成的tuple表示高和宽上的移动步长。默认值 ``1``
- **pad_mode** (str可选) - 指定填充模式填充值为0。可选值为 ``"same"````"valid"``。默认值: ``"valid"``
- ``"same"``:在输入的四周填充,使得当 `stride```1``输入和输出的shape一致。待填充的量由算子内部计算若为偶数则均匀地填充在四周若为奇数多余的填充量将补充在底部/右侧。
- ``"valid"``不对输入进行填充返回输出可能的最大高度和宽度不能构成一个完整stride的额外的像素将被丢弃。
- **data_format** (str) - 输入和输出的数据格式。可选值为 ``"NHWC"````"NCHW"`` 。默认值: ``"NCHW"``
输入:
- **x** (Tensor) - shape为 :math:`(N, C_{in}, H_{in}, W_{in})` 的Tensor。
支持数据类型:
- CPUfloat16、float32、float64。
- GPU/Ascendfloat16、float32。
输出:
Tensorshape为 :math:`(N, C_{out}, H_{out}, W_{out})`
异常:
- **TypeError** - `kernel_size``strides` 既不是int也不是tuple。
- **ValueError** - `pad_mode` 既不是 ``"valid"`` 也不是 ``"same"`` (不区分大小写)。
- **ValueError** - `data_format` 既不是 ``"NCHW"`` 也不是 ``"NHWC"``
- **ValueError** - `kernel_size``strides` 小于1。
- **ValueError** - `input` 的shape长度不等于4。