Skip to content

Commit 50ee4de

Browse files
committed
[API compatibility] Update 9 API Docs
1 parent abb0557 commit 50ee4de

File tree

9 files changed

+104
-7
lines changed

9 files changed

+104
-7
lines changed

docs/api/paddle/Tensor_cn.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -495,7 +495,7 @@ acos(name=None)
495495

496496
请参考 :ref:`cn_api_paddle_acos`
497497

498-
add(y, name=None)
498+
add(y, name=None, \*, alpha=1, out=None)
499499
:::::::::
500500

501501
返回:计算后的 Tensor
@@ -504,7 +504,7 @@ add(y, name=None)
504504

505505
请参考 :ref:`cn_api_paddle_add`
506506

507-
add_(y, name=None)
507+
add_(y, name=None, \*, alpha=1, out=None)
508508
:::::::::
509509

510510
Inplace 版本的 :ref:`cn_api_paddle_add` API,对输入 `x` 采用 Inplace 策略。
@@ -1025,7 +1025,7 @@ dist(y, p=2)
10251025

10261026
请参考 :ref:`cn_api_paddle_dist`
10271027

1028-
divide(y, name=None)
1028+
divide(y, name=None, \*, rounding_mode=None, out=None)
10291029
:::::::::
10301030

10311031
返回:计算后的 Tensor

docs/api/paddle/add_cn.rst

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

6-
.. py:function:: paddle.add(x, y, name=None)
6+
.. py:function:: paddle.add(x, y, name=None, *, alpha=1, out=None)
77
88
99
1010
逐元素相加算子,输入 ``x`` 与输入 ``y`` 逐元素相加,并将各个位置的输出元素保存到返回结果中。
1111

1212
.. note::
13+
别名支持: 参数名 ``input`` 可替代 ``x``,参数名 ``other`` 可替代 ``y`` ,如 ``add(input=tensor_x, other=tensor_y, ...)`` 等价于 ``add(x=tensor_x, y=tensor_y, ...)`` 。
1314
输入 ``x`` 与输入 ``y`` 必须和广播为相同形状,关于广播规则,请参见 `Tensor 介绍`_ .
1415

1516
.. _Tensor 介绍: ../../guides/beginner/tensor_cn.html#id7
1617

18+
1719
等式为:
1820

1921
.. math::
20-
Out = X + Y
22+
Out = X + alpha \times Y
2123
2224
- :math:`X`:多维 Tensor。
2325
- :math:`Y`:多维 Tensor。
@@ -30,8 +32,12 @@ add
3032
参数
3133
:::::::::
3234
- **x** (Tensor) - 输入的 Tensor,数据类型为:bool、bfloat16、float16、float32、float64、int8、int16、int32、int64、uint8、complex64、complex128。
35+
``别名: input``
3336
- **y** (Tensor) - 输入的 Tensor,数据类型为:bool、bfloat16、float16、float32、float64、int8、int16、int32、int64、uint8、complex64、complex128。
37+
``别名: other``
3438
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
39+
- **alpha** (Number, 可选) - 对 ``y`` 的缩放因子。默认值:1。
40+
- **out** (Tensor, 可选) - 输出 Tensor。默认值:None。
3541

3642
返回
3743
:::::::::

docs/api/paddle/div.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.. _cn_api_paddle_div:
2+
3+
div
4+
-------------------------------
5+
6+
.. py:function:: paddle.div(x, y, name=None, *, rounding_mode=None, out=None)
7+
别名函数,功能与 :ref:`cn_api_paddle_divide` 完全相同,详情请参考 :ref:`cn_api_paddle_divide` 。

docs/api/paddle/div_.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. _cn_api_paddle_div_:
2+
3+
div\_
4+
-------------------------------
5+
6+
.. py:function:: paddle.div_(x, y, name=None, *, rounding_mode=None, out=None)
7+
Inplace 版本的 :ref:`cn_api_paddle_div` API,对输入 x 采用 Inplace 策略。
8+
9+
更多关于 inplace 操作的介绍请参考 `3.1.3 原位(Inplace)操作和非原位操作的区别`_ 了解详情。
10+
11+
.. _3.1.3 原位(Inplace)操作和非原位操作的区别: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/beginner/tensor_cn.html#id3

docs/api/paddle/divide__cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
divide\_
44
-------------------------------
55

6-
.. py:function:: paddle.divide_(x, y, name=None)
6+
.. py:function:: paddle.divide_(x, y, name=None, *, rounding_mode=None, out=None)
77
Inplace 版本的 :ref:`cn_api_paddle_divide` API,对输入 x 采用 Inplace 策略。
88

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

docs/api/paddle/divide_cn.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@
33
divide
44
-------------------------------
55

6-
.. py:function:: paddle.divide(x, y, name=None)
6+
.. py:function:: paddle.divide(x, y, name=None, *, rounding_mode=None, out=None)
77
88
逐元素相除算子,输入 ``x`` 与输入 ``y`` 逐元素相除,并将各个位置的输出元素保存到返回结果中。
99

1010
.. note::
11+
别名支持: 参数名 ``input`` 可替代 ``x``,参数名 ``other`` 可替代 ``y`` ,如 ``divide(input=tensor_x, other=tensor_y, ...)`` 等价于 ``divide(x=tensor_x, y=tensor_y, ...)`` 。
1112
输入 ``x`` 与输入 ``y`` 必须和广播为相同形状,关于广播规则,请参见 `Tensor 介绍`_ .
1213

1314
.. _Tensor 介绍: ../../guides/beginner/tensor_cn.html#id7
@@ -23,8 +24,12 @@ divide
2324
参数
2425
:::::::::
2526
- **x** (Tensor) - 多维 Tensor。数据类型为 bool、bfloat16、float16、float32、float64、int8、int16、int32、int64、uint8、complex64、complex128。
27+
``别名: input``
2628
- **y** (Tensor) - 多维 Tensor。数据类型为 bool、bfloat16、float16、float32、float64、int8、int16、int32、int64、uint8、complex64、complex128。
29+
``别名: other``
2730
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
31+
- **rounding_mode** (str,可选) - 舍入模式。可选值为 None(默认)、"trunc"(向零截断)或 "floor"(向负无穷舍入)。
32+
- **out** (Tensor,可选) - 输出 Tensor。默认值为 None。
2833

2934

3035
返回
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
.. _cn_api_paddle_nn_functional_dropout1d:
2+
3+
dropout1d
4+
-------------------------------
5+
6+
.. py:function:: paddle.nn.functional.dropout1d(x, p=0.5, training=True, inplace=False)
7+
根据丢弃概率 ``p``,在训练过程中随机将某些 1D 通道置 0(对一个形状为 ``[N, C, L]`` 的 3D Tensor 或 ``[C, L]`` 的 2D Tensor,1D 通道指的是其中的形状为 ``L`` 的 1 维特征图)。
8+
9+
参数
10+
:::::::::
11+
- **x** (Tensor) - 形状为 ``[N, C, L]`` 的 3D Tensor 或 ``[C, L]`` 的 2D Tensor,数据类型为 float16、float32 或 float64。
12+
- **p** (float,可选) - 将输入通道置 0 的概率,即丢弃概率。默认值为 0.5。
13+
- **training** (bool,可选) - 标记是否为训练阶段。若为 False,则直接返回输入。默认值为 True。
14+
- **inplace** (bool,可选) - 是否原地操作。当前版本暂未实现(行为等同于 False),未来版本将支持。默认值为 False。
15+
16+
返回
17+
:::::::::
18+
与输入 ``x`` 形状相同的 ``Tensor``。
19+
20+
代码示例
21+
:::::::::
22+
23+
.. code-block:: python
24+
import paddle
25+
# Case 1: 3D input (batched)
26+
x = paddle.randn([2, 3, 10]) # [N, C, L]
27+
y_train = paddle.nn.functional.dropout1d(x, p=0.2)
28+
y_test = paddle.nn.functional.dropout1d(x, p=0.2, training=False)
29+
print("Original first channel:", x[0, 0, :])
30+
print("Train output (may be zeroed):", y_train[0, 0, :])
31+
print("Test output (always unchanged):", y_test[0, 0, :])
32+
# Case 2: 2D input (single sample)
33+
x = paddle.randn([3, 8]) # [C, L]
34+
y = paddle.nn.functional.dropout1d(x, p=0.5)
35+
print("Input shape:", x.shape)
36+
print("Output shape:", y.shape)
37+
print("Zeroed channels count:", paddle.sum(y == 0).item())
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
.. _cn_api_paddle_nn_parameter_Parameter:
2+
3+
Parameter
4+
-------------------------------
5+
6+
.. py:class:: paddle.nn.parameter.Parameter(data=None, requires_grad=True)
7+
一种被视为模型参数的 Tensor。
8+
9+
Parameter 是 Tensor 的子类,当与 ``Layer`` 一起使用时具有特殊行为 - 当被赋值给 Layer 的属性时,会自动添加到该层的参数列表中。普通 Tensor 不会有此效果。
10+
11+
参数
12+
:::::::::
13+
- **data** (Tensor,可选) - 参数的 Tensor 数据。如果为 None,则创建一个未初始化的参数。默认值:None。
14+
- **requires_grad** (bool,可选) - 是否需要计算梯度。注意 ``paddle.no_grad()`` 不会影响 Parameter 的默认创建行为(在 no_grad 模式下仍会保持 ``requires_grad=True``)。默认值:True。
15+
16+
代码示例
17+
:::::::::
18+
19+
.. code-block:: python
20+
import paddle
21+
weight = paddle.nn.parameter.Parameter(
22+
data=paddle.randn([10, 10]),
23+
requires_grad=True
24+
)

docs/api/paddle/true_divide.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.. _cn_api_paddle_true_divide:
2+
3+
true_divide
4+
-------------------------------
5+
6+
.. py:function:: paddle.true_divide(input, other, *, out=None)
7+
别名函数,功能与 :ref:`cn_api_paddle_divide` (设置 `rounding_mode=None` 时)完全相同,详情请参考 :ref:`cn_api_paddle_divide` 。

0 commit comments

Comments
 (0)