Skip to content

Commit 0373c49

Browse files
committed
[API Compatibility] iinfo/cummax/cummin/diagflat/ldexp/inner/positive/rad2deg/rot90/nanquantile/neg/erf Edit By AI Agent
1 parent 3aadf0d commit 0373c49

17 files changed

Lines changed: 107 additions & 89 deletions

docs/api/paddle/cummax_cn.rst

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,35 @@
33
cummax
44
-------------------------------
55

6-
.. py:function:: paddle.cummax(x, axis=None, dtype='int64', name=None)
6+
.. py:function:: paddle.cummax(x, axis=None, dtype='int64', name=None, *, out=None)
77
88
沿给定 ``axis`` 计算 Tensor ``x`` 的累积最大值。
99

10+
本 API 支持两种调用方式:
11+
12+
1. **Paddle 风格**: ``paddle.cummax(x, axis=None, dtype='int64', name=None)``
13+
``axis`` 参数可选,默认为 ``None``。
14+
15+
2. **PyTorch 风格**: ``paddle.cummax(input, dim, *, out=None)``
16+
``dim`` 参数必选。参数名 ``input`` 是 ``x`` 的别名,``dim`` 是 ``axis`` 的别名。
17+
1018
.. note::
1119
结果的第一个元素和输入的第一个元素相同。
1220

1321
参数
1422
::::::::::
15-
- **x** (Tensor) - 需要进行累积最大值操作的 Tensor。
16-
- **axis** (int,可选) - 指明需要累积最大值的维度。-1 代表最后一维。默认:None,将输入展开为一维变量再进行累积最大值计算。
23+
- **x** (Tensor) - 需要进行累积最大值操作的 Tensor。别名 ``input``。
24+
- **axis** (int,可选) - 指明需要累积最大值的维度。-1 代表最后一维。默认:None,将输入展开为一维变量再进行累积最大值计算。别名 ``dim``。
1725
- **dtype** (str|paddle.dtype|np.dtype,可选) - 输出 Indices 的数据类型,可以是 int32、int64,默认值为 int64。
1826
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为 None。
1927

28+
关键字参数
29+
::::::::::
30+
- **out** (tuple[Tensor, Tensor],可选) - 输出 Tensor 元组,包含两个 Tensor (values, indices)。若不为 ``None``,计算结果将保存在该 Tensor 元组中,默认值为 ``None``。
31+
2032
返回
2133
::::::::::
22-
- ``out`` (Tensor):返回累积最大值操作的结果,累积最大值结果类型和输入 x 相同。
34+
- ``values`` (Tensor):返回累积最大值操作的结果,累积最大值结果类型和输入 x 相同。
2335
- ``indices`` (Tensor):返回对应累积最大值操作的索引结果。
2436

2537
代码示例

docs/api/paddle/cummin_cn.rst

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,35 @@
33
cummin
44
-------------------------------
55

6-
.. py:function:: paddle.cummin(x, axis=None, dtype='int64', name=None)
6+
.. py:function:: paddle.cummin(x, axis=None, dtype='int64', name=None, *, out=None)
77
88
沿给定 ``axis`` 计算 Tensor ``x`` 的累积最小值。
99

10+
本 API 支持两种调用方式:
11+
12+
1. **Paddle 风格**: ``paddle.cummin(x, axis=None, dtype='int64', name=None)``
13+
``axis`` 参数可选,默认为 ``None``。
14+
15+
2. **PyTorch 风格**: ``paddle.cummin(input, dim, *, out=None)``
16+
``dim`` 参数必选。参数名 ``input`` 是 ``x`` 的别名,``dim`` 是 ``axis`` 的别名。
17+
1018
.. note::
1119
结果的第一个元素和输入的第一个元素相同。
1220

1321
参数
1422
::::::::::
15-
- **x** (Tensor) - 需要进行累积最小值操作的 Tensor。
16-
- **axis** (int,可选) - 指明需要累积最小值的维度。-1 代表最后一维。默认:None,将输入展开为一维变量再进行累积最小值计算。
23+
- **x** (Tensor) - 需要进行累积最小值操作的 Tensor。别名 ``input``。
24+
- **axis** (int,可选) - 指明需要累积最小值的维度。-1 代表最后一维。默认:None,将输入展开为一维变量再进行累积最小值计算。别名 ``dim``。
1725
- **dtype** (str|paddle.dtype|np.dtype,可选) - 输出 Indices 的数据类型,可以是 int32、int64,默认值为 int64。
1826
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为 None。
1927

28+
关键字参数
29+
::::::::::
30+
- **out** (tuple[Tensor, Tensor],可选) - 输出 Tensor 元组,包含两个 Tensor (values, indices)。若不为 ``None``,计算结果将保存在该 Tensor 元组中,默认值为 ``None``。
31+
2032
返回
2133
::::::::::
22-
- ``out`` (Tensor):返回累积最小值操作的结果,累积最小值结果类型和输入 x 相同。
34+
- ``values`` (Tensor):返回累积最小值操作的结果,累积最小值结果类型和输入 x 相同。
2335
- ``indices`` (Tensor):返回对应累积最小值操作的索引结果。
2436

2537
代码示例

docs/api/paddle/diagflat_cn.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ diagflat
55

66
.. py:function:: paddle.diagflat(x, offset=0, name=None)
77
8-
98
如果 ``x`` 是一维 Tensor,则返回带有 ``x`` 元素作为对角线的二维方阵。
109

1110
如果 ``x`` 是大于等于二维的 Tensor,则返回一个二维方阵,其对角线元素为 ``x`` 在连续维度展开得到的一维 Tensor 的元素。
@@ -18,8 +17,8 @@ diagflat
1817

1918
参数
2019
:::::::::
21-
- **x** (Tensor) - 输入的 ``Tensor``。它的形状可以是任意维度。其数据类型应为 float16float32float64int32int64。
22-
- **offset** (int,可选) - 对角线偏移量。正值表示上对角线,0 表示主对角线,负值表示下对角线。
20+
- **x** (Tensor) - 输入的 ``Tensor``。它的形状可以是任意维度。其数据类型应为 float16float32float64int32int64。别名:``input``
21+
- **offset** (int,可选) - 对角线偏移量。正值表示上对角线,0 表示主对角线,负值表示下对角线。默认值为 0。
2322
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
2423

2524
返回

docs/api/paddle/diagonal_scatter_cn.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ diagonal_scatter
55

66
.. py:function:: paddle.diagonal_scatter(x, y, offset=0, axis1=0, axis2=1, name=None)
77
8-
98
根据参数 ``offset``、``axis1``、``axis2``,将张量 ``y`` 填充到张量 ``x`` 的对应位置。
109

1110
这个函数将会返回一个新的 ``Tensor``。
@@ -25,11 +24,11 @@ diagonal_scatter
2524
参数
2625
::::::::::::
2726

28-
- **x** (Tensor) - 输入张量,张量的维度至少为 2 维,支持 float16、float32、float64、bfloat16、uint8、int8、int16、int32、int64、bool、complex64、complex128 数据类型。
29-
- **y** (Tensor) - 嵌入张量,将会被嵌入到输入张量中,支持 float16、float32、float64、bfloat16、uint8、int8、int16、int32、int64、bool、complex64、complex128 数据类型。
27+
- **x** (Tensor) - 输入张量,张量的维度至少为 2 维,支持 float16、float32、float64、bfloat16、uint8、int8、int16、int32、int64、bool、complex64、complex128 数据类型。别名:``input``。
28+
- **y** (Tensor) - 嵌入张量,将会被嵌入到输入张量中,支持 float16、float32、float64、bfloat16、uint8、int8、int16、int32、int64、bool、complex64、complex128 数据类型。别名:``src``。
3029
- **offset** (int,可选) - 从指定的二维平面嵌入对角线的位置,默认值为 0,即主对角线。
31-
- **axis1** (int,可选) - 对角线的第一个维度,默认值为 0。
32-
- **axis2** (int,可选) - 对角线的第二个维度,默认值为 1。
30+
- **axis1** (int,可选) - 对角线的第一个维度,默认值为 0。别名:``dim1``。
31+
- **axis2** (int,可选) - 对角线的第二个维度,默认值为 1。别名:``dim2``。
3332
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
3433

3534
返回

docs/api/paddle/erf__cn.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ erf\_
44
-------------------------------
55

66
.. py:function:: paddle.erf_(x, name=None)
7+
78
Inplace 版本的 :ref:`cn_api_paddle_erf` API,对输入 x 采用 Inplace 策略。
89

910
更多关于 inplace 操作的介绍请参考 `3.1.3 原位(Inplace)操作和非原位操作的区别`_ 了解详情。

docs/api/paddle/erf_cn.rst

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,25 @@
33
erf
44
-------------------------------
55

6-
.. py:function:: paddle.erf(x, name = None)
6+
.. py:function:: paddle.erf(x, name=None)
77
8+
逐元素计算 Erf 激活函数。
89

9-
10-
11-
逐元素计算 Erf 激活函数。更多细节请参考 `Error function <https://en.wikipedia.org/wiki/Error_function>`_ 。
12-
10+
更多细节请参考 `Error function <https://en.wikipedia.org/wiki/Error_function>`_。
1311

1412
.. math::
1513
out = \frac{2}{\sqrt{\pi}} \int_{0}^{x}e^{- \eta^{2}}d\eta
1614
1715
参数
1816
::::::::::::
1917

20-
- **x** (Tensor) - 输入的多维 Tensor,数据类型为 float16、float32float64。
21-
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
18+
- **x** (Tensor) - 输入 Tensor,数据类型为 float32float64、uint8、int8、int16、int32、int64。别名: ``input``
19+
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 ``None``
2220

2321
返回
2422
::::::::::::
2523

26-
- 多维 Tensor,数据类型为 float16、float32 或 float64,和输入 x 的数据类型相同,形状和输入 x 相同。
27-
24+
Tensor,数据类型为 float32 或 float64(整数类型会自动转换为 float32),形状与输入 ``x`` 相同。
2825

2926
代码示例
3027
::::::::::::

docs/api/paddle/iinfo_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ iinfo
1414

1515
参数
1616
:::::::::
17-
- **dtype** (paddle.dtype|str) - 输入的数据类型,可以是:paddle.uint8、 paddle.int8、 paddle.int16、 paddle.int32、 paddle.int64 或这些类型的字符串形式。
17+
- **dtype** (paddle.dtype|str) - 输入的数据类型,可以是:paddle.uint8、 paddle.int8、 paddle.int16、 paddle.int32、 paddle.int64 或这些类型的字符串形式。别名 ``type``。
1818

1919
返回
2020
:::::::::

docs/api/paddle/inner_cn.rst

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

6-
.. py:function:: paddle.inner(x, y, name=None)
7-
6+
.. py:function:: paddle.inner(x, y, name=None, *, out=None)
87
98
计算两个 Tensor 的内积。
109

@@ -13,10 +12,15 @@ inner
1312
参数
1413
::::::::::::
1514

16-
- **x** (Tensor) - 一个 N 维 Tensor 或者标量 Tensor,如果是 N 维 Tensor 最后一个维度长度需要跟 y 保持一致。
17-
- **y** (Tensor) - 一个 N 维 Tensor 或者标量 Tensor,如果是 N 维 Tensor 最后一个维度长度需要跟 x 保持一致。
15+
- **x** (Tensor) - 一个 N 维 Tensor 或者标量 Tensor,如果是 N 维 Tensor 最后一个维度长度需要跟 y 保持一致。别名 ``input``。
16+
- **y** (Tensor) - 一个 N 维 Tensor 或者标量 Tensor,如果是 N 维 Tensor 最后一个维度长度需要跟 x 保持一致。别名 ``other``。
1817
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
1918

19+
关键字参数
20+
:::::::::
21+
22+
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。
23+
2024
返回
2125
::::::::::::
2226

docs/api/paddle/ldexp_cn.rst

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

6-
.. py:function:: paddle.ldexp(x, y, name=None)
6+
.. py:function:: paddle.ldexp(x, y, name=None, *, out=None)
77
88
计算 ``x`` 乘以 2 的 ``y`` 次幂
99

@@ -13,10 +13,14 @@ ldexp
1313
参数
1414
::::::::::::
1515

16-
- **x** (Tensor) - 多维 Tensor。数据类型为 float32、float64、int32、int64。
17-
- **y** (Tensor) - 多维 Tensor。通常为整数。
16+
- **x** (Tensor) - 多维 Tensor。数据类型为 float32、float64、int32、int64。别名:``input``。
17+
- **y** (Tensor) - 多维 Tensor。通常为整数。别名:``other``。
1818
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
1919

20+
关键字参数
21+
:::::::::
22+
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。
23+
2024
返回
2125
::::::::::::
2226
输出为 Tensor,如果 ``x``, ``y`` 有不同的形状并且是可广播的,那么产生的张量形状是广播后 x 和 y 的形状。如果 ``x``, ``y`` 有相同的形状,其形状与 ``x``, ``y`` 相同。数据类型是 float32 或 float64。

docs/api/paddle/nanquantile_cn.rst

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

6-
.. py:function:: paddle.nanquantile(x, q, axis=None, keepdim=False, interpolation='linear', name=None)
6+
.. py:function:: paddle.nanquantile(x, q, axis=None, keepdim=False, interpolation='linear', name=None, *, out=None)
77
88
沿给定的轴 ``axis`` 计算 ``x`` 中元素的分位数, 忽略元素中的 ``NaN`` 。
99

1010
参数
1111
::::::::::
12-
- **x** (Tensor) - 输入的 Tensor,数据类型为:bfloat16、float16、float32、float64。
12+
- **x** (Tensor) - 输入的 Tensor,数据类型为:bfloat16、float16、float32、float64、int32、int64。别名:``input``
1313
- **q** (int|float|list|Tensor) - 待计算的分位数,需要在符合取值范围[0, 1]。如果 ``q`` 是 List 或者 1-D Tensor,其中的每一个 q 分位数都会被计算,并且输出的首维大小与列表或 Tensor 中元素的数量相同。如果 ``q`` 是 0-D Tensor ,则会被当作 float 和 int 对待。
14-
- **axis** (int|list,可选) - 指定对 ``x`` 进行计算的轴。``axis`` 可以是 int 或内部元素为 int 类型的 list。``axis`` 值应该在范围[-D, D)内,D 是 ``x`` 的维度。如果 ``axis`` 或者其中的元素值小于 0,则等价于 :math:`axis + D`。如果 ``axis`` 是 list,对给定的轴上的所有元素计算分位数。如果 ``axis`` 是 None,则对 ``x`` 的全部元素计算分位数。默认值为 None。
14+
- **axis** (int|list,可选) - 指定对 ``x`` 进行计算的轴。``axis`` 可以是 int 或内部元素为 int 类型的 list。``axis`` 值应该在范围[-D, D)内,D 是 ``x`` 的维度。如果 ``axis`` 或者其中的元素值小于 0,则等价于 :math:`axis + D`。如果 ``axis`` 是 list,对给定的轴上的所有元素计算分位数。如果 ``axis`` 是 None,则对 ``x`` 的全部元素计算分位数。默认值为 None。别名:``dim``。
1515
- **keepdim** (bool,可选) - 是否在输出 Tensor 中保留减小的维度。如果 ``keepdim`` 为 True,则输出 Tensor 和 ``x`` 具有相同的维度(减少的维度除外,减少的维度的大小为 1)。否则,输出 Tensor 的形状会在 ``axis`` 上进行 squeeze 操作。默认值为 False。
1616
- **interpolation** (str,可选) - 计算分位数的插值方法,可以是 ``linear`` , ``lower`` , ``higher`` , ``nearest`` 或者 ``midpoint`` 。 默认值为 ``linear`` 。
1717
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
1818

19+
关键字参数
20+
::::::::::
21+
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。
22+
1923
返回
2024
::::::::::
2125
``Tensor``,沿着 ``axis`` 进行分位数计算的结果。与输入数据类型一致。

0 commit comments

Comments
 (0)