Skip to content

Paddle主框架文档修复任务,速来! #71203

Open
@DrRyanHuang

Description

@DrRyanHuang

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

(往期回顾:PaddlePaddle/docs#6165

🌟 秘境异动·代码示警

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

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


🎯 修真任务·贡献指南

🔧 格式精修 清除代码异常

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

🌐 结构优化 重构知识星图

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

💎 内容增强 完善文档内容

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

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

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

没有完成的子任务(10、20、21、22、23、33)可以持续认领

序号 内容链接 认领人/状态/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 #7075
@deeper-roots
@NJX-njx
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
@NJX-njx
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
@NJX-njx
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
@NJX-njx
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
@NJX-njx
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
@NJX-njx
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
@NJX-njx
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
@cangtianhuang #7105
@NJX-njx
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
@NJX-njx
10 ⚠️ 修改】基础概念
docs/api_guides/low_level/program.rst
https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api_guides/low_level/program.html
@Abosite #7077
@deeper-roots
@NJX-njx
@QuarryFlow #7298
11 ⚠️ 修改】执行引擎
docs/api_guides/low_level/executor_en.rst
https://www.paddlepaddle.org.cn/documentation/docs/en/develop/api_guides/low_level/executor_en.html
@Cutelemon6 #7076
@NJX-njx
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
@NJX-njx
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_en.html
@datutu-L #7061 #7066
@cangtianhuang #7106
19 ⚠️ 修改】模型参数
docs/api_guides/low_level/parameter_en.rst
https://www.paddlepaddle.org.cn/documentation/docs/en/develop/api_guides/low_level/parameter_en.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_en.html
@Abosite #7077
21 【删除 + 修改】原 fluid 部分的 activations
docs/api_guides/low_level/layers/activations_en.rst
docs/api_guides/low_level/layers/activations.rst
@Abosite #7080
@Echo-Nie #7297
@QuarryFlow
22 【删除 + 修改】原 fluid 部分的 control_flow
docs/api_guides/low_level/layers/control_flow_en.rst
docs/api_guides/low_level/layers/control_flow.rst
@Abosite #7080 #7083 #7085
@QuarryFlow
23 【删除 + 修改】原 fluid 部分的 conv
docs/api_guides/low_level/layers/conv_en.rst
docs/api_guides/low_level/layers/conv.rst
@Abosite #7080
@QuarryFlow
24 【删除 + 修改】原 fluid 部分的 data_feeder
docs/api_guides/low_level/layers/data_feeder_en.rst
docs/api_guides/low_level/layers/data_feeder.rst
@Abosite #7080 #7083 #7085 #7086
25 【删除 + 修改】原 fluid 部分的 data_in_out
docs/api_guides/low_level/layers/data_in_out_en.rst
docs/api_guides/low_level/layers/data_in_out.rst
@Abosite #7080 #7083 #7085 #7086
26 【删除 + 修改】原 fluid 部分的 detection
docs/api_guides/low_level/layers/detection_en.rst
docs/api_guides/low_level/layers/detection.rst
@Abosite #7080 #7083 #7085 #7086
27 【删除 + 修改】原 fluid 部分的 index
docs/api_guides/low_level/layers/index_en.rst
docs/api_guides/low_level/layers/index.rst
@Abosite #7080
@Echo-Nie #7135
28 【删除 + 修改】原 fluid 部分的 learning_rate_scheduler
docs/api_guides/low_level/layers/learning_rate_scheduler_en.rst
docs/api_guides/low_level/layers/learning_rate_scheduler.rst
@Abosite #7080
@Echo-Nie #7182
29 【删除 + 修改】原 fluid 部分的 loss_function
docs/api_guides/low_level/layers/loss_function_en.rst
docs/api_guides/low_level/layers/loss_function.rst
@Abosite #7080
@Echo-Nie #7227
30 【删除 + 修改】原 fluid 部分的 math
docs/api_guides/low_level/layers/math_en.rst
docs/api_guides/low_level/layers/math.rst
@Abosite #7080 #7083 #7085 #7086
31 【删除 + 修改】原 fluid 部分的 pooling
docs/api_guides/low_level/layers/pooling_en.rst
docs/api_guides/low_level/layers/pooling.rst
@Abosite #7080
@Echo-Nie #7228 #7297
32 【删除 + 修改】原 fluid 部分的 sequence
docs/api_guides/low_level/layers/sequence_en.rst
docs/api_guides/low_level/layers/sequence.rst
@Abosite #7080 #7083 #7085 #7086
33 【删除 + 修改】原 fluid 部分的 sparse_update
docs/api_guides/low_level/layers/sparse_update_en.rst
docs/api_guides/low_level/layers/sparse_update.rst
@Abosite #7080 #7083
34 【删除 + 修改】原 fluid 部分的 tensor
docs/api_guides/low_level/layers/tensor_en.rst
docs/api_guides/low_level/layers/tensor.rst
@Abosite #7080 #7083 #7085 #7086

🏹 参与方式

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

  • 御剑飞行至秘籍藏经阁(Fork 飞桨 Docs GitHub 仓库🗝️
  • 施展"分支大法",创建你的修复空间 🌿(创建你的分支,可选)
  • 运用"PR 秘技",提交你的改动 ✨
  • 提交 PR 后, 稍等片刻,待飞桨工程师 review 代码高呼"文档焕新,乾坤再造",等待飞桨长老院审阅

📌 特别说明⚠️ 本活动需要修改的文档,均为 develop 分支的内容⚠️
🎯 高阶传道,低阶引路 🧘‍♂️ 高阶工程师宜以高瞻远瞩之心,将入门级的任务让予初握git之匙的道友历练(对于简单任务,也要给其他第一次使用github的同学尝试的机会呀😉)


🏆 贡献奖励

  • 获得"文档守护者"神秘称号 👑
  • 荣誉认证:永久记录于版本发行说明,你的大名将永载飞桨史册(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主框架文档提升 34 34 / 34 100.0% 29 85.29%

统计信息

排名不分先后 @Cutelemon6 (2) @cszdrg (2) @lmj1120201854 (2) @yuwu46 (2) @mzj104 (2) @cangtianhuang (8) @Echo-Nie (5) @Abosite (6)

Metadata

Metadata

Labels

PFCCPaddle Framework Contributor Club,https://github.com/PaddlePaddle/community/tree/master/pfccstatus/new-issue新建type/others其他问题

Type

No type

Projects

Status

In Progress

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions