[API Compatibility] Add nn.Constant/Reflection/Replication Pad layers
1. 新增如下 API 文档:
nn.ConstantPad1D/2D/3D nn.ReflectionPad1D/2D/3D nn.ReplicationPad1D/2D/3D nn.CircularPad1D/2D/3D
以及上述十二个 API "D" 为小写的别名(例如 nn.ConstantPad1D -> nn.ConstantPad1d)。
由于 rst 的标签不区分大小写,同时避免在不区分大小写的文件系统内文件重名的问题,小写的 API 文档增加了compat后缀,标签也增加了 compat 后缀。
关联 PR:https://github.com/PaddlePaddle/Paddle/pull/76136
2. 优化根据文件名校验首行 Label 的逻辑,展示所有报错信息后再退出,并在错误信息中打印预期值。
旧报错:
2025-11-05 19:57:28 2025-11-05 11:57:28,085 - run_cn_api_label_checking:79
- ERROR - The first line in /FluidDoc/docs//api/paddle/nn/ConstantPad1D_cn.rst is not available, please re-check it!
新报错:
2025-11-06 10:20:52 2025-11-06 02:20:52,963 - run_cn_api_label_checking:83 - ERROR - ??? First Line API Label Mismatch
2025-11-06 10:20:52 File: api/paddle/nn/ConstantPad1D_cn.rst
2025-11-06 10:20:52 ???? Actual: `.. _cn_api_paddle_nn_ConstantPad1d:`
2025-11-06 10:20:52 ??? Expected: `.. _cn_api_paddle_nn_ConstantPad1D:`
2025-11-06 10:20:52
2025-11-06 10:20:52 (Note: The 'Expected' label is auto-generated based on the file path.
2025-11-06 10:20:52 Please check if the filename is correct or update the first line of the file to match.)
感谢你贡献飞桨文档,文档预览构建中,Docs-New 跑完后即可预览,预览链接:http://preview-pr-7596.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html 预览工具的更多说明,请参考:飞桨文档预览工具
📚 本次 PR 文档预览链接(点击展开)
|
ℹ️ 预览提醒 请等待 Docs-NEW 流水线运行完成后再点击预览链接,否则可能会看到旧版本内容或遇到链接无法访问的情况。
|
docs/api/paddle/nn/CircularPad1D__upper_cn.rst: 点击预览docs/api/paddle/nn/CircularPad1d_cn.rst: 点击预览docs/api/paddle/nn/CircularPad2D__upper_cn.rst: 点击预览docs/api/paddle/nn/CircularPad2d_cn.rst: 点击预览docs/api/paddle/nn/CircularPad3D__upper_cn.rst: 点击预览docs/api/paddle/nn/CircularPad3d_cn.rst: 点击预览docs/api/paddle/nn/ConstantPad1D__upper_cn.rst: 点击预览docs/api/paddle/nn/ConstantPad1d_cn.rst: 点击预览docs/api/paddle/nn/ConstantPad2D__upper_cn.rst: 点击预览docs/api/paddle/nn/ConstantPad2d_cn.rst: 点击预览docs/api/paddle/nn/ConstantPad3D__upper_cn.rst: 点击预览docs/api/paddle/nn/ConstantPad3d_cn.rst: 点击预览docs/api/paddle/nn/Overview_cn.rst: 点击预览docs/api/paddle/nn/ReflectionPad1D__upper_cn.rst: 点击预览docs/api/paddle/nn/ReflectionPad1d_cn.rst: 点击预览docs/api/paddle/nn/ReflectionPad2D__upper_cn.rst: 点击预览docs/api/paddle/nn/ReflectionPad2d_cn.rst: 点击预览docs/api/paddle/nn/ReflectionPad3D__upper_cn.rst: 点击预览docs/api/paddle/nn/ReflectionPad3d_cn.rst: 点击预览docs/api/paddle/nn/ReplicationPad1D__upper_cn.rst: 点击预览docs/api/paddle/nn/ReplicationPad1d_cn.rst: 点击预览docs/api/paddle/nn/ReplicationPad2D__upper_cn.rst: 点击预览docs/api/paddle/nn/ReplicationPad2d_cn.rst: 点击预览docs/api/paddle/nn/ReplicationPad3D__upper_cn.rst: 点击预览docs/api/paddle/nn/ReplicationPad3d_cn.rst: 点击预览
CI 报错,这些大小写要对应起来
OK,我晚点改成 __upper 的后缀
另外之前大小写敏感的解决方式是在大写的那个 加上
__upper
Paddle 里1D 的 D 大写才是正统,小写的 API 才是兼容性的 API,这个也走 upper的方案吗?还是小写用 __lower表示?
另外之前大小写敏感的解决方式是在大写的那个 加上
__upperPaddle 里1D 的 D 大写才是正统,小写的 API 才是兼容性的 API,这个也走 upper的方案吗?还是小写用 __lower表示?
也走 __upper 吧,文档里统一就好,别人看 api 还是原来的名字
@ooooo-create 同名的 API 在英文文档那边似乎只保留了一个,如下图circular系列有小写d结尾的 API,Constant 系列是大写的 D,导致 COPY-FROM Circular 系列中文文档失败了。
这个有解决方案吗?如果一时半会没法解决的话吧 copy from Circular 改成小写的d吧?
同名的 API 在英文文档那边似乎只保留了一个
__all__ 里面两者都得添加上吧,或者非别名的肯定得加上,如果只保留一个的话,可能会保留非别名的 api 文档吧,不太确定。但是之前里面只有小写 d 没有大写的 D,加上的话,应该可以解决你这个问题
