Skip to content

Commit 25ec3b3

Browse files
thunder95Ligoml
andauthored
【PaddlePaddle Hackathon 2】15、doc for Nanmedian (#4820)
* add nanmedian doc * Update nanmedian_cn.rst Co-authored-by: Ligoml <[email protected]>
1 parent 762bedd commit 25ec3b3

File tree

5 files changed

+36
-0
lines changed

5 files changed

+36
-0
lines changed

docs/api/api_label

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,7 @@ paddle.max .. _api_paddle_max:
190190
paddle.maximum .. _api_paddle_maximum:
191191
paddle.mean .. _api_paddle_mean:
192192
paddle.median .. _api_paddle_median:
193+
paddle.nanmedian .. _api_paddle_nanmedian:
193194
paddle.min .. _api_paddle_min:
194195
paddle.minimum .. _api_paddle_minimum:
195196
paddle.mm .. _api_paddle_mm:

docs/api/paddle/Overview_cn.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ tensor数学操作
8787
" :ref:`paddle.maximum <cn_api_paddle_tensor_maximum>` ", "逐元素对比输入的两个Tensor,并且把各个位置更大的元素保存到返回结果中"
8888
" :ref:`paddle.mean <cn_api_tensor_cn_mean>` ", "沿 axis 计算 x 的平均值"
8989
" :ref:`paddle.median <cn_api_tensor_cn_median>` ", "沿给定的轴 axis 计算 x 中元素的中位数"
90+
" :ref:`paddle.nanmedian <cn_api_tensor_cn_nanmedian>` ", "沿给定的轴 axis 忽略NAN元素计算 x 中元素的中位数"
9091
" :ref:`paddle.min <cn_api_paddle_tensor_min>` ", "对指定维度上的Tensor元素求最小值运算"
9192
" :ref:`paddle.amin <cn_api_paddle_tensor_min>` ", "对指定维度上的Tensor元素求最小值运算"
9293
" :ref:`paddle.minimum <cn_api_paddle_tensor_minimum>` ", "逐元素对比输入的两个Tensor,并且把各个位置更小的元素保存到返回结果中"

docs/api/paddle/Tensor/Overview_en.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,7 @@ Methods
175175
fmax
176176
mean
177177
median
178+
nanmedian
178179
min
179180
minimum
180181
fmin

docs/api/paddle/Tensor_cn.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1472,6 +1472,15 @@ median(axis=None, keepdim=False, name=None)
14721472

14731473
请参考 :ref:`cn_api_tensor_cn_median`
14741474

1475+
nanmedian(axis=None, keepdim=True, name=None)
1476+
:::::::::
1477+
1478+
返回:沿着 ``axis`` 忽略NAN元素进行中位数计算的结果
1479+
1480+
返回类型:Tensor
1481+
1482+
请参考 :ref:`cn_api_tensor_cn_nanmedian`
1483+
14751484
min(axis=None, keepdim=False, name=None)
14761485
:::::::::
14771486

docs/api/paddle/nanmedian_cn.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
.. _cn_api_tensor_cn_nanmedian:
2+
3+
nanmedian
4+
-------------------------------
5+
6+
.. py:function:: paddle.nanmedian(x, axis=None, keepdim=True, name=None)
7+
8+
沿给定的轴 ``axis`` 忽略NAN元素计算 ``x`` 中元素的中位数。
9+
10+
参数
11+
::::::::::
12+
- x (Tensor) - 输入的Tensor,数据类型为:float16、float32、float64、int32、int64。
13+
- axis (None|int|list|tuple,可选) - 指定对 ``x`` 进行计算的轴。``axis`` 可以是int或者int元素的列表。``axis`` 值应该在范围[-D, D)内,D是 ``x`` 的维度。如果 ``axis`` 或者其中的元素值小于0,则等价于 :math:`axis + D` 。如果 ``axis`` 是None,则对 ``x`` 的全部元素计算中位数。默认值为None。
14+
- keepdim (bool,可选) - 是否在输出Tensor中保留减小的维度。如果 ``keepdim`` 为True,则输出Tensor和 ``x`` 具有相同的维度(减少的维度除外,减少的维度的大小为1)。否则,输出Tensor的形状会在 ``axis`` 上进行squeeze操作。默认值为True。
15+
- name (str,可选) - 操作的名称(可选,默认值为None)。更多信息请参见 :ref:`api_guide_Name`。
16+
17+
返回
18+
::::::::::
19+
``Tensor`` ,沿着 ``axis`` 忽略NAN元素进行中位数计算的结果。
20+
21+
代码示例
22+
::::::::::
23+
COPY-FROM: paddle.nanmedian:nanmedian-example
24+

0 commit comments

Comments
 (0)