.. _cn_api_tensor_cn_mean:

mean
-------------------------------

.. py:function:: paddle.mean(x, axis=None, keepdim=False, name=None)



该OP沿 ``axis`` 计算 ``x`` 的平均值。

参数
::::::::::
    - x (Tensor) - 输入的Tensor，数据类型为：float32、float64、int32.int64 。
    - axis (int|list|tuple, 可选) - 指定对 ``x`` 进行计算的轴。``axis`` 可以是int、list(int)、tuple(int)。如果 ``axis`` 包含多个维度，则沿着 ``axis`` 中的所有轴进行计算。``axis`` 或者其中的元素值应该在范围[-D, D)内，D是 ``x`` 的维度。如果 ``axis`` 或者其中的元素值小于0，则等价于 :math:`axis + D` 。如果 ``axis`` 是None，则对 ``x`` 的全部元素计算平均值。默认值为None。
    - keepdim (bool, 可选) - 是否在输出Tensor中保留减小的维度。如果 ``keep_dim`` 为True，则输出Tensor和 ``x`` 具有相同的维度(减少的维度除外，减少的维度的大小为1)。否则，输出Tensor的形状会在 ``axsi`` 上进行squeeze操作。默认值为False。
    - name (str, 可选) - 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。

返回
::::::::::
    ``Tensor`` ，沿着 ``axis`` 进行平均值计算的结果，数据类型和 ``x`` 相同。

代码示例
::::::::::

.. code-block:: python

    import paddle
    import numpy as np

    paddle.disable_static()

    x = np.array([[[1, 2, 3, 4],
                    [5, 6, 7, 8],
                    [9, 10, 11, 12]],
                    [[13, 14, 15, 16],
                    [17, 18, 19, 20],
                    [21, 22, 23, 24]]], 'float32')
    x = paddle.to_variable(x)
    out1 = paddle.mean(x)
    # [12.5]
    out2 = paddle.mean(x, axis=-1)
    # [[ 2.5  6.5 10.5]
    #  [14.5 18.5 22.5]]
    out3 = paddle.mean(x, axis=-1, keepdim=True)
    # [[[ 2.5]
    #   [ 6.5]
    #   [10.5]]
    #  [[14.5]
    #   [18.5]
    #   [22.5]]]
    out4 = paddle.mean(x, axis=[0, 2])
    # [ 8.5 12.5 16.5]
