mindspore/docs/api/api_python/nn/mindspore.nn.AdaptiveAvgPool3d.rst

mindspore.nn.AdaptiveAvgPool3d
==============================

.. py:class:: mindspore.nn.AdaptiveAvgPool3d(output_size)

    三维自适应平均池化。

    对输入Tensor，提供3维的自适应平均池化操作。也就是说对于输入任何尺寸，指定输出的尺寸都为 :math:`(D, H, W)`。但是输入和输出特征的数目不会变化。

    假设输入 `x` 最后3维大小分别为 :math:`(inD, inH, inW)`，则输出的最后3维大小分别为 :math:`(outD, outH, outW)`。运算如下：

    .. math::
        \begin{array}{ll} \\
            \forall \quad od \in [0,outD-1], oh \in [0,outH-1], ow \in [0,outW-1]\\
            output[od,oh,ow] = \\
            \qquad mean(x[istartD:iendD+1,istartH:iendH+1,istartW:iendW+1])\\
            where,\\
            \qquad istartD= \left\lceil \frac{od * inD}{outD} \right\rceil \\
            \qquad iendD=\left\lfloor \frac{(od+1)* inD}{outD} \right\rfloor \\
            \qquad istartH=\left\lceil \frac{oh * inH}{outH} \right\rceil \\
            \qquad iendH=\left\lfloor \frac{(oh+1) * inH}{outH} \right\rfloor \\
            \qquad istartW=\left\lceil \frac{ow * inW}{outW} \right\rceil \\
            \qquad iendW=\left\lfloor \frac{(ow+1) * inW}{outW} \right\rfloor
        \end{array}

    参数：
        - **output_size** (Union[int, tuple]) - 指定输出特征图的尺寸，可以是个tuple :math:`(D, H, W)`，也可以是一个int值D来表示输出尺寸为 :math:`(D, D, D)` 。:math:`D`，:math:`H` 和 :math:`W` 可以是int值或者None，其中None表示输出大小与对应的输入的大小相同。

    输入：
        - **x** (Tensor) - AdaptiveAvgPool3d的输入，是4D或者5D的Tensor。数据类型：float16，float32或者float64。

    输出：
        Tensor，与输入 `x` 的数据类型相同。

    异常：
        - **TypeError** - `x` 不是Tensor。
        - **TypeError** - `x` 的数据类型不是float16、float32或者float64。
        - **ValueError** - `x` 维度不是4D或者5D。
        - **ValueError** - `output_size` 的值不是正数。