Skip to content

[API compatibility] Update 9 API Docs #7394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/api/paddle/Tensor_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -495,7 +495,7 @@ acos(name=None)

请参考 :ref:`cn_api_paddle_acos`

add(y, name=None)
add(y, name=None, \*, alpha=1, out=None)
:::::::::

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

请参考 :ref:`cn_api_paddle_add`

add_(y, name=None)
add_(y, name=None, \*, alpha=1, out=None)
:::::::::

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

请参考 :ref:`cn_api_paddle_dist`

divide(y, name=None)
divide(y, name=None, \*, rounding_mode=None, out=None)
:::::::::

返回:计算后的 Tensor
Expand Down
10 changes: 8 additions & 2 deletions docs/api/paddle/add_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,23 @@
add
-------------------------------

.. py:function:: paddle.add(x, y, name=None)
.. py:function:: paddle.add(x, y, name=None, *, alpha=1, out=None)



逐元素相加算子,输入 ``x`` 与输入 ``y`` 逐元素相加,并将各个位置的输出元素保存到返回结果中。

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

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


等式为:

.. math::
Out = X + Y
Out = X + alpha \times Y

- :math:`X`:多维 Tensor。
- :math:`Y`:多维 Tensor。
Expand All @@ -30,8 +32,12 @@ add
参数
:::::::::
- **x** (Tensor) - 输入的 Tensor,数据类型为:bool、bfloat16、float16、float32、float64、int8、int16、int32、int64、uint8、complex64、complex128。
``别名: input``
- **y** (Tensor) - 输入的 Tensor,数据类型为:bool、bfloat16、float16、float32、float64、int8、int16、int32、int64、uint8、complex64、complex128。
``别名: other``
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
- **alpha** (Number, 可选) - 对 ``y`` 的缩放因子。默认值:1。
- **out** (Tensor, 可选) - 输出 Tensor。默认值:None。

返回
:::::::::
Expand Down
7 changes: 7 additions & 0 deletions docs/api/paddle/div.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. _cn_api_paddle_div:

div
-------------------------------

.. py:function:: paddle.div(x, y, name=None, *, rounding_mode=None, out=None)
别名函数,功能与 :ref:`cn_api_paddle_divide` 完全相同,详情请参考 :ref:`cn_api_paddle_divide` 。
7 changes: 7 additions & 0 deletions docs/api/paddle/div_.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. _cn_api_paddle_div_:

div\_
-------------------------------

.. py:function:: paddle.div_(x, y, name=None, *, rounding_mode=None, out=None)
别名函数,功能与 :ref:`cn_api_paddle_divide_` 完全相同,详情请参考 :ref:`cn_api_paddle_divide_` 。
2 changes: 1 addition & 1 deletion docs/api/paddle/divide__cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
divide\_
-------------------------------

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

更多关于 inplace 操作的介绍请参考 `3.1.3 原位(Inplace)操作和非原位操作的区别`_ 了解详情。
Expand Down
7 changes: 6 additions & 1 deletion docs/api/paddle/divide_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@
divide
-------------------------------

.. py:function:: paddle.divide(x, y, name=None)
.. py:function:: paddle.divide(x, y, name=None, *, rounding_mode=None, out=None)

逐元素相除算子,输入 ``x`` 与输入 ``y`` 逐元素相除,并将各个位置的输出元素保存到返回结果中。

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

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


返回
Expand Down
37 changes: 37 additions & 0 deletions docs/api/paddle/nn/functional/dropout1d_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
.. _cn_api_paddle_nn_functional_dropout1d:

dropout1d
-------------------------------

.. py:function:: paddle.nn.functional.dropout1d(x, p=0.5, training=True, inplace=False)
根据丢弃概率 ``p``,在训练过程中随机将某些 1D 通道置 0(对一个形状为 ``[N, C, L]`` 的 3D Tensor 或 ``[C, L]`` 的 2D Tensor,1D 通道指的是其中的形状为 ``L`` 的 1 维特征图)。

参数
:::::::::
- **x** (Tensor) - 形状为 ``[N, C, L]`` 的 3D Tensor 或 ``[C, L]`` 的 2D Tensor,数据类型为 float16、float32 或 float64。
- **p** (float,可选) - 将输入通道置 0 的概率,即丢弃概率。默认值为 0.5。
- **training** (bool,可选) - 标记是否为训练阶段。若为 False,则直接返回输入。默认值为 True。
- **inplace** (bool,可选) - 是否原地操作。当前版本暂未实现(行为等同于 False),未来版本将支持。默认值为 False。

返回
:::::::::
与输入 ``x`` 形状相同的 ``Tensor``。

代码示例
:::::::::

.. code-block:: python
import paddle
# Case 1: 3D input (batched)
x = paddle.randn([2, 3, 10]) # [N, C, L]
y_train = paddle.nn.functional.dropout1d(x, p=0.2)
y_test = paddle.nn.functional.dropout1d(x, p=0.2, training=False)
print("Original first channel:", x[0, 0, :])
print("Train output (may be zeroed):", y_train[0, 0, :])
print("Test output (always unchanged):", y_test[0, 0, :])
# Case 2: 2D input (single sample)
x = paddle.randn([3, 8]) # [C, L]
y = paddle.nn.functional.dropout1d(x, p=0.5)
print("Input shape:", x.shape)
print("Output shape:", y.shape)
print("Zeroed channels count:", paddle.sum(y == 0).item())
24 changes: 24 additions & 0 deletions docs/api/paddle/nn/parameter/Parameter.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
.. _cn_api_paddle_nn_parameter_Parameter:

Parameter
-------------------------------

.. py:class:: paddle.nn.parameter.Parameter(data=None, requires_grad=True)
一种被视为模型参数的 Tensor。

Parameter 是 Tensor 的子类,当与 ``Layer`` 一起使用时具有特殊行为 - 当被赋值给 Layer 的属性时,会自动添加到该层的参数列表中。普通 Tensor 不会有此效果。

参数
:::::::::
- **data** (Tensor,可选) - 参数的 Tensor 数据。如果为 None,则创建一个未初始化的参数。默认值:None。
- **requires_grad** (bool,可选) - 是否需要计算梯度。注意 ``paddle.no_grad()`` 不会影响 Parameter 的默认创建行为(在 no_grad 模式下仍会保持 ``requires_grad=True``)。默认值:True。

代码示例
:::::::::

.. code-block:: python
import paddle
weight = paddle.nn.parameter.Parameter(
data=paddle.randn([10, 10]),
requires_grad=True
)
7 changes: 7 additions & 0 deletions docs/api/paddle/true_divide.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. _cn_api_paddle_true_divide:

true_divide
-------------------------------

.. py:function:: paddle.true_divide(input, other, *, out=None)
别名函数,功能与 :ref:`cn_api_paddle_divide` (设置 `rounding_mode=None` 时)完全相同,详情请参考 :ref:`cn_api_paddle_divide` 。