diff --git a/docs/api/paddle/nanmedian_cn.rst b/docs/api/paddle/nanmedian_cn.rst index 56dacbd467f..d25f17a13d3 100644 --- a/docs/api/paddle/nanmedian_cn.rst +++ b/docs/api/paddle/nanmedian_cn.rst @@ -3,10 +3,10 @@ nanmedian ------------------------------- -.. py:function:: paddle.nanmedian(x, axis=None, keepdim=False, name=None) +.. py:function:: paddle.nanmedian(x, axis=None, keepdim=False, name=None, mode="mean") 沿给定的轴 ``axis`` 计算中位数,同时忽略 NAN 元素。 -如果元素的有效计数为偶数,则计算并返回中间两数的平均数。 +如果元素的有效计数为偶数,mode 是 mean 时则计算并返回中间两数的平均数,mode 是 min 时则计算返回中间两数的最小值。 参数 :::::::::: @@ -14,10 +14,12 @@ nanmedian - **axis** (None|int|list|tuple,可选) - 指定对 ``x`` 进行计算的轴。``axis`` 可以是 int 或者 int 元素的列表。``axis`` 值应该在范围[-D, D)内,D 是 ``x`` 的维度。如果 ``axis`` 或者其中的元素值小于 0,则等价于 :math:`axis + D`。如果 ``axis`` 是 None,则对 ``x`` 的全部元素计算中位数。默认值为 None。 - **keepdim** (bool,可选) - 是否在输出 Tensor 中保留减小的维度。如果 ``keepdim`` 为 True,则输出 Tensor 和 ``x`` 具有相同的维度(减少的维度除外,减少的维度的大小为 1)。否则,输出 Tensor 的形状会在 ``axis`` 上进行 squeeze 操作。默认值为 False - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。 + - **mode** (str,可选) - 默认值为 mean。 在 axis 轴的 shape size 为偶数时,当为 mode 是 mean 时,采用 mean 的方式求值,不返回 index ; 当为 mode 是 min 时,采用 min 的方法求值,返回 index。 返回 :::::::::: ``Tensor`` ,沿着 ``axis`` 进行中位数计算的结果,同时忽略 NAN 元素。输出的 dtype 与 ``x`` 相同。 + ``Tensor`` ,沿着 ``axis`` 进行中位数计算的索引结果,同时忽略 NAN 元素。输出的 dtype 为 paddle.int64。 代码示例 ::::::::::