From 23b8d6df80190f138bee106fc3c552d20284b7da Mon Sep 17 00:00:00 2001 From: thunder95 <290844930@qq.com> Date: Sat, 21 May 2022 08:21:40 +0800 Subject: [PATCH 1/2] add nanmedian doc --- docs/api/api_label | 1 + docs/api/paddle/Overview_cn.rst | 1 + docs/api/paddle/Tensor/Overview_en.rst | 1 + docs/api/paddle/Tensor_cn.rst | 9 +++++++++ docs/api/paddle/nanmedian_cn.rst | 24 ++++++++++++++++++++++++ 5 files changed, 36 insertions(+) create mode 100644 docs/api/paddle/nanmedian_cn.rst diff --git a/docs/api/api_label b/docs/api/api_label index 0a786e28c25..be4ac3b7889 100644 --- a/docs/api/api_label +++ b/docs/api/api_label @@ -190,6 +190,7 @@ paddle.max .. _api_paddle_max: paddle.maximum .. _api_paddle_maximum: paddle.mean .. _api_paddle_mean: paddle.median .. _api_paddle_median: +paddle.nanmedian .. _api_paddle_nanmedian: paddle.min .. _api_paddle_min: paddle.minimum .. _api_paddle_minimum: paddle.mm .. _api_paddle_mm: diff --git a/docs/api/paddle/Overview_cn.rst b/docs/api/paddle/Overview_cn.rst index e5b23b580dd..2e45ba61cfd 100755 --- a/docs/api/paddle/Overview_cn.rst +++ b/docs/api/paddle/Overview_cn.rst @@ -85,6 +85,7 @@ tensor数学操作 " :ref:`paddle.maximum ` ", "逐元素对比输入的两个Tensor，并且把各个位置更大的元素保存到返回结果中" " :ref:`paddle.mean ` ", "沿 axis 计算 x 的平均值" " :ref:`paddle.median ` ", "沿给定的轴 axis 计算 x 中元素的中位数" + " :ref:`paddle.nanmedian ` ", "沿给定的轴 axis 忽略NAN元素计算 x 中元素的中位数" " :ref:`paddle.min ` ", "对指定维度上的Tensor元素求最小值运算" " :ref:`paddle.amin ` ", "对指定维度上的Tensor元素求最小值运算" " :ref:`paddle.minimum ` ", "逐元素对比输入的两个Tensor，并且把各个位置更小的元素保存到返回结果中" diff --git a/docs/api/paddle/Tensor/Overview_en.rst b/docs/api/paddle/Tensor/Overview_en.rst index 52ea59ee07f..91268f80d7b 100644 --- a/docs/api/paddle/Tensor/Overview_en.rst +++ b/docs/api/paddle/Tensor/Overview_en.rst @@ -175,6 +175,7 @@ Methods fmax mean median + nanmedian min minimum fmin diff --git a/docs/api/paddle/Tensor_cn.rst b/docs/api/paddle/Tensor_cn.rst index 53b132c0367..d24cce17c5f 100755 --- a/docs/api/paddle/Tensor_cn.rst +++ b/docs/api/paddle/Tensor_cn.rst @@ -1460,6 +1460,15 @@ median(axis=None, keepdim=False, name=None) 请参考 :ref:`cn_api_tensor_cn_median` +nanmedian(axis=None, keepdim=True, name=None) +::::::::: + +返回：沿着 ``axis`` 忽略NAN元素进行中位数计算的结果 + +返回类型：Tensor + +请参考 :ref:`cn_api_tensor_cn_nanmedian` + min(axis=None, keepdim=False, name=None) ::::::::: diff --git a/docs/api/paddle/nanmedian_cn.rst b/docs/api/paddle/nanmedian_cn.rst new file mode 100644 index 00000000000..5577ae1845a --- /dev/null +++ b/docs/api/paddle/nanmedian_cn.rst @@ -0,0 +1,24 @@ +.. _cn_api_tensor_cn_nanmedian: + +nanmedian +------------------------------- + +.. py:function:: paddle.nanmedian(x, axis=None, keepdim=True, name=None) + +沿给定的轴 ``axis`` 忽略NAN元素计算 ``x`` 中元素的中位数。 + +参数 +:::::::::: + - x (Tensor) - 输入的Tensor，数据类型为：float16、float32、float64、int32、int64。 + - 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操作。默认值为True。 + - name (str， 可选) - 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。 + +返回 +:::::::::: + ``Tensor`` ，沿着 ``axis`` 忽略NAN元素进行中位数计算的结果。 + +代码示例 +:::::::::: +COPY-FROM: paddle.nanmedian:nanmedian-example + From 7d3682bc6468845ef8f5aec20020e46300929dfb Mon Sep 17 00:00:00 2001 From: Ligoml <39876205+Ligoml@users.noreply.github.com> Date: Thu, 26 May 2022 14:46:00 +0800 Subject: [PATCH 2/2] Update nanmedian_cn.rst --- docs/api/paddle/nanmedian_cn.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api/paddle/nanmedian_cn.rst b/docs/api/paddle/nanmedian_cn.rst index 5577ae1845a..20df1ef2137 100644 --- a/docs/api/paddle/nanmedian_cn.rst +++ b/docs/api/paddle/nanmedian_cn.rst @@ -10,9 +10,9 @@ nanmedian 参数 :::::::::: - x (Tensor) - 输入的Tensor，数据类型为：float16、float32、float64、int32、int64。 - - 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操作。默认值为True。 - - name (str， 可选) - 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。 + - 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操作。默认值为True。 + - name (str，可选) - 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。 返回 ::::::::::