Skip to content

Commit 2c6cbfd

Browse files
committed
[API Compatibility] block_diag/broadcast_tensors/cartesian_prod/copysign/index_fill/cross/dist/flip/pow Edit By AI
1 parent 28fe467 commit 2c6cbfd

9 files changed

Lines changed: 60 additions & 14 deletions

docs/api/paddle/block_diag_cn.rst

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

6-
.. py:function:: paddle.block_diag(inputs, name=None)
6+
.. py:function:: paddle.block_diag(*inputs, name=None)
77
88
根据 `inputs` 创建对角矩阵。
99

1010
参数
1111
:::::::::
12-
- **inputs** (list|tuple) - 是一个 Tensor 列表或 Tensor 元组,其子项为 0、1、2 维的 Tensor 。数据类型为: `bool`、 `float16`、 `float32`、 `float64`、 `uint8`、 `int8`、 `int16`、 `int32`、 `int64`、 `bfloat16`、 `complex64`、 `complex128`。
12+
- **inputs** (list|tuple) - 是一个 Tensor 列表或 Tensor 元组,其子项为 0、1、2 维的 Tensor 。数据类型为: `bool`、 `float16`、 `float32`、 `float64`、 `uint8`、 `int8`、 `int16`、 `int32`、 `int64`、 `bfloat16`、 `complex64`、 `complex128`。别名: ``*tensors``。
1313
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 `None`。
1414

1515
返回

docs/api/paddle/broadcast_tensors_cn.rst

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

6-
.. py:function:: paddle.broadcast_tensors(input, name=None)
6+
.. py:function:: paddle.broadcast_tensors(*input, name=None)
77
88
根据 Broadcast 规范对一组输入 ``input`` 进行 Broadcast 操作
99
输入应符合 Broadcast 规范
@@ -29,7 +29,7 @@ broadcast_tensors
2929
:align: center
3030
参数
3131
:::::::::
32-
- input (list(Tensor)|tuple(Tensor)) - 一组输入 Tensor,数据类型为:bool、float32、float64、complex64、complex128、int32 或 int64。所有的输入 Tensor 均需要满足 rank <= 5。
32+
- input (list(Tensor)|tuple(Tensor)) - 一组输入 Tensor,数据类型为:bool、float32、float64、complex64、complex128、int32 或 int64。所有的输入 Tensor 均需要满足 rank <= 5。别名: ``*tensors``。
3333
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
3434

3535
返回

docs/api/paddle/cartesian_prod_cn.rst

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

6-
.. py:function:: paddle.cartesian_prod(x, name=None)
6+
.. py:function:: paddle.cartesian_prod(*x, name=None)
77
88
99
对指定的 tensor 序列进行笛卡尔积操作。该行为类似于 python 标准库中的 itertools.product 方法。
@@ -13,7 +13,7 @@ cartesian_prod
1313
参数
1414
:::::::::
1515

16-
- **x** (list[Tensor]|tuple[Tensor]) – 任意数量的 1-D Tensor 序列,支持的数据类型:bfloat16、float16、float32、float64、int32、int64、complex64、complex128。
16+
- **x** (list[Tensor]|tuple[Tensor]) – 任意数量的 1-D Tensor 序列,支持的数据类型:bfloat16、float16、float32、float64、int32、int64、complex64、complex128。别名: ``*tensors``。
1717

1818
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
1919

docs/api/paddle/copysign__cn.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,18 @@ copysign\_
77
88
Inplace 版本的 :ref:`cn_api_paddle_copysign` API,对输入 `x` 采用 Inplace 策略。
99

10+
参数
11+
::::::::::::
12+
13+
- **x** (Tensor) - 输入的复数值的 Tensor。
14+
- **y** (Tensor) - 输入的复数值的 Tensor。别名: ``other``。
15+
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
16+
17+
返回
18+
::::::::::::
19+
20+
Tensor,输出数据类型与输入数据类型相同。
21+
1022
更多关于 inplace 操作的介绍请参考 `3.1.3 原位(Inplace)操作和非原位操作的区别`_ 了解详情。
1123

1224
.. _3.1.3 原位(Inplace)操作和非原位操作的区别: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/beginner/tensor_cn.html#id3

docs/api/paddle/copysign_cn.rst

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

6-
.. py:function:: paddle.copysign(x, y, name=None)
6+
.. py:function:: paddle.copysign(x, y, name=None, *, out=None)
77
88
99
按照元素计算两个输入 Tensor 的 copysign 大小,由数值和符号组成,其数值部分来自于第一个 Tensor 中的元素,符号部分来自于第二个 Tensor 中的元素。
@@ -19,10 +19,14 @@ copysign
1919
参数
2020
::::::::::::
2121

22-
- **x** (Tensor) - 输入的复数值的 Tensor,数据类型为:bool, uint8, int8, int16, int32, int64, bfloat16, float16, float32, float64。
23-
- **y** (Tensor) - 输入的复数值的 Tensor,数据类型为:bool, uint8, int8, int16, int32, int64, bfloat16, float16, float32, float64。
22+
- **x** (Tensor) - 输入的复数值的 Tensor,数据类型为:bool, uint8, int8, int16, int32, int64, bfloat16, float16, float32, float64。别名: ``input``。
23+
- **y** (Tensor) - 输入的复数值的 Tensor,数据类型为:bool, uint8, int8, int16, int32, int64, bfloat16, float16, float32, float64。别名: ``other``。
2424
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
2525

26+
关键字参数
27+
:::::::::
28+
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。
29+
2630
返回
2731
::::::::::::
2832

docs/api/paddle/geometric__cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ geometric\_
1010
::::::::::::
1111

1212
- **x** (Tensor) - 被填充的 Tensor ,数据类型为: float32、float64。
13-
- **probs** (float | Tensor) - 输入的概率参数, probs 的值必须为正,数据类型为 float、Tensor。当该参数类型为 Tensor 时, probs 代表每次试验成功的概率。
13+
- **probs** (float | Tensor) - 输入的概率参数, probs 的值必须为正,数据类型为 float、Tensor。当该参数类型为 Tensor 时, probs 代表每次试验成功的概率。别名: ``p``。
1414
- **name** (str ,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
1515

1616
返回

docs/api/paddle/hypot__cn.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,18 @@ hypot\_
77
88
Inplace 版本的 :ref:`cn_api_paddle_hypot` API,对输入 x 采用 Inplace 策略。
99

10+
参数
11+
::::::::::::
12+
13+
- **x** (Tensor) - 输入的 Tensor。
14+
- **y** (Tensor) - 输入的 Tensor。别名: ``other``。
15+
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
16+
17+
返回
18+
::::::::::::
19+
20+
Tensor,输出数据类型与输入数据类型相同。
21+
1022
更多关于 inplace 操作的介绍请参考 `3.1.3 原位(Inplace)操作和非原位操作的区别`_ 了解详情。
1123

1224
.. _3.1.3 原位(Inplace)操作和非原位操作的区别: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/beginner/tensor_cn.html#id3

docs/api/paddle/index_fill__cn.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,20 @@ index_fill\_
77
88
Inplace 版本的 :ref:`cn_api_paddle_index_fill` API
99

10+
参数
11+
:::::::::
12+
13+
- **x** (Tensor)– 输入 Tensor。
14+
- **index** (Tensor)– 包含索引下标的 1-D Tensor。
15+
- **axis** (int) – 索引轴。别名: ``dim``。
16+
- **value** (float)– 用于填充目标张量的值。别名: ``values``。
17+
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
18+
19+
返回
20+
:::::::::
21+
22+
Tensor,返回一个数据类型同输入的 Tensor。
23+
1024
更多关于 inplace 操作的介绍请参考 `3.1.3 原位(Inplace)操作和非原位操作的区别`_ 了解详情。
1125

1226
.. _3.1.3 原位(Inplace)操作和非原位操作的区别: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/beginner/tensor_cn.html#id3

docs/api/paddle/index_fill_cn.rst

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
index_fill
44
-------------------------------
55

6-
.. py:function:: paddle.index_fill(x, index, axis, value, name=None)
6+
.. py:function:: paddle.index_fill(x, index, axis, value, name=None, *, out=None)
77
88
依据指定的轴 ``axis`` 和索引 ``indices`` 将指定位置的 ``x`` 填充为 ``value`` 。
99

@@ -18,12 +18,16 @@ index_fill
1818
参数
1919
:::::::::
2020

21-
- **x** (Tensor)– 输入 Tensor。 ``x`` 的数据类型可以是 float16, float32,float64,int32,int64。
21+
- **x** (Tensor)– 输入 Tensor。 ``x`` 的数据类型可以是 float16, float32,float64,int32,int64。别名: ``input``。
2222
- **index** (Tensor)– 包含索引下标的 1-D Tensor。数据类型可以是 int32,int64。
23-
- **axis** (int) – 索引轴。数据类型为 int。
24-
- **value** (float)– 用于填充目标张量的值。
23+
- **axis** (int) – 索引轴。数据类型为 int。别名: ``dim``。
24+
- **value** (float)– 用于填充目标张量的值。别名: ``values``。
2525
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
2626

27+
关键字参数
28+
:::::::::
29+
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。
30+
2731
返回
2832
:::::::::
2933

0 commit comments

Comments
 (0)