Skip to content

Commit

Permalink
Fix API docs bug (#4799)
Browse files Browse the repository at this point in the history
* Update release_note_cn.md

* Update release_note_en.md

* Update release_note_en.md

* Update release_note_cn.md

* Update release_note_cn.md

* Update release_note_en.md

* update API docs

* Update any_cn.rst

* Update full_like_cn.rst

* Update gather_cn.rst

* Update masked_select_cn.rst

* Update max_cn.rst

* Update minimum_cn.rst

* Update trace_cn.rst

Co-authored-by: Ligoml <[email protected]>
  • Loading branch information
TCChenlong and Ligoml authored May 18, 2022
1 parent 57d4b79 commit ad7b300
Show file tree
Hide file tree
Showing 17 changed files with 62 additions and 66 deletions.
2 changes: 1 addition & 1 deletion docs/api/paddle/all_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ all
:::::::::
- **x** (Tensor)- 输入变量为多维Tensor,数据类型为bool。
- **axis** (int | list | tuple ,可选)- 计算逻辑与运算的维度。如果为None,则计算所有元素的逻辑与并返回包含单个元素的Tensor变量,否则必须在 :math:`[−rank(x),rank(x)]` 范围内。如果 :math:`axis [i] <0` ,则维度将变为 :math:`rank+axis[i]` ,默认值为None。
- **keepdim** bool)- 是否在输出Tensor中保留减小的维度。如 keepdim 为true,否则结果张量的维度将比输入张量小,默认值为False
- **keepdim** (bool,可选) - 是否在输出 Tensor 中保留减小的维度。除非 keepdim 为 True,否则输出 Tensor 的维度将比输入 Tensor 小一维,默认值为 False
- **name** (str , 可选)- 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为None。

返回
Expand Down
12 changes: 6 additions & 6 deletions docs/api/paddle/any_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@ any

.. py:function:: paddle.any(x, axis=None, keepdim=False, name=None)
对指定维度上的Tensor元素进行逻辑或运算,并输出相应的计算结果。
对指定维度上的 Tensor 元素进行逻辑或运算,并输出相应的计算结果。

参数
:::::::::
- **x** Tensor)- 输入变量为多维Tensor,数据类型为bool
- **axis** int | list | tuple ,可选- 计算逻辑或运算的维度。如果为None,则计算所有元素的逻辑或并返回包含单个元素的Tensor变量,否则必须在 :math:`[−rank(x),rank(x)]` 范围内。如果 :math:`axis [i] <0` ,则维度将变为 :math:`rank+axis[i]` ,默认值为None
- **keepdim** bool)- 是否在输出Tensor中保留减小的维度。如 keepdim 为true,否则结果张量的维度将比输入张量小,默认值为False
- **name** str , 可选)- 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为None。
- **x** (Tensor) - 输入变量为多维 Tensor,数据类型为 bool
- **axis** (int|list|tuple ,可选) - 计算逻辑或运算的维度。如果为 None,则计算所有元素的逻辑或并返回包含单个元素的 Tensor,否则必须在 :math:`[−rank(x),rank(x)]` 范围内。如果 :math:`axis [i] <0` ,则维度将变为 :math:`rank+axis[i]` ,默认值为 None
- **keepdim** (bool,可选) - 是否在输出 Tensor 中保留输入的维度。除非 keepdim 为 True,否则输出 Tensor 的维度将比输入 Tensor 小一维,默认值为 False
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为None。

返回
:::::::::
Tensor,在指定维度上进行逻辑或运算的Tensor,数据类型和输入数据类型一致。
Tensor,在指定维度上进行逻辑或运算的 Tensor,数据类型和输入数据类型一致。


代码示例
Expand Down
8 changes: 4 additions & 4 deletions docs/api/paddle/argsort_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ argsort
::::::::::::

- **x** (Tensor) - 输入的多维 ``Tensor`` ,支持的数据类型:float32、float64、int16、int32、int64、uint8。
- **axis** (int,可选) - 指定对输入Tensor进行运算的轴, ``axis`` 的有效范围是[-R, R),R是输入 ``x`` 的Rank, ``axis`` 为负时与 ``axis`` +R 等价。默认值为0
- **descending** (bool,可选) - 指定算法排序的方向。如果设置为True,算法按照降序排序。如果设置为False或者不设置,按照升序排序。默认值为False
- **name** (str,可选) – 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为None
- **axis** (int,可选) - 指定对输入 Tensor 进行运算的轴, ``axis`` 的有效范围是 [-R, R),R 是输入 ``x`` 的 Rank, ``axis`` 为负时与 ``axis`` + R 等价。默认值为 -1
- **descending** (bool,可选) - 指定算法排序的方向。如果设置为 True,算法按照降序排序。如果设置为 False 或者不设置,按照升序排序。默认值为 False
- **name** (str,可选) – 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为 None

返回
::::::::::::
Tensor, 排序后索引信息(与 ``x`` 维度信息一致),数据类型为int64
Tensor排序后索引信息(与 ``x`` 维度信息一致),数据类型为 int64


代码示例
Expand Down
8 changes: 4 additions & 4 deletions docs/api/paddle/conj_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,18 @@ conj
.. py:function:: paddle.conj(x, name=None)
是逐元素计算Tensor的共轭运算
是逐元素计算 Tensor 的共轭运算

参数
::::::::::::

- x (Tensor) - 输入的复数值的Tensor,数据类型为:complex64、complex128、float32、float64、int32 或int64
- name (str,可选) - 默认值为None。一般无需用户设置。更多信息请参见 :ref:`api_guide_Name`。
- x (Tensor) - 输入的复数值的 Tensor,数据类型为:complex64、complex128、float32、float64、int32 或 int64
- name (str,可选) - 默认值为 None。一般无需用户设置。更多信息请参见 :ref:`api_guide_Name`。

返回
::::::::::::

- out (Tensor) - 输入的共轭。形状和数据类型与输入一致。如果tensor元素是实数类型,如float32、float64、int32、或者int64,返回值和输入相同。
- out (Tensor) - 输入的共轭。形状和数据类型与输入一致。如果 Tensor 元素是实数类型,如 float32、float64、int32、或者 int64,返回值和输入相同。


代码示例
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/empty_like_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ empty_like
.. py:function:: paddle.empty_like(x, dtype=None, name=None)
根据参数``x`` 的shape和数据类型 ``dtype`` 创建未初始化的Tensor。如果 ``dtype`` 为None,则Tensor的数据类型与 ``x`` 相同。
根据参数 ``x`` 的shape和数据类型 ``dtype`` 创建未初始化的Tensor。如果 ``dtype`` 为None,则Tensor的数据类型与 ``x`` 相同。

参数
::::::::::::
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/equal_all_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ equal_all
.. py:function:: paddle.equal_all(x, y, name=None)
通过比较输入x和y的元素值,返回一个bool类型的数值。如果所有相同位置的元素相同返回True,否则返回False
返回 x==y 的布尔值,如果所有相同位置的元素相同返回 True,否则返回 False

**注:输出的结果不返回梯度。**

Expand Down
6 changes: 3 additions & 3 deletions docs/api/paddle/expand_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ expand
根据 ``shape`` 指定的形状扩展 ``x`` ,扩展后, ``x`` 的形状和 ``shape`` 指定的形状一致。

``x`` 的维数和 ``shape`` 的元素数应小于等于6,并且 ``shape`` 中的元素数应该大于等于 ``x`` 的维数。扩展的维度的维度值应该为1
``x`` 的维数和 ``shape`` 的元素数应小于等于6,并且 ``shape`` 中的元素数应该大于等于 ``x`` 的维数。扩展的维度的维度值应该为 1

参数
:::::::::
- x (Tensor) - 输入的Tensor,数据类型为:bool、float32、float64、int32或int64。
- shape (tuple|list|Tensor) - 给定输入 ``x`` 扩展后的形状,若 ``shape`` 为list或者tuple,则其中的元素值应该为整数或者1-D Tensor,若 ``shape`` 类型为Tensor,则其应该为1-D Tensor。
- x (Tensor) - 输入的 Tensor,数据类型为:bool、float32、float64、int32或int64。
- shape (tuple|list|Tensor) - 给定输入 ``x`` 扩展后的形状若 ``shape`` 为 list 或者 tuple,则其中的元素值应该为整数或者 1-D Tensor,若 ``shape`` 类型为 Tensor,则其应该为 1-D Tensor。
- name (str,可选) - 操作的名称(可选,默认值为None)。更多信息请参见 :ref:`api_guide_Name` 。

返回
Expand Down
11 changes: 5 additions & 6 deletions docs/api/paddle/full_like_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,26 @@ full_like
.. py:function:: paddle.full_like(x, fill_value, dtype=None, name=None)
创建一个和 ``x`` 具有相同的形状并且数据类型为 ``dtype`` 的Tensor,其中元素值均为 ``fill_value``,当 ``dtype`` 为None的时候,Tensor数据类型和输入 ``x`` 相同。
创建一个和 ``x`` 具有相同的形状并且数据类型为 ``dtype`` 的 Tensor,其中元素值均为 ``fill_value``,当 ``dtype`` 为 None 的时候,Tensor 数据类型和输入 ``x`` 相同。

参数
::::::::::::

- **x** (Tensor) – 输入Tensor,输出Tensor和x具有相同的形状,x的数据类型可以是bool、float16、float32、float64、int32、int64。
- **x** (Tensor) – 输入 Tensor,输出 Tensor 和 x 具有相同的形状,x的数据类型可以是 bool、float16、float32、float64、int32、int64。
- **fill_value** (bool|float|int) - 用于初始化输出张量的常量数据的值。注意:该参数不可超过输出变量数据类型的表示范围。
- **dtype** np.dtype|str,可选- 输出变量的数据类型。若参数为None,则输出变量的数据类型和输入变量相同,默认值为None
- **name** str,可选- 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为None
- **dtype** (np.dtype|str,可选) - 输出变量的数据类型。若参数为None,则输出变量的数据类型和输入变量相同,默认值为 None
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为 None

返回
::::::::::::
返回一个存储结果的Tensor,数据类型和dtype相同
返回一个根据 ``x`` 、``fill_value`` 、 ``dtype`` 创建的 Tensor


**代码示例**:

.. code-block:: python
import paddle
import numpy as np
input = paddle.full(shape=[2, 3], fill_value=0.0, dtype='float32', name='input')
output = paddle.full_like(input, 2.0)
Expand Down
8 changes: 5 additions & 3 deletions docs/api/paddle/gather_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ gather

.. code-block:: text
Given:
X = [[1, 2],
[3, 4],
[5, 6]]
Expand All @@ -26,12 +28,12 @@ gather
::::::::::::
- **x** (Tensor) - 输入 Tensor,秩 ``rank >= 1`` ,支持的数据类型包括 int32、int64、float32、float64 和 uint8 (CPU)、float16(GPU) 。
- **index** (Tensor) - 索引 Tensor,秩 ``rank = 1``,数据类型为 int32 或 int64。
- **axis** (Tensor) - 指定index 获取输入的维度, ``axis`` 的类型可以是int或者Tensor,当 ``axis`` 为Tensor的时候其数据类型为int32 或者int64
- **name** str,可选- 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为None
- **axis** (Tensor) - 指定 index 获取输入的维度, ``axis`` 的类型可以是 int 或者 Tensor,当 ``axis`` 为 Tensor 的时候其数据类型为 int32 或者 int64
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为 None

返回
::::::::::::
和输入的秩相同的输出Tensor
和输入的秩相同的输出 Tensor


代码示例
Expand Down
9 changes: 3 additions & 6 deletions docs/api/paddle/log1p_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,7 @@ log1p
.. py:function:: paddle.log1p(x, name=None)
计算Log1p(加一的自然对数)结果。
计算 Log1p(自然对数 + 1)结果。

.. math::
\\Out=ln(x+1)\\
Expand All @@ -18,12 +15,12 @@ log1p
参数
::::::::::::

- **x** (Tensor) – 指定输入为一个多维的Tensor。数据类型为float32,float64。
- **x** (Tensor) – 输入为一个多维的 Tensor,数据类型为 float32,float64。
- **name** (str,可选) – 该参数供开发人员打印调试信息时使用,具体用法请参见 :ref:`api_guide_Name` ,默认值为None。

返回
::::::::::::
Tensor, Log1p算子自然对数输出,数据类型,形状为输入一致
计算 ``x`` 的自然对数 + 1后的 Tensor,数据类型,形状与 ``x`` 一致。

代码示例
::::::::::::
Expand Down
10 changes: 5 additions & 5 deletions docs/api/paddle/masked_select_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,18 @@ masked_select
返回一个1-D 的Tensor, Tensor的值是根据 ``mask`` 对输入 ``x`` 进行选择的, ``mask`` 的数据类型是bool
返回一个1-D 的 Tensor,Tensor 的值是根据 ``mask`` 对输入 ``x`` 进行选择的, ``mask`` 的数据类型是 bool

参数
::::::::::::

- **x** (Tensor) - 输入Tensor, 数据类型为float32, float64,int32 或者int64
- **mask** (Tensor) - 用于索引的二进制掩码的Tensor,数据类型维bool
- **name** str,可选- 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为None
- **x** (Tensor) - 输入Tensor, 数据类型为 float32,float64,int32 或者 int64
- **mask** (Tensor) - 用于索引的二进制掩码的 Tensor,数据类型为 bool
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为 None

返回
::::::::::::
返回一个根据 ``mask`` 选择的的Tensor
返回一个根据 ``mask`` 选择的的 Tensor。


代码示例
Expand Down
13 changes: 6 additions & 7 deletions docs/api/paddle/max_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,22 @@ max
.. py:function:: paddle.max(x, axis=None, keepdim=False, name=None)
对指定维度上的Tensor元素求最大值运算,并输出相应的计算结果。
对指定维度上的 Tensor 元素求最大值运算,并输出相应的计算结果。

.. note::

对输入有多个最大值的情况下,max 将梯度完整传回到最大值对应的位置,amax 会将梯度平均传回到最大值对应的位置

参数
:::::::::
- **x** (Tensor)- Tensor,支持数据类型为float32,float64,int32,int64。
- **axis** (list | int | tuple,可选)- 求最大值运算的维度。如果为None,则计算所有元素的最大值并返回包含单个元素的Tensor变量,否则必须在 :math:`[-x.ndim, x.ndim]` 范围内。如果 :math:`axis[i] <0` ,则维度将变为 :math:`x.ndim+axis[i]` ,默认值为None。
- **keepdim** (bool)- 是否在输出Tensor中保留减小的维度。如果keepdim 为 False,结果张量的维度将比输入张量的小,默认值为False。
- **name** (str, 可选)- 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为None。

- **x** (Tensor) - Tensor,支持数据类型为 float32,float64,int32,int64。
- **axis** (list|int|tuple,可选) - 求最大值运算的维度。如果为 None,则计算所有元素的最大值并返回包含单个元素的 Tensor 变量,否则必须在 :math:`[-x.ndim, x.ndim]` 范围内。如果 :math:`axis[i] <0` ,则维度将变为 :math:`x.ndim+axis[i]` ,默认值为 None。
- **keepdim** (bool,可选) - 是否在输出 Tensor 中保留输入的维度。除非 keepdim 为 True,否则输出 Tensor 的维度将比输入 Tensor 小一维,默认值为 False。
- **name** (str, 可选) - 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为 None。

返回
:::::::::
Tensor, 在指定axis上进行求最大值运算的Tensor,数据类型和输入数据类型一致。
Tensor,在指定 axis 上进行求最大值运算的 Tensor,数据类型和输入数据类型一致。


代码示例
Expand Down
12 changes: 6 additions & 6 deletions docs/api/paddle/minimum_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,25 @@ minimum
.. py:function:: paddle.minimum(x, y, name=None)
逐元素对比输入的两个Tensor,并且把各个位置更小的元素保存到返回结果中。
逐元素对比输入的两个 Tensor,并且把各个位置更小的元素保存到返回结果中。

等式是:

.. math::
out = min(x, y)
.. note::
``paddle.minimum`` 遵守broadcasting,如您想了解更多,请参见 :ref:`cn_user_guide_broadcasting` 。
``paddle.minimum`` 遵守 broadcasting,如你想了解更多,请参见 :ref:`cn_user_guide_broadcasting` 。

参数
:::::::::
- **x** Tensor)- 输入的Tensor。数据类型为 ``float32`` 、 ``float64`` 、 ``int32`` 或 ``int64`` 。
- **y** Tensor)- 输入的Tensor。数据类型为 ``float32`` 、 ``float64`` 、 ``int32`` 或 ``int64`` 。
- **name** str, 可选)- 操作的名称(可选,默认值为None)。更多信息请参见 :ref:`api_guide_Name`。
- **x** (Tensor) - 输入的 Tensor。数据类型为 ``float32`` 、 ``float64`` 、 ``int32`` 或 ``int64`` 。
- **y** (Tensor) - 输入的 Tensor。数据类型为 ``float32`` 、 ``float64`` 、 ``int32`` 或 ``int64`` 。
- **name** (str,可选) - 操作的名称(可选,默认值为 None)。更多信息请参见 :ref:`api_guide_Name`。

返回
:::::::::
``Tensor``,存储运算后的结果。如果x和y有不同的shape且是可以广播的,返回Tensor的shape是x和y经过广播后的shape。如果x和y有相同的shape,返回Tensor的shape与x,y相同
``Tensor``。 如果 x 和 y 有不同的 shape 且是可以广播的,返回 Tensor 的 shape 是 x 和 y 经过广播后的 shape。如果 x 和 y 有相同的 shape,返回 Tensor 的 shape 与 x,y 相同


代码示例
Expand Down
10 changes: 5 additions & 5 deletions docs/api/paddle/ones_like_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,18 @@ ones_like
.. py:function:: paddle.ones_like(x, dtype=None, name=None)
返回一个和输入参数 ``x`` 具有相同形状的数值都为1的Tensor,数据类型为 ``dtype`` 或者和 ``x`` 相同。
返回一个和输入参数 ``x`` 具有相同形状的数值都为1的 Tensor,数据类型为 ``dtype`` 或者和 ``x`` 相同,如果 ``dtype`` 为None,则输出Tensor的数据类型与 ``x`` 相同。

参数
::::::::::
- **x** (Tensor) – 输入的Tensor,数据类型可以是bool,float16, float32,float64,int32,int64。输出Tensor的形状和 ``x`` 相同。如果 ``dtype`` 为None,则输出Tensor的数据类型与 ``x`` 相同
- **dtype** (str|np.dtype, 可选) - 输出Tensor的数据类型,支持bool,float16, float32,float64,int32,int64。当该参数值为None时, 输出Tensor的数据类型与 ``x`` 相同。默认值为None.
- **name** (str, 可选) - 输出的名字。一般无需设置,默认值为None。该参数供开发人员打印调试信息时使用,具体用法请参见 :ref:`api_guide_Name` 。
- **x** (Tensor) – 输入的Tensor,数据类型可以是 bool,float16float32,float64,int32,int64。
- **dtype** (str|np.dtype 可选) - 输出 Tensor 的数据类型,支持 bool,float16, float32,float64,int32,int64。当该参数值为 None 时, 输出 Tensor 的数据类型与 ``x`` 相同。默认值为 None。
- **name** (str 可选) - 输出的名字。一般无需设置,默认值为 None。该参数供开发人员打印调试信息时使用,具体用法请参见 :ref:`api_guide_Name` 。

返回
::::::::::

Tensor:和 ``x`` 具有相同形状的数值都为1的Tensor,数据类型为 ``dtype`` 或者和 ``x`` 相同。
Tensor:和 ``x`` 具有相同形状的数值都为1的 Tensor,数据类型为 ``dtype`` 或者和 ``x`` 相同。


代码示例
Expand Down
8 changes: 4 additions & 4 deletions docs/api/paddle/real_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@ real

.. py:function:: paddle.real(x, name=None)
返回一个包含输入复数Tensor的实部数值的新Tensor
返回一个包含输入复数 Tensor 的实部数值的新 Tensor

参数
::::::::::::

- **x** (Tensor) - 输入Tensor,其数据类型可以为complex64或complex128
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为None
- **x** (Tensor) - 输入 Tensor,其数据类型可以为 complex64 或 complex128
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为 None

返回
::::::::::::
Tensor,包含原复数Tensor的实部数值
Tensor,包含原复数 Tensor 的实部数值

代码示例
::::::::::::
Expand Down
5 changes: 2 additions & 3 deletions docs/api/paddle/sign_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,8 @@ sign

参数
::::::::::::

- **x** (Tensor) – 进行正负值判断的多维Tensor,数据类型为 float16、float32 或 float64。
- **name** (str,可选) – 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为None。
- **x** (Tensor) – 进行正负值判断的多维 Tensor,数据类型为 float16, float32 或 float64。
- **name** (str,可选) – 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为 None。

返回
::::::::::::
Expand Down
Loading

0 comments on commit ad7b300

Please sign in to comment.