Skip to content

Commit c2763da

Browse files
authored
[API Compatibility] block_diag/broadcast_tensors/cartesian_prod/copysign/index_fill/cross/dist/flip/pow Edit By AI (#7717)
1 parent bd99665 commit c2763da

15 files changed

Lines changed: 243 additions & 173 deletions

docs/api/paddle/block_diag_cn.rst

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,20 @@ block_diag
55

66
.. py:function:: paddle.block_diag(inputs, name=None)
77
8-
根据 `inputs` 创建对角矩阵。
8+
根据输入的张量创建块对角矩阵。
9+
10+
本 API 支持两种调用方式:
11+
12+
1. **Paddle 风格**: ``paddle.block_diag(inputs, name=None)``
13+
使用张量序列作为输入。
14+
15+
2. **PyTorch 风格**: ``paddle.block_diag(*tensors)``
16+
使用可变数量的张量参数。
917

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

1523
返回
1624
:::::::::

docs/api/paddle/broadcast_tensors_cn.rst

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,15 @@ broadcast_tensors
55

66
.. py:function:: paddle.broadcast_tensors(input, name=None)
77
8-
根据 Broadcast 规范对一组输入 ``input`` 进行 Broadcast 操作
9-
输入应符合 Broadcast 规范
8+
根据 Broadcast 规范对一组输入张量进行广播操作。
9+
10+
本 API 支持两种调用方式:
11+
12+
1. **Paddle 风格**: ``paddle.broadcast_tensors(input, name=None)``
13+
使用张量序列作为输入。
14+
15+
2. **PyTorch 风格**: ``paddle.broadcast_tensors(*tensors)``
16+
使用可变数量的张量参数。
1017

1118
.. note::
1219
如想了解更多 Broadcasting 内容,请参见 `Tensor 介绍`_ .
@@ -27,10 +34,11 @@ broadcast_tensors
2734
:width: 800
2835
:alt: Broadcast 图示
2936
:align: center
37+
3038
参数
3139
:::::::::
32-
- input (list(Tensor)|tuple(Tensor)) - 一组输入 Tensor,数据类型为:boolfloat32float64complex64complex128int32 或 int64。所有的输入 Tensor 均需要满足 rank <= 5。
33-
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
40+
- **input** (list(Tensor)|tuple(Tensor)) - 张量列表或张量元组,数据类型为: ``bool``、 ``float32``、 ``float64``、 ``complex64``、 ``complex128``、 ``int32````int64``。所有的输入 Tensor 均需要满足 rank <= 5。
41+
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 ``None``
3442

3543
返回
3644
:::::::::

docs/api/paddle/cartesian_prod_cn.rst

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,23 @@ cartesian_prod
55

66
.. py:function:: paddle.cartesian_prod(x, name=None)
77
8+
对指定的张量序列进行笛卡尔积操作。
89

9-
对指定的 tensor 序列进行笛卡尔积操作。该行为类似于 python 标准库中的 itertools.product 方法。
10-
相当于将所有的输入 tensors 转换为列表后,对其使用 itertools.product 方法,最终将返回的列表转换为 tensor。
10+
本 API 支持两种调用方式:
1111

12+
1. **Paddle 风格**: ``paddle.cartesian_prod(x, name=None)``
13+
使用张量序列作为输入。
1214

13-
参数
14-
:::::::::
15+
2. **PyTorch 风格**: ``paddle.cartesian_prod(*tensors)``
16+
使用可变数量的张量参数。
1517

16-
- **x** (list[Tensor]|tuple[Tensor]) – 任意数量的 1-D Tensor 序列,支持的数据类型:bfloat16、float16、float32、float64、int32、int64、complex64、complex128。
18+
该行为类似于 python 标准库中的 itertools.product 方法。
19+
相当于将所有的输入 tensors 转换为列表后,对其使用 itertools.product 方法,最终将返回的列表转换为 tensor。
1720

18-
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
21+
参数
22+
:::::::::
23+
- **x** (list[Tensor]|tuple[Tensor]) – 1-D 张量序列,支持的数据类型: ``bfloat16``、 ``float16``、 ``float32``、 ``float64``、 ``int32``、 ``int64``、 ``complex64``、 ``complex128``。
24+
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 ``None``。
1925

2026
返回
2127
:::::::::

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/cross_cn.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ cross
1212

1313
参数
1414
:::::::::
15-
- **x** (Tensor) - 第一个输入 Tensor,数据类型为:float16、float32、float64、int32、int64、complex64、complex128。
16-
- **y** (Tensor) - 第二个输入 Tensor,数据类型为:float16、float32、float64、int32、int64、complex64、complex128。
17-
- **axis** (int,可选) - 沿着此维进行向量积操作。默认值是 9,意思是选取第一个长度为 3 的 ``axis`` 。
15+
- **x** (Tensor) - 第一个输入 Tensor,数据类型为:float16、float32、float64、int32、int64、complex64、complex128。别名 ``input``。
16+
- **y** (Tensor) - 第二个输入 Tensor,数据类型为:float16、float32、float64、int32、int64、complex64、complex128。别名 ``other``。
17+
- **axis** (int,可选) - 沿着此维进行向量积操作。别名 ``dim``。默认值是 9,意思是选取第一个长度为 3 的 ``axis`` 。
1818
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
1919

2020
返回

docs/api/paddle/dist_cn.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ z (4-D Tensor): 8 x 7 x 6 x 5
5050
参数
5151
::::::::::::
5252

53-
- **x** (Tensor) - 1-D 到 6-D Tensor,数据类型为 bfloat16,float16,float32 或 float64。
54-
- **y** (Tensor) - 1-D 到 6-D Tensor,数据类型为 bfloat16,float16,float32 或 float64。
53+
- **x** (Tensor) - 1-D 到 6-D Tensor,数据类型为 bfloat16,float16,float32 或 float64。别名 ``input``。
54+
- **y** (Tensor) - 1-D 到 6-D Tensor,数据类型为 bfloat16,float16,float32 或 float64。别名 ``other``。
5555
- **p** (float,可选) - 用于设置需要计算的范数,数据类型为 float32 或 float64。默认值为 2。
5656
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为 None。
5757

docs/api/paddle/flip_cn.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ flip
1919
参数
2020
::::::::::::
2121

22-
- **x** (Tensor) - 输入的 Tensor。维度为多维,数据类型为 bool、int32、int64、float32 或 float64。
23-
- **axis** (list|tuple|int) - 需要翻转的轴。当 axis 是 int 型时,且 axis<0,实际的计算维度为 ndim(x) + axis;axis 是 list 或 tuple 时,``axis[i] < 0`` 时,实际的计算维度为 ndim(x) + axis[i],其中 i 为 axis 的索引。
22+
- **x** (Tensor) - 输入的 Tensor。维度为多维,数据类型为 bool、int32、int64、float32 或 float64。别名 ``input``。
23+
- **axis** (list|tuple|int) - 需要翻转的轴。当 axis 是 int 型时,且 axis<0,实际的计算维度为 ndim(x) + axis;axis 是 list 或 tuple 时,``axis[i] < 0`` 时,实际的计算维度为 ndim(x) + axis[i],其中 i 为 axis 的索引。别名 ``dims``。
2424
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
2525

2626
返回

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/index_fill_cn.rst

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,15 @@ index_fill
55

66
.. py:function:: paddle.index_fill(x, index, axis, value, name=None)
77
8-
依据指定的轴 ``axis`` 和索引 ``indices`` 将指定位置的 ``x`` 填充为 ``value`` 。
8+
依据指定的轴/维度和索引将指定位置的张量填充为指定值。
9+
10+
本 API 支持两种调用方式:
11+
12+
1. **Paddle 风格**: ``paddle.index_fill(x, index, axis, value, name=None)``
13+
使用 Paddle 风格的参数顺序和命名。
14+
15+
2. **PyTorch 风格**: ``paddle.index_fill(input, dim, index, value)``
16+
使用 PyTorch 风格的参数顺序和命名。
917

1018
**图解说明**:
1119

@@ -17,12 +25,11 @@ index_fill
1725

1826
参数
1927
:::::::::
20-
21-
- **x** (Tensor)– 输入 Tensor。 ``x`` 的数据类型可以是 float16, float32,float64,int32,int64。
22-
- **index** (Tensor)– 包含索引下标的 1-D Tensor。数据类型可以是 int32,int64。
23-
- **axis** (int) – 索引轴。数据类型为 int。
24-
- **value** (float)– 用于填充目标张量的值。
25-
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
28+
- **x** (Tensor) – 输入张量。 ``x`` 的数据类型可以是 ``float16``、 ``float32``、 ``float64``、 ``int32``、 ``int64``。
29+
- **index** (Tensor) – 包含索引下标的 1-D Tensor。数据类型可以是 ``int32``、 ``int64``。
30+
- **axis** (int) – 索引轴。数据类型为 ``int``。
31+
- **value** (float) – 用于填充目标张量的值。
32+
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 ``None``。
2633

2734
返回
2835
:::::::::
@@ -33,7 +40,3 @@ Tensor,返回一个数据类型同输入的 Tensor。
3340
::::::::::::
3441

3542
COPY-FROM: paddle.index_fill
36-
37-
更多关于 outplace 操作的介绍请参考 `3.1.3 原位(Inplace)操作和非原位(Outplace)操作的区别`_ 了解详情。
38-
39-
.. _3.1.3 原位(Inplace)操作和非原位(Outplace)操作的区别: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/beginner/tensor_cn.html#id3

docs/api/paddle/renorm_cn.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ renorm
1010

1111
参数
1212
::::::::::::
13-
- **x** (Tensor) - 输入张量
13+
- **x** (Tensor) - 输入张量。别名 ``input``。
1414
- **p** (float) - 范数运算的幂。
15-
- **axis** (int) - 对张量进行切片的维度。
16-
- **max_norm** (float) - 最大范数限制。
15+
- **axis** (int) - 对张量进行切片的维度。别名 ``dim``。
16+
- **max_norm** (float) - 最大范数限制。别名 ``maxnorm``。
1717

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

0 commit comments

Comments
 (0)