Paddle主框架文档修复任务，速来！

[DrRyanHuang]

🎉 【Docathon 御剑令】《飞桨真经》残卷修复计划 | 急招文档修真者！ 🚀

（往期回顾：PaddlePaddle/docs#6165）

🌟 秘境异动·代码示警

诸位道友，飞桨藏经阁突现时空裂隙！《Paddle 真经》遭遇三大危机：
🔸 混沌目录 - 章节如星斗错位，修士迷失方向（🌀）
🔸 异常代码 - API 说明暗藏隐患，运行时报错（😱）
🔸 文档缺失 - 核心接口缺少示例，开发者顿足捶胸（💥）

此局不解，恐误万千开发者修行！ 即刻御剑前来，共修优质文档大道！✨

---

🎯 修真任务·贡献指南

🔧 格式精修 清除代码异常

• 有些文档早已过时，无需进行维护，删除即可
• Markdown / reStructuredText 星轨校准 ✍️ (修复 markdown / rst 格式的语法)
• 注释规范化处理（修复中英混杂/格式混乱）🔮
• 失效案例修正（修复无法运行的代码示例）💻

🌐 结构优化 重构知识星图

• 章节乾坤挪移术 📜 （删除/修改文档路径）
• 交叉索引引路符 ➡️
• API 藏宝图优化 🗺️（修复文档中无法点击的链接🔗）

💎 内容增强 完善文档内容

• 缺失心诀追魂术（补充代码示例）🔍
• 双语文档同步 🌍
• 图解大道真意（添加流程图/示意图）🎨

---

💡 Tips: 很多优秀的 Paddle 开发者都是从文档贡献开始的，这可能是你开启精彩开源之旅的第一步！

🧙‍♂️ 秘籍修复任务总览（持续更新 ing） 🔥

序号	内容链接	认领人/状态/PR 号
1	【⚠️ 修改】执行引擎 docs/api_guides/low_level/executor.rst https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api_guides/low_level/executor.html	@Cutelemon6 @deeper-roots
2	【删除】反向传播 docs/api_guides/low_level/backward.rst https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api_guides/low_level/backward.html	@cszdrg #7056
3	【删除】CompiledProgram docs/api_guides/low_level/compiled_program.rst https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api_guides/low_level/compiled_program.html	@lmj1120201854 #7067
4	【删除】预测引擎 docs/api_guides/low_level/inference.rst https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api_guides/low_level/inference.html	@yuwu46 #7058
5	【删除】评价指标 docs/api_guides/low_level/metrics.rst https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api_guides/low_level/metrics.html	@mzj104 #7059 #7062
6	【删除】模型保存与加载 docs/api_guides/low_level/model_save_reader.rst https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api_guides/low_level/model_save_reader.html	@cangtianhuang #7064 #7072
7	【删除】复杂网络 docs/api_guides/low_level/nets.rst https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api_guides/low_level/nets.html	@cangtianhuang #7064 #7072
8	【⚠️ 修改】优化器 docs/api_guides/low_level/optimizer.rst https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api_guides/low_level/optimizer.html	@datutu-L #7060 #7066
9	【⚠️ 修改】模型参数 docs/api_guides/low_level/parameter.rst https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api_guides/low_level/parameter.html	@cangtianhuang #7070
10	【⚠️ 修改】基础概念 docs/api_guides/low_level/program.rst https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api_guides/low_level/program.html	@Abosite @deeper-roots
11	【⚠️ 修改】执行引擎 docs/api_guides/low_level/executor_en.rst https://www.paddlepaddle.org.cn/documentation/docs/en/develop/api_guides/low_level/executor.html	@Cutelemon6
12	【删除】反向传播 docs/api_guides/low_level/backward_en.rst https://www.paddlepaddle.org.cn/documentation/docs/en/develop/api_guides/low_level/backward.html	@cszdrg #7056
13	【删除】CompiledProgram docs/api_guides/low_level/compiled_program_en.rst https://www.paddlepaddle.org.cn/documentation/docs/en/develop/api_guides/low_level/compiled_program.html	@lmj1120201854 #7068 #7067
14	【删除】预测引擎 docs/api_guides/low_level/inference_en.rst https://www.paddlepaddle.org.cn/documentation/docs/en/develop/api_guides/low_level/inference.html	@yuwu46 #7058
15	【删除】评价指标 docs/api_guides/low_level/metrics_en.rst https://www.paddlepaddle.org.cn/documentation/docs/en/develop/api_guides/low_level/metrics.html	@mzj104 #7059 #7062
16	【删除】模型保存与加载 docs/api_guides/low_level/model_save_reader_en.rst https://www.paddlepaddle.org.cn/documentation/docs/en/develop/api_guides/low_level/model_save_reader.html	@cangtianhuang #7065 #7073
17	【删除】复杂网络 docs/api_guides/low_level/nets_en.rst https://www.paddlepaddle.org.cn/documentation/docs/en/develop/api_guides/low_level/nets.html	@cangtianhuang #7065 #7073
18	【⚠️ 修改】优化器 docs/api_guides/low_level/optimizer_en.rst https://www.paddlepaddle.org.cn/documentation/docs/en/develop/api_guides/low_level/optimizer.html	@datutu-L #7061 #7066
19	【⚠️ 修改】模型参数 docs/api_guides/low_level/parameter_en.rst https://www.paddlepaddle.org.cn/documentation/docs/en/develop/api_guides/low_level/parameter.html	@cangtianhuang #7071
20	【⚠️ 修改】基础概念 docs/api_guides/low_level/program_en.rst https://www.paddlepaddle.org.cn/documentation/docs/en/develop/api_guides/low_level/program.html	@Abosite

🏹 参与方式

御剑登记：在下方高呼"本座愿往！" ✨ 请前往附录的任务认领部分查看
施展神通：fork → 修改 → PR 渡劫 💫

• 御剑飞行至秘籍藏经阁（Fork 飞桨 Docs GitHub 仓库🗝️
• 施展"分支大法"，创建你的修复空间 🌿（创建你的分支，可选）
• 运用"PR 秘技"，提交你的改动 ✨
  • 如果你是第一次修改，别担心，看这里：【Docathon】补充Overview文档相关API描述 docs#6427
• 提交 PR 后, 稍等片刻，待飞桨工程师 review 代码高呼"文档焕新，乾坤再造"，等待飞桨长老院审阅

📌 特别说明：⚠️ 本活动需要修改的文档，均为 develop 分支的内容。⚠️

---

🏆 贡献奖励

• 获得"文档守护者"神秘称号 👑
• 荣誉认证：永久记录于版本发行说明，你的大名将永载飞桨史册（Contributors 名单）📜
• 限定周边：开源社区专属纪念品，限量版开源周边法宝
• 进阶通道：核心贡献者快速通道资格 ，直通 Paddle 核心长老团试炼

🐉 勇士啊，别犹豫了！点击右上角的 Issue 按钮，开启你的文档修复冒险吧！

（悄悄告诉你：提交 PR 还能触发自动炼丹术，让你的修复更上一层楼哦~）🧪✨

💪 任务认领

Important

请务必严格按照格式填写，否则无法快乐开源小助手无法自动更新信息

1. Issue 回复格式：

为了自动填写报名信息，需要在 issue 下回复报名信息，如果报名格式不正确，则会在 comment 区提示报名不正确，格式如下：

【报名】: 2、3、6-10

📌 其中【报名】: 后直接是报名的赛题序号，多个赛题之间需要用中文顿号、分隔，多个连续赛题可以用横线表示

2. PR 标题格式：

[Docathon][Update Doc No.2、3、6-10]+相关描述

PR 的标题中以 [Docathon][Update Doc No.xxxx] 开头即可，程序会自动提取赛题编号并更新榜单。
一个 PR 也可以提交多个赛题，多个赛题间以顿号或横线分隔，比如 No.24、26-28、30 赛题。

3. PR 描述格式：

[描述修改和删除的内容]

[其他需要注意的信息（没有则无需填写）]

- https://github.com/PaddlePaddle/Paddle/issues/71203

@DrRyanHuang 和 @sunzhongkai588

看板信息

任务方向	任务数量	提交作品 / 任务认领	提交率	完成	完成率
Paddle主框架文档提升	20	16 / 20	80.0%	12	60.0%

统计信息

排名不分先后 @cszdrg (2) @lmj1120201854 (2) @yuwu46 (2) @mzj104 (2) @cangtianhuang (4)

[SigureMo]

docs/api_guides 目录是不是可以都删了？基本都是过时的 fluid API 介绍，而且都没有侧边栏，应该都没有其他文档引用 @sunzhongkai588

[sunzhongkai588]

docs/api_guides 目录是不是可以都删了？基本都是过时的 fluid API 介绍，而且都没有侧边栏，应该都没有其他文档引用 @sunzhongkai588

看了下，好像有些是被其他文章引用

• executor.rst （引用处）
• optimizer.rst （都是被 docs/api_guides 引用的）
• parameter.rst （引用处）
• program.rst （引用处）

感觉除了这几个，另外的全删了应该都没影响（英文也得删）

[cszdrg]

【报名】: 2、12

[mzj104]

【报名】: 5、15

[yuwu46]

【报名】: 4、14

[cangtianhuang]

【报名】: 6-7

[datutu-L]

【报名】: 8

[cangtianhuang]

【报名】: 16-17

[cangtianhuang]

【报名】: 9、19

[datutu-L]

【报名】: 8，18

[cangtianhuang]

api_guide_parameter的文档被paddle.static.Program引用，我尝试修改它，但我有一些疑问：
paddle.static.Program文档中的代码示例为何不起作用？除第一条外均为COPY-FROM。我已经查看了源码，确定都有代码示例。
https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/static/Program_cn.html
我希望能做出更多贡献，请为我解惑😘

[DrRyanHuang]

api_guide_parameter的文档被paddle.static.Program引用，我尝试修改它，但我有一些疑问：
paddle.static.Program文档中的代码示例为何不起作用？除第一条外均为COPY-FROM。我已经查看了源码，确定都有代码示例。
paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/static/Program_cn.html
我希望能做出更多贡献，请为我解惑😘

@cangtianhuang 同学好，Paddle目前大版本升级，文档还未更新，感谢同学的贡献，后续还有很多活动，可以多参与

感兴趣可以看下Paddle文档生成的过程 docs/api/gen_doc.py

[cangtianhuang]

api_guide_parameter的文档被paddle.static.Program引用，我尝试修改它，但我有一些疑问：
paddle.static.Program文档中的代码示例为何不起作用？除第一条外均为COPY-FROM。我已经查看了源码，确定都有代码示例。
paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/static/Program_cn.html
我希望能做出更多贡献，请为我解惑😘

@cangtianhuang 同学好，Paddle目前大版本升级，文档还未更新，感谢同学的贡献，后续还有很多活动，可以多参与

感兴趣可以看下Paddle文档生成的过程 docs/api/gen_doc.py

@DrRyanHuang 非常感谢您的解答！所以这仅是文档未更新的问题，而不是代码有误。

我还有更具体的疑问：“9.【⚠️ 修改】模型参数” 的修改是指什么？若要保留文档而非简单删除，我注意到 api 均已发生改变，需要大幅修改，如下：
模型参数：paddle.fluid.ParamAttr -> paddle.ParamAttr
初始化方式：paddle.fluid.initializer -> paddle.nn.initializer
正则化方式：paddle.fluid.regularizer -> paddle.regularizer
Clipping：paddle.fluid.clip -> paddle.nn.ClipGradBy*
模型平均：paddle.fluid.optimizer.ModelAverage -> paddle.static.ExponentialMovingAverage / paddle.incubate.ModelAverage
是否需要这种类型的修改？还是直接删除最佳（同时修改被引处）？

[DrRyanHuang]

我还有更具体的疑问：“9.【⚠️ 修改】模型参数” 的修改是指什么？若要保留文档而非简单删除，我注意到 api 均已发生改变，需要大幅修改，如下：
模型参数：paddle.fluid.ParamAttr -> paddle.ParamAttr
初始化方式：paddle.fluid.initializer -> paddle.nn.initializer
正则化方式：paddle.fluid.regularizer -> paddle.regularizer
Clipping：paddle.fluid.clip -> paddle.nn.ClipGradBy*
模型平均：paddle.fluid.optimizer.ModelAverage -> paddle.static.ExponentialMovingAverage / paddle.incubate.ModelAverage
是否需要这种类型的修改？还是直接删除最佳（同时修改被引处）？

@cangtianhuang 是的，原有的fluid部分API已被弃用。我们需要参照Paddle最新版本的更新，对该文档进行相应修改，文档保持原意的同时，也要修正rst格式的错误，确保网页端文档正确渲染

[cangtianhuang]

@cangtianhuang 是的，原有的fluid部分API已被弃用。我们需要参照Paddle最新版本的更新，对该文档进行相应修改，文档保持原意的同时，也要修正rst格式的错误，确保网页端文档正确渲染

@DrRyanHuang 非常感谢您的回复！我将尝试修改9、19文档。

@datutu-L 此外，我发现 datutu-L 同学对 optimizer 的修改应该不正确，其中保留了很多 fluid api。

[lmj1120201854]

【报名】: 3

[lmj1120201854]

【报名】: 13

[Abosite]

【报名】: 10、20

[Cutelemon6]

【报名】: 1、11

[deeper-roots]

【报名】: 1、10