[Docs] 增加第二类api difference #7592
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
感谢你贡献飞桨文档，文档预览构建中，Docs-New 跑完后即可预览，预览链接：http://preview-pr-7592.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html |
📚 本次 PR 文档预览链接（点击展开）
|
这些对齐一下格式吧，这样： 
|
这种错误有办法检查吗 |
zhwesky2010
reviewed
Oct 30, 2025
| ### [torch.max](https://pytorch.org/docs/stable/generated/torch.max.html) | ||
|
|
||
| ```python | ||
| torch.max(input, *, out=None) |
There was a problem hiding this comment.
这几个签名直接写 torch.max(*args, **kwargs) 吧
max、min、median、nanmedian
|
|
||
| ```python | ||
| # PyTorch 写法 | ||
| result = torch.max(x) |
There was a problem hiding this comment.
备注一下：torch.max有多种签名与用法，均只需修改torch前缀为paddle.compat
|
|
||
| ```python | ||
| # PyTorch 写法 | ||
| result = torch.median(input) |
| paddle.compat.min(input, *args, out=None, **kwargs) | ||
| ``` | ||
|
|
||
| 两者功能一致，但调用方式不一致，具体如下： |
|
|
||
| ```python | ||
| # PyTorch 写法 | ||
| result = torch.nanmedian(input) |
| ### [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) | ||
|
|
||
| ```python | ||
| paddle.compat.softmax(input, dim=None, dtype, *, out=None) |
There was a problem hiding this comment.
如果是 [仅API调用方式不一致]，上下的签名，API参数部分应该都是一样的，或者paddle比torch参数更多。
这里需要再整体核对下，为什么会有的参数不符合上面的情况。
paddle.compat.softmax的_stacklevel、dtype都是一样的。多一个out。
zhwesky2010
reviewed
Oct 31, 2025
| ### [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) |
There was a problem hiding this comment.
上面如果按*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.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) |
| unfold = torch.nn.Unfold(kernel_size=(2, 2)) | ||
|
|
||
| # Paddle 写法 | ||
| unfold = paddle.compat.Unfold(kernel_size=(2, 2)) |
There was a problem hiding this comment.
这个更新成了 paddle.compat.nn.Unfold
| ### [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) | ||
|
|
||
| ```python | ||
| paddle.compat.Unfold(kernel_size, dilation=1, padding=0, stride=1) |
There was a problem hiding this comment.
paconvert更新为paddle.compat.nn.Unfold
| ### [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) | ||
|
|
||
| ```python | ||
| paddle.compat.softmax(input, dim=None, _stacklevel=3, dtype=None, out=None) |
There was a problem hiding this comment.
paconvert更新为paddle.compat.nn.functional.softmax
| ``` | ||
| | PyTorch | PaddlePaddle | 备注 | | ||
| | ---------- | ------------ | -- | | ||
| | including_emulation | - | 是否包含软件模拟支持 | |
There was a problem hiding this comment.
看一下模板，如果没有转写示例，需要标明 暂无转写方式
| | PyTorch | PaddlePaddle | 备注 | | ||
| | ---------- | ------------ | -- | | ||
| | including_emulation | - | 是否包含软件模拟支持 | | ||
| | - | device | 查询的设备类型 | |
There was a problem hiding this comment.
看一下模板规范，需要写一下paddle应该怎么设置，不需要修改的话就是 paddle保持默认即可
| ``` | ||
| | PyTorch | PaddlePaddle | 备注 | | ||
| | ---------- | ------------ | -- | | ||
| | `mode` | 无 | 是否设置为训练模式 | |
| ``` | ||
| | PyTorch | PaddlePaddle | 备注 | | ||
| | ---------- | ------------ | -- | | ||
| | closure | - | 传入一个闭包函数，在优化器更新参数前执行。 | |
zhwesky2010
reviewed
Oct 31, 2025
| ``` | ||
|
|
||
| ### [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) |
There was a problem hiding this comment.
paddle.compat.nn.functional.pad
| | including_emulation | - | 是否包含软件模拟支持 | | ||
| | - | device | 查询的设备类型 | | ||
| | including_emulation | - | 是否包含软件模拟支持，暂无转写方式 | | ||
| | - | device | 查询的设备类型，转写时 Paddle 保持默认 | |
zhwesky2010
reviewed
Oct 31, 2025
|
|
||
| ```python | ||
| paddle.compat.nn.softmax(input, dim=None, _stacklevel=3, dtype=None, out=None) | ||
| paddle.compat.nn.functional.softmax(input, dim=None, _stacklevel=3, dtype=None, out=None) |
There was a problem hiding this comment.
这些在后面优化 validate_api_difference 及一致性工具时，加上校验吧，需要与paconvert的pytorch api、paddle API保持一致。
zhwesky2010
approved these changes
Oct 31, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.