Skip to content

Commit

Permalink
【PaddlePaddle Hackathon 3】5 新增 API bucketize (#5089)
Browse files Browse the repository at this point in the history
* 更新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
  • Loading branch information
Li-fAngyU committed Aug 4, 2022
1 parent bc1e3c9 commit aeee780
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 2 deletions.
1 change: 1 addition & 0 deletions docs/api/api_label
Expand Up @@ -127,6 +127,7 @@ paddle.atan .. _api_paddle_atan:
paddle.bmm .. _api_paddle_bmm:
paddle.broadcast_shape .. _api_paddle_broadcast_shape:
paddle.broadcast_to .. _api_paddle_broadcast_to:
paddle.bucketize .. _api_paddle_bucketize:
paddle.cast .. _api_paddle_cast:
paddle.ceil .. _api_paddle_ceil:
paddle.Tensor.ceil_ .. _api_paddle_Tensor_ceil_:
Expand Down
1 change: 1 addition & 0 deletions docs/api/paddle/Overview_cn.rst
Expand Up @@ -220,6 +220,7 @@ tensor元素查找相关
" :ref:`paddle.nonzero <cn_api_tensor_search_nonzero>` ", "返回输入 x 中非零元素的坐标"
" :ref:`paddle.sort <cn_api_tensor_sort>` ", "对输入变量沿给定轴进行排序,输出排序好的数据,其维度和输入相同"
" :ref:`paddle.searchsorted <cn_api_tensor_searchsorted>` ", "将根据给定的 values 在 sorted_sequence 的最后一个维度查找合适的索引"
" :ref:`paddle.bucketize <cn_api_tensor_bucketize>` ", "将根据给定的一维Tensor sorted_sequence 返回输入 x 对应的桶索引。"
" :ref:`paddle.topk <cn_api_tensor_cn_topk>` ", "沿着可选的 axis 查找topk最大或者最小的结果和结果所在的索引信息"
" :ref:`paddle.where <cn_api_tensor_where>` ", "该OP返回一个根据输入 condition, 选择 x 或 y 的元素组成的多维 Tensor"

Expand Down
1 change: 1 addition & 0 deletions docs/api/paddle/Tensor/Overview_en.rst
Expand Up @@ -88,6 +88,7 @@ Methods
broadcast_shape
broadcast_tensors
broadcast_to
bucketize
cast
ceil
ceil_
Expand Down
8 changes: 8 additions & 0 deletions docs/api/paddle/Tensor_cn.rst
Expand Up @@ -468,6 +468,14 @@ broadcast_to(shape, name=None)

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

bucketize(sorted_sequence, out_int32=False, right=False, name=None)
:::::::::
返回: 根据给定的一维Tensor ``sorted_sequence`` ,输入 ``x`` 对应的桶索引。

返回类型:Tensor。

请参考 :ref:`cn_api_tensor_bucketize`

cast(dtype)
:::::::::

Expand Down
24 changes: 24 additions & 0 deletions docs/api/paddle/bucketize_cn.rst
@@ -0,0 +1,24 @@
.. _cn_api_tensor_bucketize:

paddle.bucketize
-------------------------------

.. py:function:: paddle.bucketize(x, sorted_sequence, out_int32=False, right=False, name=None)
将根据给定的一维Tensor ``sorted_sequence`` 返回输入 ``x`` 对应的桶索引。

参数
::::::::::
- **x** (Tensor) - 输入的N维Tensor,支持的数据类型:int32、int64、float32、float64。
- **sorted_sequence** (Tensor) - 输入的一维Tensor,支持的数据类型:int32、int64、float32、float64。该Tensor的数值在其最后一个维度递增。
- **out_int32** (bool,可选) - 输出的数据类型支持int32、int64。默认值为False,表示默认的输出数据类型为int64。
- **right** (bool,可选) - 根据给定 ``x`` 在 ``sorted_sequence`` 查找对应的上边界或下边界。如果 ``sorted_sequence``的值为nan或inf,则返回最内层维度的大小。默认值为False,表示在 ``sorted_sequence`` 的查找给定 ``x`` 的下边界。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

返回
::::::::::
Tensor(与 ``x`` 维度相同),如果参数 ``out_int32`` 为False,则返回数据类型为int64的Tensor,否则将返回int32的Tensor。

代码示例
::::::::::

COPY-FROM: paddle.bucketize
4 changes: 2 additions & 2 deletions docs/api/paddle/searchsorted_cn.rst
Expand Up @@ -12,12 +12,12 @@ searchsorted
- **sorted_sequence** (Tensor) - 输入的N维或一维Tensor,支持的数据类型:float32、float64、int32、int64。该Tensor的数值在其最后一个维度递增。
- **values** (Tensor) - 输入的N维Tensor,支持的数据类型:float32、float64、int32、int64。
- **out_int32** (bool,可选) - 输出的数据类型支持int32、int64。默认值为False,表示默认的输出数据类型为int64。
- **right** (bool,可选) - 根据给定 ``values`` 在 ``sorted_sequence`` 查找对应的上边界或下边界。默认值为False,表示在 ``sorted_sequence`` 的查找给定 ``values`` 的下边界。
- **right** (bool,可选) - 根据给定 ``values`` 在 ``sorted_sequence`` 查找对应的上边界或下边界。如果 ``sorted_sequence``的值为nan或inf,则返回最内层维度的大小。默认值为False,表示在 ``sorted_sequence`` 的查找给定 ``values`` 的下边界。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

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



Expand Down

0 comments on commit aeee780

Please sign in to comment.