Skip to content

Commit 58636e6

Browse files
[API Compatiblity] update sink api docs (PaddlePaddle#7401)
* update sink api docs * fix * fix * fix style --------- Co-authored-by: zachary sun <[email protected]>
1 parent 598deb3 commit 58636e6

27 files changed

+91
-21
lines changed

docs/api/paddle/Tensor_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1454,7 +1454,7 @@ exponential_(lam=1.0, name=None)
14541454
参数:
14551455
- **x** (Tensor) - 输入 Tensor,数据类型为 float32/float64。
14561456
- **lam** (float) - 指数分布的 :math:`\lambda` 参数。
1457-
- **lambd** - ``lam`` 的别名,行为完全一致。
1457+
别名: ``lambd``
14581458
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
14591459

14601460

docs/api/paddle/bitwise_or_cn.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ bitwise_or
2222
::::::::::::
2323

2424
- **x** (Tensor)- 输入的 N-D `Tensor`,数据类型为:bool,uint8,int8,int16,int32,int64。
25-
- **input** - ``x`` 的别名,行为完全一致。
25+
别名: ``input``
2626
- **y** (Tensor)- 输入的 N-D `Tensor`,数据类型为:bool,uint8,int8,int16,int32,int64。
27-
- **other** - ``y`` 的别名,行为完全一致。
27+
别名: ``other``
2828
- **out** (Tensor,可选)- 输出的结果 `Tensor`,是与输入数据类型相同的 N-D `Tensor`。默认值为 None,此时将创建新的 Tensor 来保存输出结果。
2929
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
3030

docs/api/paddle/broadcast_to_cn.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ broadcast_to
2222
:::::::::
2323

2424
- **x** (Tensor) - 输入的 Tensor,数据类型为:bool、float16、float32、float64、int32、int64、uint8 或 uint16。
25-
- **input** - ``x`` 的别名,行为完全一致。
25+
别名: ``input``
2626
- **shape** (tuple|list|Tensor) - 给定输入 ``x`` 扩展后的形状,若 ``shape`` 为 list 或者 tuple,则其中的元素值应该为整数或者是形状为 1-D 或 0-D 的 Tensor,若 ``shape`` 类型为 Tensor,则其应该为 1-D Tensor。
27-
- **size** - ``shape`` 的别名,行为完全一致。
27+
别名: ``size``
2828
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
2929

3030
返回

docs/api/paddle/ceil_cn.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,16 @@ ceil
1414
out = \left \lceil x \right \rceil
1515
1616
17+
.. note::
18+
别名支持: 参数名 ``input`` 可替代 ``x``,如 ``input=tensor_x`` 等价于 ``x=tensor_x``。
1719

1820
参数
1921
::::::::::::
2022

2123
- **x** (Tensor) - 输入的 Tensor,数据类型支持 float32, float64, float16, bfloat16, uint8, int8, int16, int32, int64。
24+
别名: ``input``
2225
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
26+
- **out** (Tensor,可选) - 指定输出结果的 `Tensor`,默认值为 None。
2327

2428
返回
2529
::::::::::::

docs/api/paddle/cumsum_cn.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ cumsum
1111

1212
**注意**:结果的第一个元素和输入的第一个元素相同。
1313

14+
.. note::
15+
别名支持: 参数名 ``input`` 可替代 ``x`` 和 ``dim`` 可替代 ``axis``,如 ``input=tensor_x`` 等价于 ``x=tensor_x``, ``dim=2`` 等价于 ``axis=2``。
16+
1417
参数
1518
:::::::::
1619
- **x** (Tensor) - 累加的输入,需要进行累加操作的 Tensor。别名 ``input``。

docs/api/paddle/expand_cn.rst

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,22 @@ expand
1717
:alt: 示例一图示
1818
:align: center
1919

20+
.. note::
21+
别名支持: 别名支持: 参数名 ``input`` 可替代 ``x`` 和 ``size`` 可替代 ``shape``。
22+
``shape`` 支持可变参数类型。
23+
使用实例:
24+
``paddle.expand(tensor_x, shape=[3, 4], name=None)``
25+
``tensor_x.expand([3, 4]) -> paddle.expand(tensor_x, [3, 4])``
26+
``tensor_x.expand(3, 4) -> paddle.expand(tensor_x, 3, 4)``
27+
``tensor_x.expand(size=[3, 4]) -> paddle.expand(tensor_x, size=[3, 4])``
28+
2029

2130
参数
2231
:::::::::
2332
- **x** (Tensor) - 输入的 Tensor,数据类型为:bool、float16、float32、float64、int32、int64、uint8 或 uint16。
24-
- **shape** (tuple|list|Tensor) - 给定输入 ``x`` 扩展后的形状,若 ``shape`` 为 list 或者 tuple,则其中的元素值应该为整数或者是形状为 1-D 或 0-D 的 Tensor,若 ``shape`` 类型为 Tensor,则其应该为 1-D Tensor。值为-1 表示保持相应维度的形状不变。
33+
别名: ``input``
34+
- **shape** (tuple|list|Tensor) - 给定输入 ``x`` 扩展后的形状,若 ``shape`` 为 list 或者 tuple,则其中的元素值应该为整数或者是形状为 1-D 或 0-D 的 Tensor,若 ``shape`` 类型为 Tensor,则其应该为 1-D Tensor。值为-1 表示保持相应维度的形状不变。支持可变参数类型。
35+
别名: ``size``
2536
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
2637

2738
返回

docs/api/paddle/eye_cn.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@ eye
77
88
构建二维 Tensor(主对角线元素为 1,其他元素为 0)。
99

10+
.. note::
11+
别名支持: 参数名 ``n`` 可替代 ``num_rows`` 和 ``m`` 可替代 ``num_columns``,如 ``n=1`` 等价于 ``num_rows=1``, ``m=2`` 等价于 ``num_columns=2``。
12+
1013
参数
1114
::::::::::::
12-
1315
- **num_rows** (int|Tensor) - 生成 2-D Tensor 的行数,数据类型为非负 int32。别名:``n``。
1416
- **num_columns** (int|Tensor|None,可选) - 生成 2-D Tensor 的列数,数据类型为非负 int32。若为 None,则默认等于 ``num_rows``。别名:``m``。
1517
- **dtype** (str|paddle.dtype|np.dtype,可选) - 返回 Tensor 的数据类型。支持 int32、int64、float16、float32、float64、complex64、complex128。

docs/api/paddle/flatten_cn.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,19 @@ flatten
4747
:alt: 图例
4848
:width: 700
4949

50+
.. note::
51+
别名支持: 参数名 ``input`` 可替代 ``x`` 、 ``start_dim`` 可替代 ``start_axis`` 和 ``ehd_dim`` 可替代 ``stop_axis``。
52+
如 ``input=tensor_x`` 等价于 ``x=tensor_x``, ``start_dim=1`` 等价于 ``start_axis=1`` 和 ``ehd_dim=1`` 等价于 ``stop_axis=1``。
53+
5054
参数
5155
::::::::::::
5256

5357
- **x** (Tensor) - 多维 Tensor,数据类型可以为 float16、float32、float64、int8、int32 或 int64。
58+
别名: ``input``
5459
- **start_axis** (int) - flatten 展开的起始维度。
60+
别名: ``start_dim``
5561
- **stop_axis** (int) - flatten 展开的结束维度。
62+
别名: ``end_dim``
5663
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
5764

5865
返回

docs/api/paddle/floor_divide_cn.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,18 @@ floor_divide
2020
- :math:`X`:多维 Tensor。
2121
- :math:`Y`:多维 Tensor。
2222

23+
.. note::
24+
别名支持: 参数名 ``input`` 可替代 ``x`` 和 ``other`` 可替代 ``y``,如 ``input=tensor_x`` 等价于 ``x=tensor_x``, ``other=tensor_y`` 等价于 ``y=tensor_y``。
25+
2326

2427
参数
2528
:::::::::
2629
- **x** (Tensor) - 多维 Tensor。数据类型为 int8 int16 int32 int64 float32 float64 float16 或 bfloat16。
30+
别名: ``input``
2731
- **y** (Tensor) - 多维 Tensor。数据类型为 int8 int16 int32 int64 float32 float64 float16 或 bfloat16。
32+
别名: ``other``
2833
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
34+
- **out** (Tensor,可选) - 指定输出结果的 `Tensor`,默认值为 None。
2935

3036

3137
返回

docs/api/paddle/full_like_cn.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,14 @@ full_like
88
99
创建一个和 ``x`` 具有相同的形状并且数据类型为 ``dtype`` 的 Tensor,其中元素值均为 ``fill_value``,当 ``dtype`` 为 None 的时候,Tensor 数据类型和输入 ``x`` 相同。
1010

11+
.. note::
12+
别名支持: 参数名 ``input`` 可替代 ``x``,如 ``input=tensor_x`` 等价于 ``x=tensor_x``。
13+
1114
参数
1215
::::::::::::
1316

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

0 commit comments

Comments
 (0)