Skip to content

Commit e16f31d

Browse files
committed
[API Compatibility] squeeze/unsqueeze/pow_/remainder_/bernoulli/combinations/trapezoid/frexp/lgamma/kron/kthvalue/poisson/mode/mv Edit By AI Agent
1 parent c41d753 commit e16f31d

32 files changed

Lines changed: 1031 additions & 876 deletions

docs/api/paddle/atan2_cn.rst

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

6-
.. py:function:: paddle.atan2(x, y, name=None)
6+
.. py:function:: paddle.atan2(x, y, name=None, *, out=None)
77
88
99
@@ -23,10 +23,14 @@ atan2
2323
参数
2424
:::::::::
2525

26-
- **x** (Tensor) - 输入的 Tensor,数据类型为:int32、int64、float16、float32、float64。
27-
- **y** (Tensor) - 输入的 Tensor,数据类型为:int32、int64、float16、float32、float64。
26+
- **x** (Tensor) - 输入的 Tensor,数据类型为:int32、int64、float16、float32、float64。别名 ``input`` 。
27+
- **y** (Tensor) - 输入的 Tensor,数据类型为:int32、int64、float16、float32、float64。别名 ``other`` 。
2828
- **name** (str,可选) - 操作的名称(可选,默认值为 None)。更多信息请参见 :ref:`api_guide_Name`。
2929

30+
关键字参数
31+
:::::::::
32+
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。
33+
3034
返回
3135
:::::::::
3236

docs/api/paddle/bernoulli_cn.rst

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

6-
.. py:function:: paddle.bernoulli(x, p=None, name=None)
6+
.. py:function:: paddle.bernoulli(x, p=None, name=None, *, out=None)
77
88
对输入 ``x`` 的每一个元素 :math:`x_i`,从以 :math:`x_i` 为参数的伯努利分布(又名两点分布或者 0-1 分布)中抽取一个样本。以 :math:`x_i` 为参数的伯努利分布的概率密度函数是
99

@@ -16,9 +16,14 @@ bernoulli
1616
参数
1717
::::::::::::
1818

19-
- **x** (Tensor) - 输入的 Tensor,数据类型为 float32、float64、int32 或 int64。
20-
- **p** (float,可选) - 若指定 ``p``,伯努利分布的参数将全部设为 ``p``。默认值为 None,此时伯努利分布的参数由 ``x`` 决定。
21-
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
19+
- **x** (Tensor) - 输入的 Tensor,数据类型为 float32、float64。别名 ``input``。
20+
- **p** (float|None,可选) - 若指定 ``p``,伯努利分布的参数将全部设为 ``p``。默认值为 None,此时伯努利分布的参数由 ``x`` 决定。
21+
- **name** (str|None,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
22+
23+
关键字参数
24+
::::::::::::
25+
26+
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。
2227

2328
返回
2429
::::::::::::

docs/api/paddle/combinations_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ combinations
1010

1111
参数
1212
::::::::::
13-
- **x** (Tensor) - 输入 1-D Tensor ,它的数据类型可以是 float16,float32,float64,int32,int64。
13+
- **x** (Tensor) - 输入 1-D Tensor ,它的数据类型可以是 float16,float32,float64,int32,int64。别名 ``input``。
1414
- **r** (int,可选) - 组合的数长度,默认值为 2。
1515
- **with_replacement** (bool,可选) - 是否允许组合数中出现重复值,默认不允许,默认值为 False。
1616
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为 None。

docs/api/paddle/count_nonzero_cn.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ count_nonzero
1212
- **x** (Tensor) - 输入的 Tensor,数据类型为:bool、float16、float32、float64、int32、int64。别名:``input``。
1313
- **axis** (None|int|list|tuple,可选) - 指定对 ``x`` 进行统计的轴。``axis`` 可以是 int 或 int 元素的列表/元组。``axis`` 值应该在范围[-D,D)内,D 是 ``x`` 的维度。如果 ``axis`` 或其中的元素值小于 0,则等价于 :math:`axis + D`。如果 ``axis`` 是 None,则对 ``x`` 的全部元素进行统计。默认值为 None。别名:``dim``。
1414
- **keepdim** (bool,可选) - 是否在输出 Tensor 中保留被统计的维度。如果 ``keepdim`` 为 True,则输出 Tensor 和 ``x`` 具有相同的维度(被统计的维度大小为 1);否则,输出 Tensor 会在 ``axis`` 上进行 squeeze 操作。默认值为 False。
15-
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
16-
1715

1816
返回
1917
::::::::::

docs/api/paddle/cumulative_trapezoid_cn.rst

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

6-
.. py:function:: paddle.cumulative_trapezoid(y, x=None, dx=None, axis=-1, name=None)
6+
.. py:function:: paddle.cumulative_trapezoid(y, x=None, dx=None, axis=-1, name=None, *, out=None)
77
88
在指定维度上对输入实现 `trapezoid rule <https://en.wikipedia.org/wiki/Trapezoidal_rule>`_ 算法。与 :ref:`cn_api_paddle_trapezoid` 的区别是,所用累积求和函数为 cumsum。
99

@@ -14,8 +14,14 @@ cumulative_trapezoid
1414
- **y** (Tensor) - 输入多维 Tensor,可选的数据类型为 float16、float32、float64。
1515
- **x** (Tensor,可选) - ``y`` 中数值对应的浮点数所组成的 Tensor,类型与 ``y`` 相同,形状与 ``y`` 的形状相匹配;若 ``x`` 有输入,已知 ``y`` 的尺寸为 `[d_1, d_2, ... , d_n]` 且 `axis=k`,则 ``x`` 的尺寸只能为 `[d_k]` 或 `[d_1, d_2, ... , d_n]`;如果 ``x`` 为 None,则假定采样点均匀分布 ``dx``。
1616
- **dx** (float,可选) - 相邻采样点之间的常数间隔;当 ``x`` 和 ``dx`` 均未指定时,``dx`` 默认为 1.0。
17-
- **axis** (int,可选) - 计算 trapezoid rule 时 ``y`` 的维度。默认值 -1。
17+
- **axis** (int,可选) - 计算 trapezoid rule 时 ``y`` 的维度。默认值 -1。别名 ``dim``。
1818
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
19+
20+
关键字参数
21+
:::::::::
22+
23+
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。
24+
1925
返回
2026
:::::::::
2127
Tensor,按 trapezoidal rule 计算出 ``y`` 等于 N 维张量时的定积分,结果为 N 维张量。

docs/api/paddle/floor_divide__cn.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,12 @@ floor_divide\_
44
-------------------------------
55

66
.. py:function:: paddle.floor_divide_(x, y, name=None)
7-
Inplace 版本的 :ref:`cn_api_paddle_floor_divide` API,对输入 x 采用 Inplace 策略。
7+
8+
Inplace 版本的 :ref:`cn_api_paddle_floor_divide` API,对输入 `x` 采用 Inplace 策略。
89

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

1112
.. _3.1.3 原位(Inplace)操作和非原位操作的区别: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/beginner/tensor_cn.html#id3
13+
14+
.. note::
15+
别名支持: 参数名 ``input`` 可替代 ``x``,参数名 ``other`` 可替代 ``y``,如 ``floor_divide_(input=tensor_x, other=tensor_y)`` 等价于 ``floor_divide_(x=tensor_x, y=tensor_y)``。

docs/api/paddle/frexp_cn.rst

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

6-
.. py:function:: paddle.frexp(x, name)
6+
.. py:function:: paddle.frexp(x, name=None, *, out=None)
77
8-
9-
用于把一个浮点数分解为尾数和指数的函数,返回一个尾数 Tensor 和一个指数 Tensor
8+
用于把一个浮点数分解为尾数和指数的函数,返回一个尾数 Tensor 和一个指数 Tensor。
109

1110
参数
1211
::::::::::
13-
- **x** (Tensor) – 输入是一个多维的 Tensor,它的数据类型可以是 float32,float64。
12+
- **x** (Tensor) – 输入是一个多维的 Tensor,它的数据类型可以是 float32,float64。别名 ``input``。
1413
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为 None。
14+
15+
关键字参数
16+
::::::::::
17+
- **out** (tuple[Tensor, Tensor],可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 元组中,默认值为 ``None``。
18+
1519
返回
1620
::::::::::
1721
mantissa(Tensor):分解后的尾数,类型为 Tensor,形状和原输入的形状一致。

docs/api/paddle/isneginf_cn.rst

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

6-
.. py:function:: paddle.isneginf(x, name=None)
6+
.. py:function:: paddle.isneginf(x, name=None, *, out=None)
77
88
返回输入 tensor 的每一个值是否为 `-INF` 。
99

1010
参数
1111
:::::::::
12-
- **x** (Tensor):输入的 `Tensor`,数据类型为:float16、float32、float64、int8、int16、int32、int64、uint8。
12+
- **x** (Tensor):输入的 `Tensor`,数据类型为:float16、float32、float64、int8、int16、int32、int64、uint8。别名: ``input``。
1313
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
1414

15+
关键字参数
16+
:::::::::
17+
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。
18+
1519
返回
1620
:::::::::
1721
``Tensor``,每个元素是一个 bool 值,表示输入 `x` 的每个元素是否为 `-INF` 。

docs/api/paddle/isposinf_cn.rst

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

6-
.. py:function:: paddle.isposinf(x, name=None)
6+
.. py:function:: paddle.isposinf(x, name=None, *, out=None)
77
88
返回输入 tensor 的每一个值是否为 `+INF` 。
99

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

15+
关键字参数
16+
:::::::::
17+
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。
18+
1519
返回
1620
:::::::::
1721
``Tensor``,每个元素是一个 bool 值,表示输入 `x` 的每个元素是否为 `+INF` 。

docs/api/paddle/isreal_cn.rst

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ isreal
1010

1111
参数
1212
:::::::::
13-
- **x** (Tensor) - 输入 Tensor。
13+
- **x** (Tensor) - 输入 Tensor。别名: ``input``。
1414
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
1515

1616
返回
@@ -21,4 +21,22 @@ isreal
2121
代码示例
2222
:::::::::
2323

24-
COPY-FROM: paddle.isreal
24+
.. code-block:: python
25+
26+
>>> import paddle
27+
28+
>>> x = paddle.to_tensor([-0.0, -2.1, 2.5], dtype='float32')
29+
>>> # 使用参数别名 input
30+
>>> print(paddle.isreal(input=x))
31+
Tensor(shape=[3], dtype=bool, place=Place(cpu), stop_gradient=True,
32+
[True, True, True])
33+
34+
>>> x = paddle.to_tensor([(-0.0 + 1j), (-2.1 + 0.2j), (2.5 - 3.1j)])
35+
>>> print(paddle.isreal(x))
36+
Tensor(shape=[3], dtype=bool, place=Place(cpu), stop_gradient=True,
37+
[False, False, False])
38+
39+
>>> x = paddle.to_tensor([(-0.0 + 1j), (-2.1 + 0j), (2.5 - 0j)])
40+
>>> print(paddle.isreal(x))
41+
Tensor(shape=[3], dtype=bool, place=Place(cpu), stop_gradient=True,
42+
[False, True, True])

0 commit comments

Comments
 (0)