Skip to content

Commit 77d187b

Browse files
authored
【Hackathon 6th No.10】Add isin API to Paddle (#6661)
1 parent a018be9 commit 77d187b

File tree

4 files changed

+36
-0
lines changed

4 files changed

+36
-0
lines changed

docs/api/paddle/Overview_cn.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,7 @@ tensor 逻辑操作
239239
" :ref:`paddle.is_empty <cn_api_paddle_is_empty>` ", "测试变量是否为空"
240240
" :ref:`paddle.is_tensor <cn_api_paddle_is_tensor>` ", "用来测试输入对象是否是 paddle.Tensor"
241241
" :ref:`paddle.isfinite <cn_api_paddle_isfinite>` ", "返回输入 tensor 的每一个值是否为 Finite(既非 +/-INF 也非 +/-NaN )"
242+
" :ref:`paddle.isin <cn_api_paddle_isin>` ", "测试输入 x 的每一个值是否在 test_x 中"
242243
" :ref:`paddle.isinf <cn_api_paddle_isinf>` ", "返回输入 tensor 的每一个值是否为 +/-INF"
243244
" :ref:`paddle.isnan <cn_api_paddle_isnan>` ", "返回输入 tensor 的每一个值是否为 +/-NaN"
244245
" :ref:`paddle.isposinf <cn_api_paddle_isposinf>` ", "返回输入 tensor 的每一个值是否为 +INF"

docs/api/paddle/Tensor/Overview_en.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,7 @@ Methods
153153
is_empty
154154
is_tensor
155155
isfinite
156+
isin
156157
isinf
157158
isnan
158159
isneginf

docs/api/paddle/Tensor_cn.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1479,6 +1479,15 @@ isfinite(name=None)
14791479

14801480
请参考 :ref:`cn_api_paddle_isfinite`
14811481

1482+
isin(test_x, assume_unique=False, invert=False, name=None)
1483+
:::::::::
1484+
1485+
返回:计算后的 Tensor
1486+
1487+
返回类型:Tensor
1488+
1489+
请参考 :ref:`cn_api_paddle_isin`
1490+
14821491
isinf(name=None)
14831492
:::::::::
14841493

docs/api/paddle/isin_cn.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
.. _cn_api_paddle_isin:
2+
3+
isin
4+
-----------------------------
5+
6+
.. py:function:: paddle.isin(x, test_x, assume_unique=False, invert=False, name=None)
7+
8+
检验 ``x`` 中的每一个元素是否在 ``test_x`` 中。
9+
10+
参数
11+
:::::::::
12+
- **x** (Tensor) - 输入的 tensor,数据类型为:'bfloat16', 'float16', 'float32', 'float64', 'int32', 'int64'。
13+
- **test_x** (Tensor) - 用于检验的 tensor,数据类型为:'bfloat16', 'float16', 'float32', 'float64', 'int32', 'int64'。
14+
- **assume_unique** (bool,可选) - 如果设置为 True,表示 ``x`` 与 ``test_x`` 的元素均是唯一的,这种情况可以提升计算的速度。默认值为 False。
15+
- **invert** (bool,可选) - 是否输出反转的结果。如果为 True,表示将结果反转。默认值为 False。
16+
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
17+
18+
返回
19+
:::::::::
20+
``Tensor``,输出的 tensor 与输入 ``x`` 形状相同。
21+
22+
代码示例
23+
:::::::::
24+
25+
COPY-FROM: paddle.isin

0 commit comments

Comments
 (0)