Skip to content

Commit e06897c

Browse files
authored
[API compatibility] Update 7 API (#7398)
* [API compatibility] Update 7 API Docs * fix codestyle * fix
1 parent 1e920b1 commit e06897c

File tree

7 files changed

+43
-14
lines changed

7 files changed

+43
-14
lines changed

docs/api/paddle/any_cn.rst

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,24 @@
33
any
44
-------------------------------
55

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

10+
.. note::
11+
别名支持: 参数名 ``input`` 可替代 ``x``,参数名 ``dim`` 可替代 ``axis``,如 ``any(input=tensor_x, dim=1, ...)`` 等价于 ``any(x=tensor_x, axis=1, ...)``。
12+
1013
参数
1114
:::::::::
12-
- **x** (Tensor) - 输入变量为多维 Tensor,数据类型为 bool、float32、float64、int32、int64。
13-
- **axis** (int|list|tuple,可选) - 计算逻辑或运算的维度。如果为 None,则计算所有元素的逻辑或并返回包含单个元素的 Tensor,否则必须在 :math:`[−rank(x),rank(x)]` 范围内。如果 :math:`axis [i] <0`,则维度将变为 :math:`rank+axis[i]`,默认值为 None。
15+
- **x** (Tensor) - 输入变量为多维 Tensor,数据类型为 bool、float32、float64、int32、int64。别名: ``input``。
16+
- **axis** (int|list|tuple,可选) - 计算逻辑或运算的维度。如果为 None,则计算所有元素的逻辑或并返回包含单个元素的 Tensor,否则必须在 :math:`[−rank(x),rank(x)]` 范围内。如果 :math:`axis [i] <0`,则维度将变为 :math:`rank+axis[i]`,默认值为 None。别名: ``dim``。
1417
- **keepdim** (bool,可选) - 是否在输出 Tensor 中保留输入的维度。除非 keepdim 为 True,否则输出 Tensor 的维度将比输入 Tensor 小一维,默认值为 False。
1518
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
1619

20+
关键字参数
21+
::::::::::::
22+
- **out** (Tensor,可选) - 输出 Tensor。默认值为 None。
23+
1724
返回
1825
:::::::::
1926
Tensor,在指定维度上进行逻辑或运算的 Tensor,数据类型和输入数据类型一致。

docs/api/paddle/argsort_cn.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,14 @@ argsort
88
99
对输入变量沿给定轴进行排序,输出排序好的数据的相应索引,其维度和输入相同。默认升序排列,如果需要降序排列设置 ``descending=True`` 。
1010

11+
.. note::
12+
别名支持: 参数名 ``input`` 可替代 ``x``,参数名 ``dim`` 可替代 ``axis``,如 ``argsort(input=tensor_x, dim=1, ...)`` 等价于 ``argsort(x=tensor_x, axis=1, ...)``。
1113

1214
参数
1315
::::::::::::
1416

15-
- **x** (Tensor) - 输入的多维 ``Tensor``,支持的数据类型:float16、bfloat16、float32、float64、int16、int32、int64、uint8。
16-
- **axis** (int,可选) - 指定对输入 Tensor 进行运算的轴,``axis`` 的有效范围是 [-R, R),R 是输入 ``x`` 的 Rank, ``axis`` 为负时与 ``axis`` + R 等价。默认值为 -1。
17+
- **x** (Tensor) - 输入的多维 ``Tensor``,支持的数据类型:float16、bfloat16、float32、float64、int16、int32、int64、uint8。别名: ``input``。
18+
- **axis** (int,可选) - 指定对输入 Tensor 进行运算的轴,``axis`` 的有效范围是 [-R, R),R 是输入 ``x`` 的 Rank, ``axis`` 为负时与 ``axis`` + R 等价。默认值为 -1。别名: ``dim``。
1719
- **descending** (bool,可选) - 指定算法排序的方向。如果设置为 True,算法按照降序排序。如果设置为 False 或者不设置,按照升序排序。默认值为 False。
1820
- **stable** (bool,可选) - 是否使用稳定排序算法。若设置为 True,则使用稳定排序算法,即相同元素的顺序在排序结果中将会被保留。默认值为 False,此时的算法不一定是稳定排序算法。
1921
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

docs/api/paddle/chunk_cn.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,15 @@ chunk
77
88
将输入 Tensor 分割成多个子 Tensor。
99

10+
.. note::
11+
别名支持: 参数名 ``input`` 可替代 ``x``,参数名 ``dim`` 可替代 ``axis``,如 ``chunk(input=tensor_x, chunks=2, dim=1)`` 等价于 ``chunk(x=tensor_x, chunks=2, axis=1)``。
12+
1013
参数
1114
:::::::::
1215

13-
- **x** (Tensor) - 输入变量,数据类型为 bool, float16, float32,float64,int32,int64 的多维 Tensor。
16+
- **x** (Tensor) - 输入变量,数据类型为 bool, float16, float32,float64,int32,int64 的多维 Tensor。别名: ``input``。
1417
- **chunks** (int) - ``chunks`` 是一个整数,表示将输入 Tensor 划分成多少个相同大小的子 Tensor。
15-
- **axis** (int|Tensor,可选) - 整数或者形状为[]的 0-D Tensor,数据类型为 int32 或 int64。表示需要分割的维度。如果 ``axis < 0``,则划分的维度为 ``rank(x) + axis``。默认值为 0。
18+
- **axis** (int|Tensor,可选) - 整数或者形状为[]的 0-D Tensor,数据类型为 int32 或 int64。表示需要分割的维度。如果 ``axis < 0``,则划分的维度为 ``rank(x) + axis``。默认值为 0。别名: ``dim``。
1619
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
1720

1821
下图展示了一个例子,设 x 的尺寸为(3,3,3),chunks 值为 3,axis 值为 0。

docs/api/paddle/clip_cn.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
clip
44
-------------------------------
55

6-
.. py:function:: paddle.clip(x, min=None, max=None, name=None)
6+
.. py:function:: paddle.clip(x, min=None, max=None, name=None, *, out=None)
77
88
99
@@ -14,14 +14,21 @@ clip
1414
1515
Out = MIN(MAX(x, min), max)
1616
17+
.. note::
18+
别名支持: 参数名 ``input`` 可替代 ``x``,如 ``clip(input=tensor_x, min=0.3, max=0.7)`` 等价于 ``clip(x=tensor_x, min=0.3, max=0.7)``。
19+
1720
参数
1821
::::::::::::
1922

20-
- **x** (Tensor) - 输入的 Tensor,数据类型为:bfloat16、float16、float32、float64、int32、int64。
23+
- **x** (Tensor) - 输入的 Tensor,数据类型为:bfloat16、float16、float32、float64、int32、int64。别名: ``input``。
2124
- **min** (float|int|Tensor,可选) - 裁剪的最小值,输入中小于该值的元素将由该元素代替,若参数为空,则不对输入的最小值做限制。数据类型可以是 float32 或形状为[]的 0-D Tensor,类型可以为 bfloat16、float16、float32、float64、int32,默认值为 None。
2225
- **max** (float|int|Tensor,可选) - 裁剪的最大值,输入中大于该值的元素将由该元素代替,若参数为空,则不对输入的最大值做限制。数据类型可以是 float32 或形状为[]的 0-D Tensor,类型可以为 bfloat16、float16、float32、float64、int32,默认值为 None。
2326
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
2427

28+
关键字参数
29+
::::::::::::
30+
- **out** (Tensor,可选) - 输出 Tensor。默认值为 None。
31+
2532
返回
2633
::::::::::::
2734
输出 Tensor,与 ``x`` 维度相同。当 ``x`` 数据类型为 int32 或 int64 并且 ``min`` 或 ``max`` 有一个为 float 类型时,输出 Tensor 的数据类型为 float32,否则与输入 ``x`` 的数据类型相同。

docs/api/paddle/squeeze_cn.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,13 @@ squeeze
5050
:width: 600
5151
:alt: 图例
5252

53+
.. note::
54+
别名支持: 参数名 ``input`` 可替代 ``x``,参数名 ``dim`` 可替代 ``axis``,如 ``squeeze(input=tensor_x, dim=1)`` 等价于 ``squeeze(x=tensor_x, axis=1)``。
55+
5356
参数
5457
:::::::::
55-
- **x** (Tensor) - 输入的 `Tensor` ,数据类型为:float32、float64、bool、int8、int32、int64。
56-
- **axis** (int|list|tuple,可选) - 输入一个或一列整数,代表要压缩的轴。axis 的范围: [−ndim(x), ndim(x)) 。 如果 axis 为负数, 则 axis=axis+ndim(x) 。默认为 None,表示对所有尺寸为 1 的维度进行压缩。
58+
- **x** (Tensor) - 输入的 `Tensor` ,数据类型为:float32、float64、bool、int8、int32、int64。别名: ``input``。
59+
- **axis** (int|list|tuple,可选) - 输入一个或一列整数,代表要压缩的轴。axis 的范围: [−ndim(x), ndim(x)) 。 如果 axis 为负数, 则 axis=axis+ndim(x) 。默认为 None,表示对所有尺寸为 1 的维度进行压缩。别名: ``dim``。
5760
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
5861

5962
返回

docs/api/paddle/transpose_cn.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,14 @@ transpose
1010
1111
根据 perm 对输入的多维 Tensor 进行数据重排。返回多维 Tensor 的第 i 维对应输入 Tensor 的 perm[i]维。
1212

13+
.. note::
14+
别名支持: 参数名 ``input`` 可替代 ``x``,参数 ``dim0`` 与 ``dim1`` 可替代 ``axis`` ,如 ``transpose(input=x, dim0=0, dim1=1)`` 等价于 ``transpose(x=x, perm=[1, 0, 2])`` 。
15+
16+
1317
参数
1418
::::::::::::
1519

16-
- **x** (Tensor) - 输入:x:[N_1, N_2, ..., N_k, D]多维 Tensor,可选的数据类型为 bool, float16, bfloat16, float32, float64, int8, int16, int32, int64, uint8, uint16, complex64, complex128。
20+
- **x** (Tensor) - 输入:x:[N_1, N_2, ..., N_k, D]多维 Tensor,可选的数据类型为 bool, float16, bfloat16, float32, float64, int8, int16, int32, int64, uint8, uint16, complex64, complex128。别名: ``input``。
1721
- **perm** (list|tuple) - perm 长度必须和 X 的维度相同,并依照 perm 中数据进行重排。
1822
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
1923

docs/api/paddle/unsqueeze_cn.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,13 @@ unsqueeze
1818

1919
额外的,当需要在多个位置增加维度时, ``unsqueeze`` 方法会按顺序依次增加维度。例如 Shape 为 [2, 3] 的 Tensor 在 axis = [0, 2] 处增加维度, ``unsqueeze`` 方法会先在 axis = 0 前插入一个维度, Shape 变为 [1, 2, 3],接着在 axis = 2 前插入一个维度, Shape 最终变为 [1, 2, 1, 3]。
2020

21+
.. note::
22+
别名支持: 参数名 ``input`` 可替代 ``x``,参数名 ``dim`` 可替代 ``axis``,如 ``unsqueeze(input=tensor_x, dim=1)`` 等价于 ``unsqueeze(x=tensor_x, axis=1)``。
23+
2124
参数
2225
:::::::::
23-
- **x** (Tensor) - 输入的 `Tensor`,数据类型为:bfloat16、float32、float64、bool、int8、int32、int64。
24-
- **axis** (int|list|tuple|Tensor) - 表示要插入维度的位置。数据类型是 int32。如果 axis 的类型是 list 或 tuple,它的元素可以是整数或者形状为[]的 0-D Tensor。如果 axis 的类型是 Tensor,则是 1-D Tensor。如果 axis 是负数,则 axis=axis+ndim(x)+1 。
26+
- **x** (Tensor) - 输入的 `Tensor`,数据类型为:bfloat16、float32、float64、bool、int8、int32、int64。别名: ``input``。
27+
- **axis** (int|list|tuple|Tensor) - 表示要插入维度的位置。数据类型是 int32。如果 axis 的类型是 list 或 tuple,它的元素可以是整数或者形状为[]的 0-D Tensor。如果 axis 的类型是 Tensor,则是 1-D Tensor。如果 axis 是负数,则 axis=axis+ndim(x)+1 。别名: ``dim``。
2528
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
2629

2730
返回

0 commit comments

Comments
 (0)