Skip to content

Commit 124484e

Browse files
Enigmatismssunzhongkai588
Enigmatisms
and
sunzhongkai588
authored
[API Compatibility] Multiple paddle.compat APIs doc modifications (#7623)
* [API Compatibility] Multiple `paddle.compat` APIs doc modifications * [Fix] Fix slogdet outdated API label * Update docs/api/paddle/compat/nn_Linear_cn.rst * Update docs/api/paddle/compat/nn_Unfold_cn.rst * Update docs/api/paddle/compat/nn_functional_linear_cn.rst --------- Co-authored-by: zachary sun <[email protected]>
1 parent fd2e1a1 commit 124484e

File tree

11 files changed

+121
-23
lines changed

11 files changed

+121
-23
lines changed

‎docs/api/paddle/compat/Overview_cn.rst‎

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,33 @@ PyTorch 兼容函数
1818
" :ref:`median <cn_api_paddle_compat_median>` ", "兼容版中位数，支持 dim/keepdim/out 签名"
1919
" :ref:`min <cn_api_paddle_compat_min>` ", "包含 `amin`、同时返回 values 及 indices 的轴向最小值、`minimum` 三种功能"
2020
" :ref:`nanmedian <cn_api_paddle_compat_nanmedian>` ", "忽略 NaN 的兼容版中位数，支持 dim/keepdim/out 签名"
21-
" :ref:`pad <cn_api_paddle_compat_pad>` ", "从最后一维度开始进行 padding、padding 正确兼容转换的填充函数"
2221
" :ref:`slogdet <cn_api_paddle_compat_slogdet>` ", "slogdet 函数"
23-
" :ref:`softmax <cn_api_paddle_compat_softmax>` ", "softmax 函数"
2422
" :ref:`sort <cn_api_paddle_compat_sort>` ", "同时返回 values 及 indices 的排序"
2523
" :ref:`split <cn_api_paddle_compat_split>` ", "允许非整除块大小输入的 Tensor 轴向切分"
2624

2725

28-
.. _about_compat_class:
26+
.. _about_compat_nn:
2927

30-
PyTorch 兼容模块
31-
::::::::::::::::::::
28+
PyTorch 兼容的 nn 模块
29+
::::::::::::::::::::::::::::::
3230

3331
.. csv-table::
3432
:header: "类名称", "类功能"
3533
:widths: 10, 30
3634

37-
" :ref:`Unfold <cn_api_paddle_compat_Unfold>` ", "允许 Tensor 输入的 ``paddle.nn.Unfold`` 兼容版本"
35+
" :ref:`Linear <cn_api_paddle_compat_nn_Linear>` ", "PyTorch 对齐的 ``paddle.nn.Linear`` 兼容版本"
36+
" :ref:`Unfold <cn_api_paddle_compat_nn_Unfold>` ", "允许 Tensor 输入的 ``paddle.nn.Unfold`` 兼容版本"
37+
38+
39+
.. _about_compat_nn_functional:
40+
41+
PyTorch 兼容的 nn.functional 模块
42+
::::::::::::::::::::::::::::::::::::::::
43+
44+
.. csv-table::
45+
:header: "函数名称", "函数功能"
46+
:widths: 10, 30
47+
48+
" :ref:`linear <cn_api_paddle_compat_nn_functional_linear>` ", "PyTorch 对齐的 ``paddle.nn.functional.linear`` 兼容版本"
49+
" :ref:`pad <cn_api_paddle_compat_nn_functional_pad>` ", "从最后一维度开始进行 padding、padding 正确兼容转换的填充函数"
50+
" :ref:`softmax <cn_api_paddle_compat_nn_functional_softmax>` ", "softmax 函数"

‎docs/api/paddle/compat/max_cn.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ max
99

1010
使用前请详细参考：`【返回参数类型不一致】torch.max`_ 以确定是否使用此模块。
1111

12-
.. _【返回参数类型不一致】torch.max: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/model_convert/convert_from_pytorch/api_difference/torch/torch.max.html
12+
.. _【返回参数类型不一致】torch.max: https://www.paddlepaddle.org.cn/documentation/docs/en/guides/model_convert/convert_from_pytorch/api_difference/torch/torch.max.html
1313

1414

1515
.. caution::

‎docs/api/paddle/compat/min_cn.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ min
99

1010
使用前请详细参考：`【返回参数类型不一致】torch.min`_ 以确定是否使用此模块。
1111

12-
.. _【返回参数类型不一致】torch.min: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/model_convert/convert_from_pytorch/api_difference/torch/torch.min.html
12+
.. _【返回参数类型不一致】torch.min: https://www.paddlepaddle.org.cn/documentation/docs/en/guides/model_convert/convert_from_pytorch/api_difference/torch/torch.min.html
1313

1414

1515
.. caution::

‎docs/api/paddle/compat/nn_Linear_cn.rst‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
.. _cn_api_paddle_compat_nn_Linear:
2+
3+
Linear
4+
-------------------------------
5+
6+
.. py:class:: paddle.compat.nn.Linear(in_features, out_features, bias, device=None, dtype=None)
7+
8+
PyTorch 兼容的 :ref:`cn_api_paddle_nn_Linear` 版本：
9+
10+
- 与 PyTorch 一致的数学意义：
11+
12+
.. math::
13+
14+
Out = XW^T + b
15+
16+
其中 :math:`W` 是权重张量， :math:`b` 是偏置张量， :math:`X` 是输入张量
17+
18+
- 与 PyTorch 一致的默认可视化方法： Kaiming normal 用于权重初始化，平均分布用于偏置初始化
19+
- 支持设定 ``Linear`` 的数据类型以及运行设备
20+
21+
使用前请详细参考：`【仅参数名不一致】torch.nn.Linear`_ 以确定是否使用此模块。
22+
23+
.. _【仅参数名不一致】torch.nn.Linear: https://www.paddlepaddle.org.cn/documentation/docs/en/guides/model_convert/convert_from_pytorch/api_difference/nn/torch.nn.Linear.html
24+
25+
参数
26+
:::::::::::
27+
28+
- **in_features** (int) - 输入单元数。
29+
- **out_features** (int) - 输出单元数。
30+
- **bias** (bool, 可选) - 如果为 True，将创建偏置（一个形状为 :math:`[out\_features]` 的一维张量）并添加到输出。默认值 True。
31+
- **device** (PlaceLike, 可选) - 创建参数所在的设备。默认值为 None，表示默认 Paddle 设备。
32+
- **dtype** (DTypeLike, 可选) - 创建参数的数据类型。默认值为 None，并设置为 Linear 的默认数据类型（float32）。
33+
34+
形状
35+
:::::::::
36+
37+
- **输入** : 多维张量，形状为 :math:`[*, in\_features]` 。数据类型为 float16、float32、float64，默认为 float32。
38+
- **输出** : 多维张量，形状为 :math:`[*, out\_features]` 。数据类型与输入相同。
39+
40+
41+
42+
代码示例
43+
::::::::::::
44+
45+
COPY-FROM: paddle.compat.nn.Linear

docs/api/paddle/compat/Unfold_cn.rst renamed to docs/api/paddle/compat/nn_Unfold_cn.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
1-
.. _cn_api_paddle_compat_Unfold:
1+
.. _cn_api_paddle_compat_nn_Unfold:
22

33
Unfold
44
-------------------------------
55

6-
.. py:class:: paddle.compat.Unfold(kernel_size, dilation=1, padding=0, stride=1)
6+
.. py:class:: paddle.compat.nn.Unfold(kernel_size, dilation=1, padding=0, stride=1)
77
88
99
PyTorch 兼容的 :ref:`cn_api_paddle_nn_Unfold` 版本：
10+
1011
- 关键字参数使用单数形式（例如：``kernel_size`` 而非 kernel_sizes）
1112
- ``padding`` 仅支持输入长度为 1（整数）或 2 的列表，禁止使用 Size4 格式。如需更灵活的输入版本，请使用 :ref:`cn_api_paddle_nn_Unfold`
1213
- 所有输入参数支持 ``Tensor`` 或 ``pir.Value`` 类型（将自动转换为列表）
1314
- 其他特性与 :ref:`cn_api_paddle_nn_Unfold` 完全一致
1415

1516
使用前请详细参考：`【仅参数名不一致】torch.nn.Unfold`_ 以确定是否使用此模块。
1617

17-
.. _【仅参数名不一致】torch.nn.Unfold: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/model_convert/convert_from_pytorch/api_difference/nn/torch.nn.Unfold.html
18+
.. _【仅参数名不一致】torch.nn.Unfold: https://www.paddlepaddle.org.cn/documentation/docs/en/guides/model_convert/convert_from_pytorch/api_difference/nn/torch.nn.Unfold.html
1819

1920
**样例**：
2021

@@ -45,10 +46,10 @@ PyTorch 兼容的 :ref:`cn_api_paddle_nn_Unfold` 版本：
4546
形状
4647
:::::::::
4748
- **输入** : 4-D Tensor，形状为[N, C, H, W]，数据类型为 float32 或者 float64
48-
- **输出**：形状如上面所描述的[N, Cout, Lout]，Cout 每一个滑动 block 里面覆盖的元素个数，Lout 是滑动 block 的个数，数据类型与 ``x`` 相同
49+
- **输出** : 形状如上面所描述的[N, Cout, Lout]，Cout 每一个滑动 block 里面覆盖的元素个数，Lout 是滑动 block 的个数，数据类型与 ``x`` 相同
4950

5051

5152
代码示例
5253
::::::::::::
5354

54-
COPY-FROM: paddle.compat.Unfold
55+
COPY-FROM: paddle.compat.nn.Unfold

‎docs/api/paddle/compat/nn_functional_linear_cn.rst‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
.. _cn_api_paddle_compat_nn_functional_linear:
2+
3+
linear
4+
-------------------------------
5+
6+
.. py:function:: paddle.compat.nn.functional.linear(input, weight, bias=None)
7+
8+
PyTorch 兼容的线性函数版本：
9+
10+
- 与 PyTorch 一致的数学意义：
11+
12+
.. math::
13+
14+
Out = X W^T + b
15+
16+
其中 :math:`W` 是权重张量 ``weight`` ， :math:`b` 是偏置张量 ``bias``， :math:`X` 是输入张量 ``input``
17+
18+
- 此实现与 PyTorch 的线性函数对齐，计算 :math:`y = XW^T + b`。
19+
20+
21+
参数
22+
:::::::::::
23+
24+
- **input** (Tensor) - 输入张量。数据类型应为 bfloat16、float16、float32 或 float64。输入张量的形状应为 :math:`[*, in\_features]`，其中 :math:`*` 表示任意数量的额外维度，包括无。
25+
- **weight** (Tensor) - 权重张量。数据类型应为 float16、float32 或 float64。形状应为 :math:`[out\_features, in\_features]`。
26+
- **bias** (Tensor, 可选) - 偏置张量。数据类型应为 float16、float32 或 float64。如果为 None，则不添加偏置到输出单元。默认值 None。
27+
28+
29+
形状
30+
:::::::::
31+
32+
- **输入** : 多维张量，形状为 :math:`[*, in\_features]` 。数据类型为 bfloat16、float16、float32 或 float64。
33+
- **输出** : 多维张量，形状为 :math:`[*, out\_features]` 。数据类型与输入相同。
34+
35+
36+
代码示例
37+
::::::::::::
38+
39+
COPY-FROM: paddle.compat.nn.functional.linear

docs/api/paddle/compat/pad_cn.rst renamed to docs/api/paddle/compat/nn_functional_pad_cn.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
.. _cn_api_paddle_compat_pad:
1+
.. _cn_api_paddle_compat_nn_functional_pad:
22

33
pad
44
-------------------------------
55

6-
.. py:function:: paddle.compat.pad(input, pad, mode='constant', value=0.0)
6+
.. py:function:: paddle.compat.nn.functional.pad(input, pad, mode='constant', value=0.0)
77
88
PyTorch 兼容的 :ref:`cn_api_paddle_nn_functional_pad` 版本
99

@@ -43,4 +43,4 @@ Tensor，对 ``input`` 进行 ``'pad'`` 的结果，数据类型和 ``input``
4343
代码示例
4444
:::::::::
4545

46-
COPY-FROM: paddle.compat.pad
46+
COPY-FROM: paddle.compat.nn.functional.pad

docs/api/paddle/compat/softmax_cn.rst renamed to docs/api/paddle/compat/nn_functional_softmax_cn.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
.. _cn_api_paddle_compat_softmax:
1+
.. _cn_api_paddle_compat_nn_functional_softmax:
22

33
softmax
44
-------------------------------
5-
.. py:function:: paddle.compat.softmax(input, dim=None, dtype=None, *, out=None)
5+
.. py:function:: paddle.compat.nn.functional.softmax(input, dim=None, dtype=None, *, out=None)
66
77
实现 softmax 层。计算过程如下：
88

@@ -97,4 +97,4 @@ softmax
9797
代码示例
9898
::::::::::
9999

100-
COPY-FROM: paddle.compat.softmax
100+
COPY-FROM: paddle.compat.nn.functional.softmax

‎docs/api/paddle/compat/slogdet_cn.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ slogdet
55

66
.. py:function:: paddle.compat.slogdet(x, out=None)
77
8-
PyTorch 兼容的 :ref:`cn_api_paddle_slogdet` 版本，计算方阵或批量方阵行列式的符号与绝对值的自然对数，行列式的值可以通过 ``sign * exp(logabsdet)`` 复原。
8+
PyTorch 兼容的 :ref:`cn_api_paddle_linalg_slogdet` 版本，计算方阵或批量方阵行列式的符号与绝对值的自然对数，行列式的值可以通过 ``sign * exp(logabsdet)`` 复原。
99

1010
使用前请详细参考：`【返回参数类型不一致】torch.slogdet`_ 以确定是否使用此模块。
1111

12-
.. _【返回参数类型不一致】torch.slogdet: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/model_convert/convert_from_pytorch/api_difference/torch/torch.slogdet.html
12+
.. _【返回参数类型不一致】torch.slogdet: https://www.paddlepaddle.org.cn/documentation/docs/en/guides/model_convert/convert_from_pytorch/api_difference/torch/torch.slogdet.html
1313

1414

1515
参数

‎docs/api/paddle/compat/sort_cn.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ PyTorch 兼容的 :ref:`cn_api_paddle_sort` 版本，同时返回排序的值结
99

1010
使用前请详细参考：`【返回参数类型不一致】torch.sort`_ 以确定是否使用此模块。
1111

12-
.. _【返回参数类型不一致】torch.sort: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/model_convert/convert_from_pytorch/api_difference/torch/torch.sort.html
12+
.. _【返回参数类型不一致】torch.sort: https://www.paddlepaddle.org.cn/documentation/docs/en/guides/model_convert/convert_from_pytorch/api_difference/torch/torch.sort.html
1313

1414

1515
参数

0 commit comments

Comments
 (0)