Skip to content

Commit ad7b300

Browse files
TCChenlongLigoml
andauthored
Fix API docs bug (#4799)
* 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]>
1 parent 57d4b79 commit ad7b300

17 files changed

+62
-66
lines changed

docs/api/paddle/all_cn.rst

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

1717
返回

docs/api/paddle/any_cn.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,18 @@ any
55

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

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

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

2121

2222
代码示例

docs/api/paddle/argsort_cn.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ argsort
1313
::::::::::::
1414

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

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

2424

2525
代码示例

docs/api/paddle/conj_cn.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@ conj
66
.. py:function:: paddle.conj(x, name=None)
77
88
9-
是逐元素计算Tensor的共轭运算
9+
是逐元素计算 Tensor 的共轭运算
1010

1111
参数
1212
::::::::::::
1313

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

1717
返回
1818
::::::::::::
1919

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

2222

2323
代码示例

docs/api/paddle/empty_like_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ empty_like
66
.. py:function:: paddle.empty_like(x, dtype=None, name=None)
77
88
9-
根据参数``x`` 的shape和数据类型 ``dtype`` 创建未初始化的Tensor。如果 ``dtype`` 为None,则Tensor的数据类型与 ``x`` 相同。
9+
根据参数 ``x`` 的shape和数据类型 ``dtype`` 创建未初始化的Tensor。如果 ``dtype`` 为None,则Tensor的数据类型与 ``x`` 相同。
1010

1111
参数
1212
::::::::::::

docs/api/paddle/equal_all_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ equal_all
66
.. py:function:: paddle.equal_all(x, y, name=None)
77
88
9-
通过比较输入x和y的元素值,返回一个bool类型的数值。如果所有相同位置的元素相同返回True,否则返回False
9+
返回 x==y 的布尔值,如果所有相同位置的元素相同返回 True,否则返回 False
1010

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

docs/api/paddle/expand_cn.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ expand
77
88
根据 ``shape`` 指定的形状扩展 ``x`` ,扩展后, ``x`` 的形状和 ``shape`` 指定的形状一致。
99

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

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

1818
返回

docs/api/paddle/full_like_cn.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,26 @@ full_like
66
.. py:function:: paddle.full_like(x, fill_value, dtype=None, name=None)
77
88
9-
创建一个和 ``x`` 具有相同的形状并且数据类型为 ``dtype`` 的Tensor,其中元素值均为 ``fill_value``,当 ``dtype`` 为None的时候,Tensor数据类型和输入 ``x`` 相同。
9+
创建一个和 ``x`` 具有相同的形状并且数据类型为 ``dtype`` 的 Tensor,其中元素值均为 ``fill_value``,当 ``dtype`` 为 None 的时候,Tensor 数据类型和输入 ``x`` 相同。
1010

1111
参数
1212
::::::::::::
1313

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

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

2323

2424
**代码示例**:
2525

2626
.. code-block:: python
2727
2828
import paddle
29-
import numpy as np
3029
3130
input = paddle.full(shape=[2, 3], fill_value=0.0, dtype='float32', name='input')
3231
output = paddle.full_like(input, 2.0)

docs/api/paddle/gather_cn.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ gather
99

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

3234
返回
3335
::::::::::::
34-
和输入的秩相同的输出Tensor
36+
和输入的秩相同的输出 Tensor
3537

3638

3739
代码示例

docs/api/paddle/log1p_cn.rst

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,7 @@ log1p
66
.. py:function:: paddle.log1p(x, name=None)
77
88
9-
10-
11-
12-
计算Log1p(加一的自然对数)结果。
9+
计算 Log1p(自然对数 + 1)结果。
1310

1411
.. math::
1512
\\Out=ln(x+1)\\
@@ -18,12 +15,12 @@ log1p
1815
参数
1916
::::::::::::
2017

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

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

2825
代码示例
2926
::::::::::::

0 commit comments

Comments
 (0)