未验证 提交 43353502 编写于 作者: Z Zhang Ting 提交者: GitHub

Add unique doc (#2457)

* add unique doc
上级 f1569175
.. _api_tensor_cn_unique:
.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
!DO NOT EDIT THIS FILE MANUALLY!
unique
-------------------------------
:doc_source: paddle.fluid.layers.unique
.. _api_tensor_manipulation_unique:
unique
--------
.. autofunction:: paddle.tensor.manipulation.unique
......@@ -5,17 +5,11 @@ unique
.. py:function:: paddle.fluid.layers.unique(x, dtype='int32')
:alias_main: paddle.unique
:alias: paddle.unique,paddle.tensor.unique,paddle.tensor.manipulation.unique
:old_api: paddle.fluid.layers.unique
unique为 ``x`` 返回一个unique张量和一个指向该unique张量的索引。
参数:
- **x** (Variable) - 一个1维输入张量
- **dtype** (np.dtype|core.VarDesc.VarType|str) – 索引张量的类型,int32,int64。
- **x** (Tensor) - 一个1维输入张量
- **dtype** (np.dtype|str) – 索引张量的类型,int32,int64。
返回:元组(out, index)。 ``out`` 为 ``x`` 的指定dtype的unique张量, ``index`` 是一个指向 ``out`` 的索引张量, 用户可以通过该函数来转换原始的 ``x`` 张量的索引。
......
......@@ -2,6 +2,6 @@
unique
-------------------------------
:doc_source: paddle.fluid.layers.unique
:doc_source: paddle.tensor.unique
......@@ -2,6 +2,51 @@
unique
-------------------------------
:doc_source: paddle.fluid.layers.unique
.. py:function:: paddle.unique(x, return_index=False, return_inverse=False, return_counts=False, axis=None, name=None)
返回Tensor按升序排序后的独有元素。
参数:
- **x** (Tensor) - 输入的 `Tensor` ,数据类型为:float32、float64、int32、int64。
- **return_index** (bool, 可选) - 如果为True,则还返回独有元素在输入Tensor中的索引。
- **return_inverse** (bool, 可选) - 如果为True,则还返回输入Tensor的元素对应在独有元素中的索引,该索引可用于重构输入Tensor。
- **return_counts** (bool, 可选) - 如果为True,则还返回每个独有元素在输入Tensor中的个数。
- **axis** (int, 可选) - 指定选取独有元素的轴。默认值为None,将输入平铺为1-D的Tensor后再选取独有元素。
- **name** (str,可选)- 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为None。
返回:
- **out** (Tensor) - 独有元素构成的Tensor,数据类型与输入一致。
- **index** (Tensor, 可选) - 独有元素在输入Tensor中的索引,仅在 `return_index` 为True时返回。
- **inverse** (Tensor, 可选) - 输入Tensor的元素对应在独有元素中的索引,仅在 `return_inverse` 为True时返回。
- **counts** (Tensor, 可选) - 每个独有元素在输入Tensor中的个数,仅在 `return_counts` 为True时返回。
**代码示例**:
.. code-block:: python
import numpy as np
import paddle
paddle.disable_static()
x_data = np.array([2, 3, 3, 1, 5, 3])
x = paddle.to_tensor(x_data)
unique = paddle.unique(x)
np_unique = unique.numpy() # [1 2 3 5]
_, indices, inverse, counts = paddle.unique(x, return_index=True, return_inverse=True, return_counts=True)
np_indices = indices.numpy() # [3 0 1 4]
np_inverse = inverse.numpy() # [1 2 2 0 3 2]
np_counts = counts.numpy() # [1 1 3 1]
x_data = np.array([[2, 1, 3], [3, 0, 1], [2, 1, 3]])
x = paddle.to_tensor(x_data)
unique = paddle.unique(x)
np_unique = unique.numpy() # [0 1 2 3]
unique = paddle.unique(x, axis=0)
np_unique = unique.numpy()
# [[2 1 3]
# [3 0 1]]
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册