Skip to content

Commit 75d27b1

Browse files
[API compatibility] Update 9 API Docs (#7394)
* [API compatibility] Update 9 API Docs * Apply suggestions from code review Co-authored-by: zachary sun <70642955+sunzhongkai588@users.noreply.github.com> * update * fix ci --------- Co-authored-by: zachary sun <70642955+sunzhongkai588@users.noreply.github.com>
1 parent f536970 commit 75d27b1

File tree

12 files changed

+95
-9
lines changed

12 files changed

+95
-9
lines changed

docs/api/paddle/Overview_cn.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ tensor 数学操作
6363
" :ref:`paddle.cummin <cn_api_paddle_cummin>` ", "沿给定 axis 计算 Tensor x 的累计最小值"
6464
" :ref:`paddle.cumprod <cn_api_paddle_cumprod>` ", "沿给定 dim 计算 Tensor x 的累乘"
6565
" :ref:`paddle.digamma <cn_api_paddle_digamma>` ", "逐元素计算输入 x 的 digamma 函数值"
66+
" :ref:`paddle.div <cn_api_paddle_div>` ", "逐元素相除算子"
6667
" :ref:`paddle.divide <cn_api_paddle_divide>` ", "逐元素相除算子"
6768
" :ref:`paddle.equal <cn_api_paddle_equal>` ", "返回 x==y 逐元素比较 x 和 y 是否相等,相同位置的元素相同则返回 True,否则返回 False"
6869
" :ref:`paddle.equal_all <cn_api_paddle_equal_all>` ", "如果所有相同位置的元素相同返回 True,否则返回 False"
@@ -148,6 +149,7 @@ tensor 数学操作
148149
" :ref:`paddle.tan <cn_api_paddle_tan>` ", "三角函数 tangent"
149150
" :ref:`paddle.tanh <cn_api_paddle_tanh>` ", "tanh 激活函数"
150151
" :ref:`paddle.trace <cn_api_paddle_trace>` ", "计算输入 Tensor 在指定平面上的对角线元素之和"
152+
" :ref:`paddle.true_divide <cn_api_paddle_true_divide>` ", "逐元素相除算子,输入 x 与输入 y 逐元素相除,保留完整精度并返回浮点结果"
151153
" :ref:`paddle.var <cn_api_paddle_var>` ", "沿给定的轴 axis 计算 x 中元素的方差"
152154
" :ref:`paddle.diagonal <cn_api_paddle_diagonal>` ", "根据给定的轴 axis 返回输入 Tensor 的局部视图"
153155
" :ref:`paddle.trunc <cn_api_paddle_trunc>` ", "对输入 Tensor 每个元素的小数部分进行截断"
@@ -210,6 +212,7 @@ tensor 数学操作原位(inplace)版本
210212
" :ref:`paddle.cumprod_ <cn_api_paddle_cumprod_>` ", "Inplace 版本的 cumprod API,对输入 x 采用 Inplace 策略"
211213
" :ref:`paddle.cumsum_ <cn_api_paddle_cumsum_>` ", "Inplace 版本的 cumsum API,对输入 x 采用 Inplace 策略"
212214
" :ref:`paddle.digamma_ <cn_api_paddle_digamma_>` ", "Inplace 版本的 digamma API,对输入 x 采用 Inplace 策略"
215+
" :ref:`paddle.div_ <cn_api_paddle_div_>` ", "Inplace 版本的 div API,对输入 x 采用 Inplace 策略"
213216
" :ref:`paddle.divide_ <cn_api_paddle_divide_>` ", "Inplace 版本的 divide API,对输入 x 采用 Inplace 策略"
214217
" :ref:`paddle.exp_ <cn_api_paddle_exp_>` ", "Inplace 版本的 exp API,对输入 x 采用 Inplace 策略"
215218
" :ref:`paddle.expm1_ <cn_api_paddle_expm1_>` ", "Inplace 版本的 expm1 API,对输入 x 采用 Inplace 策略"

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__cn.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
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+
8+
别名函数,功能与 :ref:`cn_api_paddle_divide_` 完全相同,详情请参考 :ref:`cn_api_paddle_divide_` 。

docs/api/paddle/div_cn.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
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+
8+
别名函数,功能与 :ref:`cn_api_paddle_divide` 完全相同,详情请参考 :ref:`cn_api_paddle_divide` 。

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"``。如果 ``rounding_mode=None``,则不进行舍入操作;如果 ``rounding_mode="trunc"``,则向零截断;如果 ``rounding_mode="floor"``,则向负无穷舍入。
32+
- **out** (Tensor,可选) - 输出 Tensor,默认值为 None。
2833

2934

3035
返回
File renamed without changes.

docs/api/paddle/nn/Overview_cn.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -474,8 +474,9 @@ Dropout 方法
474474
" :ref:`paddle.nn.functional.alpha_dropout <cn_api_paddle_nn_functional_alpha_dropout>` ", "一种具有自归一化性质的 dropout"
475475
" :ref:`paddle.nn.functional.feature_alpha_dropout <cn_api_paddle_nn_functional_feature_alpha_dropout>` ", "一种具有自归一化性质的 dropout ,屏蔽整个通道"
476476
" :ref:`paddle.nn.functional.dropout <cn_api_paddle_nn_functional_dropout>` ", "Dropout"
477-
" :ref:`paddle.nn.functional.dropout2d <cn_api_paddle_nn_functional_dropout2d>` ", "一维 Dropout"
478-
" :ref:`paddle.nn.functional.dropout3d <cn_api_paddle_nn_functional_dropout3d>` ", "二维 Dropout"
477+
" :ref:`paddle.nn.functional.dropout1d <cn_api_paddle_nn_functional_dropout1d>` ", "一维 Dropout"
478+
" :ref:`paddle.nn.functional.dropout2d <cn_api_paddle_nn_functional_dropout2d>` ", "二维 Dropout"
479+
" :ref:`paddle.nn.functional.dropout3d <cn_api_paddle_nn_functional_dropout3d>` ", "三维 Dropout"
479480

480481
.. _embedding_functional:
481482

@@ -557,6 +558,7 @@ Embedding 相关函数
557558
" :ref:`paddle.nn.functional.upsample <cn_api_paddle_nn_functional_upsample>` ", "用于调整一个 batch 中图片的大小"
558559
" :ref:`paddle.nn.functional.class_center_sample <cn_api_paddle_nn_functional_class_center_sample>` ", "用于 PartialFC 类别中心采样"
559560
" :ref:`paddle.nn.functional.channel_shuffle <cn_api_paddle_nn_functional_channel_shuffle>` ", "将一个形为[N, C, H, W]或是[N, H, W, C]的 Tensor 按通道分成 g 组,得到形为[N, g, C/g, H, W]或[N, H, W, g, C/g]的 Tensor,然后转置为[N, C/g, g, H, W]或[N, H, W, C/g, g]的形状,最后重新排列为原来的形状"
561+
" :ref:`paddle.nn.parameter.Parameter <cn_api_paddle_nn_parameter_Parameter>` ", "用于创建可训练参数,作为模型的一部分参与梯度更新"
560562

561563
.. _about_initializer:
562564

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
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+
8+
根据丢弃概率 ``p``,在训练过程中随机将某些 1D 通道置 0(对一个形状为 ``[N, C, L]`` 的 3D Tensor 或 ``[C, L]`` 的 2D Tensor,1D 通道指的是其中的形状为 ``L`` 的 1 维特征图)。
9+
10+
基于 ``paddle.nn.functional.dropout`` 实现,如您想了解更多,请参见 :ref:`cn_api_paddle_nn_functional_dropout` 。
11+
12+
参数
13+
:::::::::
14+
- **x** (Tensor) - 形状为 ``[N, C, L]`` 的 3D Tensor 或 ``[C, L]`` 的 2D Tensor,数据类型为 float16、float32 或 float64。
15+
- **p** (float,可选) - 将输入通道置 0 的概率,即丢弃概率,默认值为 0.5。
16+
- **training** (bool,可选) - 标记是否为训练阶段,默认值为 True。
17+
- **inplace** (bool,可选) - 是否原地操作。当前版本暂未实现(行为等同于 False),未来版本将支持,默认值为 False。
18+
19+
返回
20+
:::::::::
21+
经过 dropout1d 之后的结果,与输入 ``x`` 形状相同的 ``Tensor``。
22+
23+
代码示例
24+
:::::::::
25+
26+
COPY-FROM: paddle.nn.functional.dropout1d

0 commit comments

Comments
 (0)