Skip to content

Commit 2ff8918

Browse files
committed
[API Compatibility] sgn/signbit/take/tensordot/vander/logaddexp/logspace/moveaxis/nan_to_num/nanmean/nansum/slice_scatter Edit By AI Agent
1 parent 7aa8519 commit 2ff8918

12 files changed

Lines changed: 66 additions & 31 deletions

docs/api/paddle/logaddexp_cn.rst

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

6-
.. py:function:: paddle.logaddexp(x, y, name=None)
6+
.. py:function:: paddle.logaddexp(x, y, name=None, *, out=None)
77
88
计算 ``x`` 和 ``y`` 的以 e 为底的指数的和的自然对数。计算公式如下:
99

@@ -12,10 +12,14 @@ logaddexp
1212
1313
参数
1414
::::::::::
15-
- **x** (Tensor) - 输入的 Tensor,数据类型为:int32,int64,bfloat16,float16,float32、float64。
16-
- **y** (Tensor) - 输入的 Tensor,数据类型为:int32,int64,bfloat16,float16,float32、float64。
15+
- **x** (Tensor) - 输入的 Tensor,数据类型为:int32,int64,bfloat16,float16,float32、float64。别名 ``input``。
16+
- **y** (Tensor) - 输入的 Tensor,数据类型为:int32,int64,bfloat16,float16,float32、float64。别名 ``other``。
1717
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
1818

19+
关键字参数
20+
::::::::::
21+
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。
22+
1923
返回
2024
::::::::::
2125
``Tensor``,根据上述公式计算的 logaddexp(x) 结果

docs/api/paddle/logspace_cn.rst

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

6-
.. py:function:: paddle.logspace(start, stop, num, base=10.0, dtype=None, name=None)
6+
.. py:function:: paddle.logspace(start, stop, num, base=10.0, dtype=None, name=None, *, out=None, device=None, requires_grad=False)
77
88
返回一个 Tensor,Tensor 的值为在区间 :math:`[base^{start}, base^{stop}]` 上按对数均匀间隔的 :math:`num` 个值,输出 Tensor 的长度为 num。
99

@@ -14,12 +14,18 @@ logspace
1414
::::::::::::
1515

1616
- **start** (int|float|Tensor) – ``start`` 是区间开始值以 ``base`` 为底的指数,可以是一个标量,或是一个 shape 为 [] 的 0-D Tensor,该 Tensor 的数据类型可以是 float32、float64、int32 或者 int64。
17-
- **stop** (int|float|Tensor) – ``stop`` 是区间结束值以 ``base`` 为底的指数,可以是一个标量,或是一个 shape 为 [] 的 0-D Tensor,该 Tensor 的数据类型可以是 float32、float64、int32 或者 int64。
18-
- **num** (int|Tensor) – ``num`` 是给定区间内需要划分的区间数,可以是一个整型标量,或是一个 shape 为 [] 的 0-D Tensor,该 Tensor 的数据类型需为 int32。
17+
- **stop** (int|float|Tensor) – ``stop`` 是区间结束值以 ``base`` 为底的指数,可以是一个标量,或是一个 shape 为 [] 的 0-D Tensor,该 Tensor 的数据类型可以是 float32、float64、int32 或者 int64。别名 ``end``。
18+
- **num** (int|Tensor) – ``num`` 是给定区间内需要划分的区间数,可以是一个整型标量,或是一个 shape 为 [] 的 0-D Tensor,该 Tensor 的数据类型需为 int32。别名 ``steps``。
1919
- **base** (int|float|Tensor) – ``base`` 是对数函数的底数,可以是一个标量,或是一个 shape 为 [] 的 0-D Tensor,该 Tensor 的数据类型可以是 float32、float64、int32 或者 int64。
2020
- **dtype** (str|paddle.dtype|np.dtype,可选) – 输出 Tensor 的数据类型,可以是 float32、float64、int32 或者 int64。如果 dtype 的数据类型为 None,输出 Tensor 数据类型为 float32。
2121
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
2222

23+
关键字参数
24+
::::::::::::
25+
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。
26+
- **device** (str|paddle.CUDAPlace|paddle.CPUPlace,可选) - 指定输出 Tensor 所在的设备,默认值为 ``None``,表示使用当前默认设备。
27+
- **requires_grad** (bool,可选) - 是否需要计算梯度,若为 ``True``,则输出 Tensor 的 ``stop_gradient`` 属性将被设置为 ``False``,默认值为 ``False``。
28+
2329

2430
返回
2531
::::::::::::

docs/api/paddle/moveaxis_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ moveaxis
1313
:width: 600
1414
参数
1515
:::::::::
16-
- **x** (Tensor) - 输入的 N-D Tensor,数据类型为:bool、int32、int64、float32、float64、complex64、complex128。
16+
- **x** (Tensor) - 输入的 N-D Tensor,数据类型为:bool、int32、int64、float32、float64、complex64、complex128。别名 ``input``。
1717
- **source** (int|tuple|list) - 将被移动的轴的位置,其每个元素必须为不同的整数。
1818
- **destination** (int|tuple|list) - 轴被移动后的目标位置,其每个元素必须为不同的整数。
1919
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

docs/api/paddle/nan_to_num_cn.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,22 @@
33
nan_to_num
44
-------------------------------
55

6-
.. py:function:: paddle.nan_to_num(x, nan=0.0, posinf=None, neginf=None, name=None)
6+
.. py:function:: paddle.nan_to_num(x, nan=0.0, posinf=None, neginf=None, name=None, *, out=None)
77
88
替换 x 中的 NaN、+inf、-inf 为指定值。
99

1010
参数
1111
:::::::::
12-
- **x** (Tensor) - 输入变量,类型为 Tensor, 支持 float32、float64 数据类型。
12+
- **x** (Tensor) - 输入变量,类型为 Tensor, 支持 float32、float64 数据类型。别名 ``input``。
1313
- **nan** (float,可选) - NaN 的替换值,默认为 0。
1414
- **posinf** (float,可选) - +inf 的替换值,默认为 None,表示使用输入 Tensor 的数据类型所能表示的最大值作为 +inf 的替换值。
1515
- **neginf** (float,可选) - -inf 的替换值,默认为 None,表示使用输入 Tensor 的数据类型所能表示的最小值作为 -inf 的替换值。
1616
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为 None。
1717

18+
关键字参数
19+
:::::::::
20+
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。
21+
1822
返回
1923
:::::::::
2024
- Tensor (Tensor),将输入 Tensor 中的 NaN、+inf、-inf 替换后的结果。

docs/api/paddle/nanmean_cn.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,23 @@
33
nanmean
44
-------------------------------
55

6-
.. py:function:: paddle.nanmean(x, axis=None, keepdim=False, name=None)
6+
.. py:function:: paddle.nanmean(x, axis=None, keepdim=False, name=None, dtype=None, *, out=None)
77
88
99
1010
沿 ``axis`` 计算 ``x`` 的平均值,且忽略掉 ``NaNs`` 值。
1111

1212
参数
1313
::::::::::
14-
- **x** (Tensor) - 输入的 Tensor,数据类型为:bfloat16、float16、float32、float64。
15-
- **axis** (int|list|tuple,可选) - 指定对 ``x`` 进行计算的轴。``axis`` 可以是 int、list(int)、tuple(int)。如果 ``axis`` 包含多个维度,则沿着 ``axis`` 中的所有轴进行计算。``axis`` 或者其中的元素值应该在范围[-D, D)内,D 是 ``x`` 的维度。如果 ``axis`` 或者其中的元素值小于 0,则等价于 :math:`axis + D`。如果 ``axis`` 是 None,则对 ``x`` 的全部元素计算平均值。默认值为 None。
14+
- **x** (Tensor) - 输入的 Tensor,数据类型为:bfloat16、float16、float32、float64。别名 ``input``。
15+
- **axis** (int|list|tuple,可选) - 指定对 ``x`` 进行计算的轴。``axis`` 可以是 int、list(int)、tuple(int)。如果 ``axis`` 包含多个维度,则沿着 ``axis`` 中的所有轴进行计算。``axis`` 或者其中的元素值应该在范围[-D, D)内,D 是 ``x`` 的维度。如果 ``axis`` 或者其中的元素值小于 0,则等价于 :math:`axis + D`。如果 ``axis`` 是 None,则对 ``x`` 的全部元素计算平均值。默认值为 None。别名 ``dim``。
1616
- **keepdim** (bool,可选) - 是否在输出 Tensor 中保留减小的维度。如果 ``keepdim`` 为 True,则输出 Tensor 和 ``x`` 具有相同的维度(减少的维度除外,减少的维度的大小为 1)。否则,输出 Tensor 的形状会在 ``axis`` 上进行 squeeze 操作。默认值为 False。
1717
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
18+
- **dtype** (str|paddle.dtype|np.dtype,可选) - 输出 Tensor 的数据类型,若为 None,则与输入 ``x`` 相同,默认值为 None。
19+
20+
关键字参数
21+
::::::::::
22+
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。
1823

1924
返回
2025
::::::::::

docs/api/paddle/nansum_cn.rst

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

6-
.. py:function:: paddle.nansum(x, axis=None, dtype=None, keepdim=False, name=None)
6+
.. py:function:: paddle.nansum(x, axis=None, dtype=None, keepdim=False, name=None, *, out=None)
77
88
计算给定轴上的元素之和,并将非数字元素(NaNs)视为 0。
99

1010
参数
1111
:::::::::
12-
- **x** (Tensor) - 输入的 Tensor,数据类型为:bfloat16、float16、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。
12+
- **x** (Tensor) - 输入的 Tensor,数据类型为:bfloat16、float16、float32、float64、int32 或 int64。别名 ``input``。
13+
- **axis** (int|list|tuple,可选) - 求和运算的维度。如果为 None,则计算所有元素的和并返回包含单个元素的 Tensor 变量,否则必须在 :math:`[−rank(x),rank(x)]` 范围内。如果 :math:`axis [i] <0`,则维度将变为 :math:`rank+axis[i]`,默认值为 None。别名 ``dim``。
1414
- **dtype** (str|paddle.dtype|np.dtype,可选) - 输出变量的数据类型。若参数为空,则输出变量的数据类型和输入变量相同,默认值为 None。
1515
- **keepdim** (bool) - 是否在输出 Tensor 中保留减小的维度。如 keepdim 为 True,否则结果 Tensor 的维度将比输入 Tensor 小,默认值为 False。
1616
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
1717

18+
关键字参数
19+
:::::::::
20+
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。
21+
1822
返回
1923
:::::::::
2024
``Tensor``,在指定维度上进行求和运算的 Tensor,数据类型和输入数据类型一致。

docs/api/paddle/sgn_cn.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,21 @@
33
sgn
44
-------------------------------
55

6-
.. py:function:: paddle.sgn(x, name=None)
6+
.. py:function:: paddle.sgn(x, name=None, *, out=None)
77
88
对于复数 Tensor,此函数返回一个新的 Tensor,其元素与 input 元素的角度相同且绝对值为 1。
99

1010
对于实数 Tensor,对输入参数 ``x`` 中每个元素进行正负判断,并且输出正负判断值:1 代表正,-1 代表负,0 代表零。
1111

1212
参数
1313
::::::::::::
14-
- **x** (Tensor) – 输入 Tensor,数据类型为 float16、float32、float64、complex64 或 complex128。
14+
- **x** (Tensor) – 输入 Tensor,数据类型为 float16、float32、float64、complex64 或 complex128。别名 ``input``。
1515
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
1616

17+
关键字参数
18+
::::::::::::
19+
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。
20+
1721
返回
1822
::::::::::::
1923
Tensor,输出正负号或复数的单位向量,数据的 shape 大小及数据类型和输入 ``x`` 一致。

docs/api/paddle/signbit_cn.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,19 @@
33
signbit
44
-------------------------------
55

6-
.. py:function:: paddle.signbit(x, name=None)
6+
.. py:function:: paddle.signbit(x, name=None, *, out=None)
77
88
对输入参数 ``x`` 的每个元素判断是否设置了其符号位,并输出判断值。若存在符号位,则输出 True,否则输出 False。
99

1010
参数
1111
::::::::::::
12-
- **x** (Tensor) – 进行符号位判断的多维 Tensor,数据类型为 uint8,int8,int16,int32,int64,bfloat16,float16,float32 或 float64。
12+
- **x** (Tensor) – 进行符号位判断的多维 Tensor,数据类型为 uint8,int8,int16,int32,int64,bfloat16,float16,float32 或 float64。别名 ``input``。
1313
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
1414

15+
关键字参数
16+
::::::::::::
17+
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。
18+
1519
返回
1620
::::::::::::
1721
Tensor,输出掩码,数据的 shape 大小及数据类型和输入 ``x`` 一致。

docs/api/paddle/slice_scatter_cn.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ slice_scatter
1616

1717
参数
1818
:::::::::
19-
- **x** (Tensor) - 输入的 Tensor 作为目标矩阵,数据类型为: ``bool``、 ``float16``、 ``float32``、 ``float64``、 ``uint8``、 ``int8``、 ``int16``、 ``int32``、 ``int64``、 ``bfloat16``、 ``complex64``、 ``complex128``。
20-
- **value** (Tensor) - 需要插入的值,数据类型为: ``bool``、 ``float16``、 ``float32``、 ``float64``、 ``uint8``、 ``int8``、 ``int16``、 ``int32``、 ``int64``、 ``bfloat16``、 ``complex64``、 ``complex128``。
21-
- **axes** (list|tuple) - 指定沿着哪几个维度嵌入对应的值。
22-
- **starts** (list|tuple) - 嵌入的起始索引。
23-
- **ends** (list|tuple) - 嵌入的截止索引。
24-
- **strides** (list|tuple) - 嵌入的步长。
19+
- **x** (Tensor) - 输入的 Tensor 作为目标矩阵,数据类型为: ``bool``、 ``float16``、 ``float32``、 ``float64``、 ``uint8``、 ``int8``、 ``int16``、 ``int32``、 ``int64``、 ``bfloat16``、 ``complex64``、 ``complex128``。别名 ``input``。
20+
- **value** (Tensor) - 需要插入的值,数据类型为: ``bool``、 ``float16``、 ``float32``、 ``float64``、 ``uint8``、 ``int8``、 ``int16``、 ``int32``、 ``int64``、 ``bfloat16``、 ``complex64``、 ``complex128``。别名 ``src``。
21+
- **axes** (int|list|tuple) - 指定沿着哪几个维度嵌入对应的值。别名 ``dim``
22+
- **starts** (int|list|tuple) - 嵌入的起始索引。别名 ``start``
23+
- **ends** (int|list|tuple) - 嵌入的截止索引。别名 ``end``
24+
- **strides** (int|list|tuple) - 嵌入的步长。别名 ``step``
2525
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 ``None``。
2626

2727
返回

docs/api/paddle/take_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ take
1111
参数
1212
:::::::::
1313

14-
- **x** (Tensor) - 输入的 Tensor,支持 int32、int64、float32、float64 数据类型。
14+
- **x** (Tensor) - 输入的 Tensor,支持 int32、int64、float32、float64 数据类型。别名 ``input``。
1515
- **index** (Tensor) - 索引矩阵,支持 int32、int64 数据类型。
1616
- **mode** (str,可选) - 索引越界处理,可选 ``'raise'``,``'wrap'``,``'clip'``,默认为 ``'raise'``。
1717

0 commit comments

Comments
 (0)