Skip to content

Commit aeee780

Browse files
authored
【PaddlePaddle Hackathon 3】5 新增 API bucketize (#5089)
* 更新paddle.bucketize的中文文档 * 更新paddle.bucketize API 文档说明 * Update buckiteze_cn.rst * Update Tensor_cn.rst * 更新bucketize API 文档,并修改searchsorted_cn.rst 文档说明 * 更新bucketize API 文档 和api_label,并修改searchsorted_cn.rst 文档说明 * Update api_label * Update bucketize_cn.rst
1 parent bc1e3c9 commit aeee780

File tree

6 files changed

+37
-2
lines changed

6 files changed

+37
-2
lines changed

docs/api/api_label

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@ paddle.atan .. _api_paddle_atan:
127127
paddle.bmm .. _api_paddle_bmm:
128128
paddle.broadcast_shape .. _api_paddle_broadcast_shape:
129129
paddle.broadcast_to .. _api_paddle_broadcast_to:
130+
paddle.bucketize .. _api_paddle_bucketize:
130131
paddle.cast .. _api_paddle_cast:
131132
paddle.ceil .. _api_paddle_ceil:
132133
paddle.Tensor.ceil_ .. _api_paddle_Tensor_ceil_:

docs/api/paddle/Overview_cn.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,7 @@ tensor元素查找相关
220220
" :ref:`paddle.nonzero <cn_api_tensor_search_nonzero>` ", "返回输入 x 中非零元素的坐标"
221221
" :ref:`paddle.sort <cn_api_tensor_sort>` ", "对输入变量沿给定轴进行排序,输出排序好的数据,其维度和输入相同"
222222
" :ref:`paddle.searchsorted <cn_api_tensor_searchsorted>` ", "将根据给定的 values 在 sorted_sequence 的最后一个维度查找合适的索引"
223+
" :ref:`paddle.bucketize <cn_api_tensor_bucketize>` ", "将根据给定的一维Tensor sorted_sequence 返回输入 x 对应的桶索引。"
223224
" :ref:`paddle.topk <cn_api_tensor_cn_topk>` ", "沿着可选的 axis 查找topk最大或者最小的结果和结果所在的索引信息"
224225
" :ref:`paddle.where <cn_api_tensor_where>` ", "该OP返回一个根据输入 condition, 选择 x 或 y 的元素组成的多维 Tensor"
225226

docs/api/paddle/Tensor/Overview_en.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@ Methods
8888
broadcast_shape
8989
broadcast_tensors
9090
broadcast_to
91+
bucketize
9192
cast
9293
ceil
9394
ceil_

docs/api/paddle/Tensor_cn.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -468,6 +468,14 @@ broadcast_to(shape, name=None)
468468

469469
请参考 :ref:`cn_api_tensor_expand` ,API功能相同。
470470

471+
bucketize(sorted_sequence, out_int32=False, right=False, name=None)
472+
:::::::::
473+
返回: 根据给定的一维Tensor ``sorted_sequence`` ,输入 ``x`` 对应的桶索引。
474+
475+
返回类型:Tensor。
476+
477+
请参考 :ref:`cn_api_tensor_bucketize`
478+
471479
cast(dtype)
472480
:::::::::
473481

docs/api/paddle/bucketize_cn.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
.. _cn_api_tensor_bucketize:
2+
3+
paddle.bucketize
4+
-------------------------------
5+
6+
.. py:function:: paddle.bucketize(x, sorted_sequence, out_int32=False, right=False, name=None)
7+
将根据给定的一维Tensor ``sorted_sequence`` 返回输入 ``x`` 对应的桶索引。
8+
9+
参数
10+
::::::::::
11+
- **x** (Tensor) - 输入的N维Tensor,支持的数据类型:int32、int64、float32、float64。
12+
- **sorted_sequence** (Tensor) - 输入的一维Tensor,支持的数据类型:int32、int64、float32、float64。该Tensor的数值在其最后一个维度递增。
13+
- **out_int32** (bool,可选) - 输出的数据类型支持int32、int64。默认值为False,表示默认的输出数据类型为int64。
14+
- **right** (bool,可选) - 根据给定 ``x`` 在 ``sorted_sequence`` 查找对应的上边界或下边界。如果 ``sorted_sequence``的值为nan或inf,则返回最内层维度的大小。默认值为False,表示在 ``sorted_sequence`` 的查找给定 ``x`` 的下边界。
15+
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
16+
17+
返回
18+
::::::::::
19+
Tensor(与 ``x`` 维度相同),如果参数 ``out_int32`` 为False,则返回数据类型为int64的Tensor,否则将返回int32的Tensor。
20+
21+
代码示例
22+
::::::::::
23+
24+
COPY-FROM: paddle.bucketize

docs/api/paddle/searchsorted_cn.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@ searchsorted
1212
- **sorted_sequence** (Tensor) - 输入的N维或一维Tensor,支持的数据类型:float32、float64、int32、int64。该Tensor的数值在其最后一个维度递增。
1313
- **values** (Tensor) - 输入的N维Tensor,支持的数据类型:float32、float64、int32、int64。
1414
- **out_int32** (bool,可选) - 输出的数据类型支持int32、int64。默认值为False,表示默认的输出数据类型为int64。
15-
- **right** (bool,可选) - 根据给定 ``values`` 在 ``sorted_sequence`` 查找对应的上边界或下边界。默认值为False,表示在 ``sorted_sequence`` 的查找给定 ``values`` 的下边界。
15+
- **right** (bool,可选) - 根据给定 ``values`` 在 ``sorted_sequence`` 查找对应的上边界或下边界。如果 ``sorted_sequence``的值为nan或inf,则返回最内层维度的大小。默认值为False,表示在 ``sorted_sequence`` 的查找给定 ``values`` 的下边界。
1616
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
1717

1818
返回
1919
::::::::
20-
Tensor(与 ``values`` 维度相同),如果参数 ``out_int32`` 为False,则返回数据类型为int32的Tensor,否则将返回int64的Tensor
20+
Tensor(与 ``values`` 维度相同),如果参数 ``out_int32`` 为False,则返回数据类型为int64的Tensor,否则将返回int32的Tensor
2121

2222

2323

0 commit comments

Comments
 (0)