.. _cn_api_paddle_mean:

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

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

沿参数 ``axis`` 计算 ``x`` 的平均值。

.. note::
    别名支持: 参数名 ``input`` 可替代 ``x`` 和 ``dim`` 可替代 ``axis``，如 ``input=tensor_x`` 等价于 ``x=tensor_x``， ``dim=0`` 等价于 ``axis=0``。

参数
::::::::::
    - **x** (Tensor) - 输入的 Tensor，数据类型为：bool、bfloat16、float16、float32、float64、int32、int64、complex64、complex128。
      ``别名：input``
    - **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。
      ``别名：dim``
    - **keepdim** (bool，可选) - 是否在输出 Tensor 中保留减小的维度。如果 ``keepdim`` 为 True，则输出 Tensor 和 ``x`` 具有相同的维度(减少的维度除外，减少的维度的大小为 1)。否则，输出 Tensor 的形状会在 ``axis`` 上进行 squeeze 操作。默认值为 False。
    - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。
    - **dtype** (str，可选) - 输出 Tensor 的数据类型。如果指定了 ``dtype``，在计算之前输入 Tensor 会被转换为指定的类型。该参数为仅关键字参数，默认值为 None，此时输出的数据类型与输入 ``x`` 的数据类型一致。
    - **out** (Tensor，可选)- 输出的结果。该参数为仅关键字参数，默认值为 None。

返回
::::::::::
    ``Tensor``，沿着 ``axis`` 进行平均值计算的结果，数据类型由 ``dtype`` 参数决定，如果 ``dtype`` 为 None 则与 ``x`` 相同。

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

COPY-FROM: paddle.mean
