API Compatibility Edit by AI Agent (AI Coding Rules) #7676
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
…ciprocal/square/tan)
zhwesky2010
requested review from
Echo-Nie,
jzhang533,
mattheliu,
ooooo-create and
sunzhongkai588
as code owners
|
感谢你贡献飞桨文档，文档预览构建中，Docs-New 跑完后即可预览，预览链接：http://preview-pr-7676.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html |
📚 本次 PR 文档预览链接（点击展开）
|
Contributor
There was a problem hiding this comment.
Pull request overview
本 PR 是由 AI Agent 自动生成的 API 兼容性编辑，主要目的是为多个 Paddle API 添加与 PyTorch 兼容的 out 参数支持和参数别名，并相应删除了不再需要的 PyTorch API 差异对比文档。
主要变更包括：
- 为 15 个 Paddle API 添加了
out参数支持（作为关键字参数） - 为这些 API 的参数添加了 PyTorch 兼容的别名（如
input、other、values、diagonal） - 删除了 19 个 PyTorch 与 Paddle API 差异对比文档（因为差异已消除）
Reviewed changes
Copilot reviewed 34 out of 34 changed files in this pull request and generated 24 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.square.md | 删除 torch.square 与 paddle.square 的 API 差异文档 |
| docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.reciprocal.md | 删除 torch.reciprocal 与 paddle.reciprocal 的 API 差异文档 |
| docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.nextafter.md | 删除 torch.nextafter 与 paddle.nextafter 的 API 差异文档 |
| docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.heaviside.md | 删除 torch.heaviside 与 paddle.heaviside 的 API 差异文档 |
| docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.fmin.md | 删除 torch.fmin 与 paddle.fmin 的 API 差异文档 |
| docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.fmax.md | 删除 torch.fmax 与 paddle.fmax 的 API 差异文档 |
| docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.diag.md | 删除 torch.diag 与 paddle.diag 的 API 差异文档 |
| docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.atan.md | 删除 torch.atan 与 paddle.atan 的 API 差异文档 |
| docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.asinh.md | 删除 torch.asinh 与 paddle.asinh 的 API 差异文档 |
| docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.angle.md | 删除 torch.angle 与 paddle.angle 的 API 差异文档 |
| docs/guides/model_convert/convert_from_pytorch/api_difference/args_name_diff/torch.tan.md | 删除 torch.tan 与 paddle.tan 的参数名差异文档 |
| docs/guides/model_convert/convert_from_pytorch/api_difference/args_name_diff/torch.bitwise_xor.md | 删除 torch.bitwise_xor 与 paddle.bitwise_xor 的参数名差异文档 |
| docs/guides/model_convert/convert_from_pytorch/api_difference/args_name_diff/torch.bitwise_not.md | 删除 torch.bitwise_not 与 paddle.bitwise_not 的参数名差异文档 |
| docs/guides/model_convert/convert_from_pytorch/api_difference/args_name_diff/torch.bitwise_and.md | 删除 torch.bitwise_and 与 paddle.bitwise_and 的参数名差异文档 |
| docs/guides/model_convert/convert_from_pytorch/api_difference/args_name_diff/torch.bincount.md | 删除 torch.bincount 与 paddle.bincount 的参数名差异文档 |
| docs/guides/model_convert/convert_from_pytorch/api_difference/args_name_diff/torch.Tensor.bitwise_xor_.md | 删除 torch.Tensor.bitwise_xor_ 与 paddle.Tensor.bitwise_xor_ 的参数名差异文档 |
| docs/guides/model_convert/convert_from_pytorch/api_difference/args_name_diff/torch.Tensor.bitwise_xor.md | 删除 torch.Tensor.bitwise_xor 与 paddle.Tensor.bitwise_xor 的参数名差异文档 |
| docs/guides/model_convert/convert_from_pytorch/api_difference/args_name_diff/torch.Tensor.bitwise_and_.md | 删除 torch.Tensor.bitwise_and_ 与 paddle.Tensor.bitwise_and_ 的参数名差异文档 |
| docs/guides/model_convert/convert_from_pytorch/api_difference/args_name_diff/torch.Tensor.bitwise_and.md | 删除 torch.Tensor.bitwise_and 与 paddle.Tensor.bitwise_and 的参数名差异文档 |
| docs/api/paddle/tan_cn.rst | 添加 out 参数和 input 别名 |
| docs/api/paddle/square_cn.rst | 添加 out 参数和 input 别名 |
| docs/api/paddle/reciprocal_cn.rst | 添加 out 参数和 input 别名 |
| docs/api/paddle/nextafter_cn.rst | 添加 out 参数以及 input、other 别名 |
| docs/api/paddle/heaviside_cn.rst | 添加 out 参数以及 input、values 别名 |
| docs/api/paddle/fmin_cn.rst | 添加 out 参数以及 input、other 别名 |
| docs/api/paddle/fmax_cn.rst | 添加 out 参数以及 input、other 别名 |
| docs/api/paddle/diag_cn.rst | 添加 input、diagonal 别名（未添加 out 参数，可能因为已有特殊处理） |
| docs/api/paddle/bitwise_xor_cn.rst | 调整参数顺序，将 out 改为关键字参数，添加 input、other 别名 |
| docs/api/paddle/bitwise_not_cn.rst | 调整参数顺序，将 out 改为关键字参数，添加 input 别名 |
| docs/api/paddle/bitwise_and_cn.rst | 调整参数顺序，将 out 改为关键字参数，添加 input、other 别名 |
| docs/api/paddle/bincount_cn.rst | 添加 input 别名 |
| docs/api/paddle/atan_cn.rst | 添加 input 别名（未添加 out 参数，可能因为已有特殊处理） |
| docs/api/paddle/asinh_cn.rst | 添加 out 参数和 input 别名 |
| docs/api/paddle/angle_cn.rst | 添加 out 参数和 input 别名 |
Comment on lines
+23
to
+24
| - **x** （Tensor）- 输入的 Tensor。数据类型为 ``bfloat16`` 、 ``float16`` 、 ``float32`` 、 ``float64`` 、 ``int32`` 或 ``int64`` 。别名 ``input`` 。 | ||
| - **y** （Tensor）- 输入的 Tensor。数据类型为 ``bfloat16`` 、 ``float16`` 、 ``float32`` 、 ``float64`` 、 ``int32`` 或 ``int64`` 。别名 ``other`` 。 |
There was a problem hiding this comment.
中文和英文之间缺少空格。应该将 别名 ``input``` 和 别名 other``` 改为 `别名：input 和 `别名：``other，以符合文档书写规范。
Comment on lines
+21
to
+22
| - **x** (Tensor) - 输入的 `Tensor`。它的形状可以是一维或二维。其数据类型应为 float16、float32、float64、int32、int64、complex64、complex128。别名 ``input`` 。 | ||
| - **offset** (int，可选) - 对角线偏移量。正值表示上对角线，0 表示主对角线，负值表示下对角线。默认值为 0。别名 ``diagonal`` 。 |
There was a problem hiding this comment.
中文和英文之间缺少空格。应该将 别名 ``input``` 和 别名 diagonal``` 改为 `别名：input 和 `别名：``diagonal，以符合文档书写规范。
|
|
||
| - **x** （Tensor）- 输入的 N-D `Tensor`，数据类型为：bool，uint8，int8，int16，int32，int64。 | ||
| - **out** （Tensor，可选）- 输出的结果 `Tensor`，是与输入数据类型相同的 N-D `Tensor`。默认值为 None，此时将创建新的 Tensor 来保存输出结果。 | ||
| - **x** （Tensor）- 输入的 N-D `Tensor`，数据类型为：bool，uint8，int8，int16，int32，int64。别名 ``input``。 |
There was a problem hiding this comment.
中文和英文之间缺少空格。应该将 别名 ``input``` 改为 别名：``input```，以符合文档书写规范。
Comment on lines
+20
to
+21
| - **x** （Tensor）- 输入的 N-D `Tensor`，数据类型为：bool，uint8，int8，int16，int32，int64。别名 ``input``。 | ||
| - **y** （Tensor）- 输入的 N-D `Tensor`，数据类型为：bool，uint8，int8，int16，int32，int64。别名 ``other``。 |
There was a problem hiding this comment.
中文和英文之间缺少空格。应该将 别名 ``input``` 和 别名 other``` 改为 `别名：input 和 `别名：``other，以符合文档书写规范。
|
|
||
| 关键字参数 | ||
| ::::::::: | ||
| - **out** (Tensor，可选) - 输出 Tensor，若不为 ``None``，计算结果将保存在该 Tensor 中，默认值为 ``None``。 |
There was a problem hiding this comment.
中文和英文之间缺少空格。应该将 若不为 ``None``` 改为 若不为 None```（在 None`` 前添加空格），以符合文档书写规范中关于中英文间需要空格分隔的要求。
|
|
||
| 关键字参数 | ||
| ::::::::: | ||
| - **out** (Tensor，可选) - 输出 Tensor，若不为 ``None``，计算结果将保存在该 Tensor 中，默认值为 ``None``。 |
There was a problem hiding this comment.
中文和英文之间缺少空格。应该将 若不为 ``None``` 改为 若不为 None```（在 None`` 前添加空格），以符合文档书写规范中关于中英文间需要空格分隔的要求。
|
|
||
| 关键字参数 | ||
| ::::::::: | ||
| - **out** (Tensor，可选) - 输出 Tensor，若不为 ``None``，计算结果将保存在该 Tensor 中，默认值为 ``None``。 |
There was a problem hiding this comment.
中文和英文之间缺少空格。应该将 若不为 ``None``` 改为 若不为 None```（在 None`` 前添加空格），以符合文档书写规范中关于中英文间需要空格分隔的要求。
| 参数 | ||
| ::::::::: | ||
| - **x** (Tensor) - 该 OP 的输入为 Tensor。数据类型为 float32，float64，complex64，complex128。别名 ``input``。 |
There was a problem hiding this comment.
中文和英文之间缺少空格。应该将 别名 ``input``` 改为 别名：``input```，以符合文档书写规范中关于中英文间需要空格分隔的要求。此外，建议在"别名"后添加冒号以保持一致性。
Comment on lines
+21
to
+22
| - **x** （Tensor）- 输入的 N-D `Tensor`，数据类型为：bool，uint8，int8，int16，int32，int64。别名 ``input``。 | ||
| - **y** （Tensor）- 输入的 N-D `Tensor`，数据类型为：bool，uint8，int8，int16，int32，int64。别名 ``other``。 |
There was a problem hiding this comment.
中文和英文之间缺少空格。应该将 别名 ``input``` 和 别名 other``` 改为 `别名：input 和 `别名：``other，以符合文档书写规范。
Comment on lines
+28
to
+29
| - **x** (Tensor) - 赫维赛德阶跃函数的输入 Tensor。数据类型为 bfloat16、float16、float32、float64、int32 或 int64。别名 ``input``。 | ||
| - **y** (Tensor) - 决定了一个赫维赛德阶跃函数的 Tensor。数据类型为 bfloat16、float16、float32、float64、int32 或 int64。别名 ``values``。 |
There was a problem hiding this comment.
中文和英文之间缺少空格。应该将 别名 ``input``` 和 别名 values``` 改为 `别名：input 和 `别名：``values，以符合文档书写规范。
zhwesky2010
force-pushed
the
coding_agent
branch
from
d2f6f33 to
dd624f4
Compare
zhwesky2010
changed the title
zhwesky2010
changed the title
zhwesky2010
force-pushed
the
coding_agent
branch
4 times, most recently
from
b262c08 to
05bf635
Compare
zhwesky2010
force-pushed
the
coding_agent
branch
from
05bf635 to
288d852
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
主要修改内容
1. AI编程规则文件
适用于《Paddle API兼容性项目》工作，定义了以下规则文件：
0-api-compatibility.mdr)1-scheme-decision.mdr)2-2-sink-to-cpp.mdr)3-paconvert-test.mdr)4-modify-docs.mdr)规则文件本身无法独立运行，必须与Agent配合使用，作为Agent执行的指令依据。系统采用主控智能体 + 子智能体的协作架构，上述5份规则文件分别对应不同智能体的执行指令。通过各智能体的协同工作，完成了以下Paddle / PaConvert / Docs的开发。
2. 代码开发
python_api_info.yaml、_paddle_docs.py内容格式。代码提交至 API Compatibility Edit by AI Agent Paddle#771613. 文档更新
out的支持说明，代码提交至本PR涉及API
本PR涉及以下15个API的文档更新：
技术特点