Skip to content

[Docs] 增加第二类api difference #7592

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Oct 31, 2025
Merged

[Docs] 增加第二类api difference #7592

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8282c16
增加第二类api difference
hd9568 Oct 30, 2025
4efb999
修复错误
hd9568 Oct 30, 2025
fde36fc
修改第二类api
hd9568 Oct 31, 2025
87d19c7
修改第二类api
hd9568 Oct 31, 2025
753b7c4
满足模板规范
hd9568 Oct 31, 2025
63f1eac
保持与其他torch more args格式一致
hd9568 Oct 31, 2025
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
2 changes: 1 addition & 1 deletion .../model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.max.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ torch.max(*args, **kwargs)
### [paddle.compat.max](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/compat/max_cn.html#paddle/compat/max_cn#cn-api-paddle-compat-max)

```python
paddle.compat.max(input, *, out=None)
paddle.compat.max(*args, **kwargs)
```

torch.max 有多种签名与用法，均只需修改 torch 前缀为 paddle.compat，具体如下：
Expand Down
2 changes: 1 addition & 1 deletion ...del_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.median.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ torch.median(*args, **kwargs)
### [paddle.compat.median](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/compat/median_cn.html#paddle/compat/median_cn#cn-api-paddle-compat-median)

```python
paddle.compat.median(input, dim=None, keepdim=False, *, out=None)
paddle.compat.median(*args, **kwargs)
```

torch.median 有多种签名与用法，均只需修改 torch 前缀为 paddle.compat，具体如下：
Expand Down
2 changes: 1 addition & 1 deletion .../model_convert/convert_from_pytorch/api_difference/invok_only_diff/torch.min.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ torch.min(*args, **kwargs)
### [paddle.compat.min](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/compat/min_cn.html#paddle/compat/min_cn#cn-api-paddle-compat-min)

```python
paddle.compat.min(input, *args, out=None, **kwargs)
paddle.compat.min(*args, **kwargs)
```

torch.min 有多种签名与用法，均只需修改 torch 前缀为 paddle.compat，具体如下：
Expand Down
2 changes: 1 addition & 1 deletion ..._convert/convert_from_pytorch/api_difference/invok_only_diff/torch.nanmedian.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ torch.nanmedian(*args, **kwargs)
### [paddle.compat.nanmedian](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/compat/nanmedian_cn.html#paddle/compat/nanmedian_cn#cn-api-paddle-compat-nanmedian)

```python
paddle.compat.nanmedian(input, dim=None, keepdim=False, *, out=None)
paddle.compat.nanmedian(*args, **kwargs)
```

torch.namedian 有多种签名与用法，均只需修改 torch 前缀为 paddle.compat，具体如下：
Expand Down
6 changes: 3 additions & 3 deletions ..._convert/convert_from_pytorch/api_difference/invok_only_diff/torch.nn.Unfold.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
torch.nn.Unfold(kernel_size, dilation=1, padding=0, stride=1)
```

### [paddle.compat.Unfold](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/compat/Unfold_cn.html#paddle/compat/Unfold_cn#cn-api-paddle-compat-Unfold)
### [paddle.compat.nn.Unfold](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/compat/nn/Unfold_cn.html#paddle/compat/nn/Unfold_cn#cn-api-paddle-compat-nn-Unfold)

```python
paddle.compat.Unfold(kernel_size, dilation=1, padding=0, stride=1)
paddle.compat.nn.Unfold(kernel_size, dilation=1, padding=0, stride=1)
```

两者功能一致，但调用方式不一致，具体如下：
Expand All @@ -21,6 +21,6 @@ paddle.compat.Unfold(kernel_size, dilation=1, padding=0, stride=1)
unfold = torch.nn.Unfold(kernel_size=(2, 2))

# Paddle 写法
unfold = paddle.compat.Unfold(kernel_size=(2, 2))
unfold = paddle.compat.nn.Unfold(kernel_size=(2, 2))

```
6 changes: 3 additions & 3 deletions .../convert_from_pytorch/api_difference/invok_only_diff/torch.nn.functional.pad.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
torch.nn.functional.pad(input, pad, mode="constant", value=None)
```

### [paddle.compat.pad](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/compat/pad_cn.html#paddle/compat/pad_cn#cn-api-paddle-compat-pad)
### [paddle.compat.nn.pad](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/compat/nn/pad_cn.html#paddle/compat/nn/pad_cn#cn-api-paddle-compat-nn-pad)
Copy link
Collaborator

@zhwesky2010 zhwesky2010 Oct 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

paddle.compat.nn.functional.pad


```python
paddle.compat.pad(input, pad, mode="constant", value=0.0)
paddle.compat.nn.pad(input, pad, mode="constant", value=0.0)
```

两者功能一致，但调用方式不一致，具体如下：
Expand All @@ -21,6 +21,6 @@ paddle.compat.pad(input, pad, mode="constant", value=0.0)
result = torch.nn.functional.pad(x, [0, 0, 0, 0, 0, 1, 2, 3], value=1)

# Paddle 写法
result = paddle.compat.pad(x, [0, 0, 0, 0, 0, 1, 2, 3], value=1)
result = paddle.compat.nn.pad(x, [0, 0, 0, 0, 0, 1, 2, 3], value=1)

```
6 changes: 3 additions & 3 deletions ...vert_from_pytorch/api_difference/invok_only_diff/torch.nn.functional.softmax.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
torch.nn.functional.softmax(input, dim=None, _stacklevel=3, dtype=None)
```

### [paddle.compat.softmax](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/compat/softmax_cn.html#paddle/compat/softmax_cn#cn-api-paddle-compat-softmax)
### [paddle.compat.nn.softmax](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/compat/nn/softmax_cn.html#paddle/compat/nn/softmax_cn#cn-api-paddle-compat-nn-softmax)

```python
paddle.compat.softmax(input, dim=None, _stacklevel=3, dtype=None, out=None)
paddle.compat.nn.softmax(input, dim=None, _stacklevel=3, dtype=None, out=None)
```

两者功能一致，但调用方式不一致，具体如下：
Expand All @@ -21,6 +21,6 @@ paddle.compat.softmax(input, dim=None, _stacklevel=3, dtype=None, out=None)
result = torch.nn.functional.softmax(x, -1)

# Paddle 写法
result = paddle.compat.softmax(x, -1)
result = paddle.compat.nn.softmax(x, -1)

```
4 changes: 2 additions & 2 deletions ...ert_from_pytorch/api_difference/torch_more_args/torch.cuda.is_bf16_supported.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ PyTorch 相比 Paddle 支持更多其他参数，具体如下：

| PyTorch | PaddlePaddle | 备注 |
| ---------- | ------------ | -- |
| including_emulation | - | 是否包含软件模拟支持 |
| - | device | 查询的设备类型 |
| including_emulation | - | 是否包含软件模拟支持，暂无转写方式 |
| - | device | 查询的设备类型，转写时 Paddle 保持默认 |
Copy link
Collaborator

@zhwesky2010 zhwesky2010 Oct 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Paddle 保持默认即可

2 changes: 1 addition & 1 deletion ...rt/convert_from_pytorch/api_difference/torch_more_args/torch.nn.Module.train.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ PyTorch 相比 Paddle 支持更多其他参数，具体如下：

| PyTorch | PaddlePaddle | 备注 |
| ---------- | ------------ | -- |
| `mode` | 无 | 是否设置为训练模式 |
| `mode` | 无 | 设置训练模式，暂无转写方式 |
2 changes: 1 addition & 1 deletion ...nvert_from_pytorch/api_difference/torch_more_args/torch.optim.Optimizer.step.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ PyTorch 相比 Paddle 支持更多其他参数，具体如下：

| PyTorch | PaddlePaddle | 备注 |
| ---------- | ------------ | -- |
| closure | - | 传入一个闭包函数，在优化器更新参数前执行。 |
| closure | - | 传入一个闭包函数，在优化器更新参数前执行。暂无转写方式 |
8 changes: 4 additions & 4 deletions docs/guides/model_convert/convert_from_pytorch/tools/validate_api_difference_format.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ def main():

# 定义类别映射：英文目录名 -> 中文类别名称
category_map = {
"invok_diff_only": "仅 API 调用方式不一致",
"invok_only_diff": "仅 API 调用方式不一致",
"args_name_diff": "仅参数名不一致",
"paddle_more_args": "paddle 参数更多",
"args_default_value_diff": "参数默认值不一致",
Expand All @@ -23,7 +23,7 @@ def main():

# 定义每个类别的总结语句
summary_map = {
"invok_diff_only": "两者功能一致，但调用方式不一致，具体如下：",
"invok_only_diff": "两者功能一致，但调用方式不一致，具体如下：",
"args_name_diff": "两者功能一致且参数用法一致，仅参数名不一致，具体如下：",
"paddle_more_args": "其中 Paddle 相比 PyTorch 支持更多其他参数，具体如下：",
"args_default_value_diff": "两者功能一致且参数用法一致，参数默认值不一致，具体如下：",
Expand Down Expand Up @@ -153,7 +153,7 @@ def main():
current_index += 1

# 8. 检查参数映射表格 (非2和10类)
if category_dir not in ["invok_diff_only", "composite_implement"]:
if category_dir not in ["invok_only_diff", "composite_implement"]:
# 8.1 参数映射标题
if (
current_index >= len(lines)
Expand All @@ -171,7 +171,7 @@ def main():
current_index += 1

# 9. 检查转写示例
if category_dir in ["invok_diff_only", "composite_implement"]:
if category_dir in ["invok_only_diff", "composite_implement"]:
# 9.1 转写示例标题
if (
current_index >= len(lines)
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/model_convert/convert_from_pytorch/tools/validate_pytorch_api_mapping.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

# 类别映射关系
CATEGORY_MAP = {
"invok_diff_only": "仅 API 调用方式不一致",
"invok_only_diff": "仅 API 调用方式不一致",
"args_name_diff": "仅参数名不一致",
"paddle_more_args": "paddle 参数更多",
"args_default_value_diff": "参数默认值不一致",
Expand Down