Skip to content

[Doc Link Fix No.39] 文档链接修复 #7920

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

Open
jasminenetf wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

[Doc Link Fix No.39] 文档链接修复 #7920

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 9 additions & 9 deletions docs/dev_guides/api_contributing_guides/read_before_contributing_cn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 贡献前阅读

本章主要介绍开发飞桨原生算子 API 的方法，可先参见通用的 [代码贡献流程](../code_contributing_path_cn.html) 章节，再结合本文介绍的 API 开发要点，即可掌握飞桨原生算子 API 开发方法和流程。
本章主要介绍开发飞桨原生算子 API 的方法，可先参见通用的 [代码贡献流程](../code_contributing_path_cn.md) 章节，再结合本文介绍的 API 开发要点，即可掌握飞桨原生算子 API 开发方法和流程。

## 一、飞桨原生算子 API 开发解读

Expand All @@ -20,7 +20,7 @@

设计文档，通常也叫 RFC（Request for Comment）文档，可方便飞桨社区开发者充分交流设计思路，以便进一步完善设计方案，并确保与飞桨设计理念一致。请参考如下步骤完成 API 设计文档的提交：

1. 阅读 [API 设计和命名规范](api_design_guidelines_standard_cn.html)，确保新增 API 符合飞桨相关规范。
1. 阅读 [API 设计和命名规范](api_design_guidelines_standard_cn.md)，确保新增 API 符合飞桨相关规范。
2. 根据 [API 设计文档模版](https://github.com/PaddlePaddle/community/blob/master/rfcs/APIs/api_design_template.md)，填写必要的设计内容。另外可参考 [API 设计文档样例](https://github.com/PaddlePaddle/community/blob/master/rfcs/APIs/20200301_api_design_for_quantile.md)。
3. 将设计文档提交 Pull Request （PR）到 [community/rfcs/APIs/ ](https://github.com/PaddlePaddle/community/tree/master/rfcs/APIs) 目录下。
4. 等待文档接受评审和讨论，并根据各方意见修改文档。通常飞桨开发者会在三个工作日内回复，如果 API 功能较复杂，还将发起评审会议，并提前在 PR 的评论区公布会议时间、会议地址、参与人、议题等内容，请及时关注 PR 中最新动态。
Expand All @@ -31,10 +31,10 @@

当 API 设计文档合入后，开发者即可进行代码开发。此过程请参考相应的开发规范，包括如下步骤：

- 如果新增 API 不需要开发新的 C++ 算子，可以用其他 Python API 组合得到新的 API，请参考 [开发 API Python 端](new_python_api_cn.html) 章节完成，包括开发 Python 代码、单元测试代码和 API 文档等步骤。
- 如果新增 API 需要开发新的 C++ 算子，请参考 [开发 C++ 算子](new_cpp_op_cn.html) 章节完成，包括开发算子实现代码、封装 Python API 代码、单元测试代码和 API 文档等步骤。
- 如果新增 API 不需要开发新的 C++ 算子，可以用其他 Python API 组合得到新的 API，请参考 [开发 API Python 端](new_python_api_cn.md) 章节完成，包括开发 Python 代码、单元测试代码和 API 文档等步骤。
- 如果新增 API 需要开发新的 C++ 算子，请参考 [开发 C++ 算子](new_cpp_op_cn.md) 章节完成，包括开发算子实现代码、封装 Python API 代码、单元测试代码和 API 文档等步骤。
- 在 paddle/phi/kernels 目录下存放了飞桨框架已经实现的不同硬件的算子内核，可供开发 C++ 算子 时调用。
- 有时也需要自己开发新的算子内核，这时可能需要使用硬件支持的软件栈（如 CUDA）来实现，或者使用飞桨框架提供的 Kernel Primitive API 来实现，后者具体介绍请参见 [Kernel Primitive API](../op_optimization/kernel_primitive_api/index_cn.html) 章节。
- 有时也需要自己开发新的算子内核，这时可能需要使用硬件支持的软件栈（如 CUDA）来实现，或者使用飞桨框架提供的 Kernel Primitive API 来实现，后者具体介绍请参见 [Kernel Primitive API](../op_optimization/kernel_primitive_api/index_cn.rst) 章节。

值得注意的是，代码开发完成后，请确保通过了全部单元测试和 CI 测试，才能合入代码。

Expand All @@ -44,7 +44,7 @@

请遵循如下开发规范和测试要求：

- [代码风格规范](../git_guides/codestyle_check_guide_cn.html)
- [API 设计和命名规范](api_design_guidelines_standard_cn.html)
- [API 单元测试及验收规范](api_acceptance_criteria_cn.html)
- [Paddle CI 测试详解](../git_guides/paddle_ci_manual_cn.html)
- [代码风格规范](../git_guides/codestyle_check_guide_cn.md)
- [API 设计和命名规范](api_design_guidelines_standard_cn.md)
- [API 单元测试及验收规范](api_acceptance_criteria_cn.md)
- [Paddle CI 测试详解](../git_guides/paddle_ci_manual_cn.md)