【PFCC-Roadmap】框架文档

[TCChenlong]

Roadmap

• 2022.5.24： 飞桨框架文档方向已发邮件至 [email protected]，如果你对本方向感兴趣而未收到邮件，请发送邮件至 [email protected] 反馈。

PaddlePaddle是一个深度学习框架，开发者在使用飞桨框架时，第一步便会浏览文档。飞桨官网 - 文档提供了内容丰富的文档，帮助开发者快速上手并深入使用飞桨。飞桨框架文档重点包含以下内容：

• 安装指南：是飞桨框架通过各种方式（Pip安装、Conda安装、Docker安装、源码编译）等进行本地安装的文档说明；
• 使用指南：包含使用飞桨框架进行模型开发、模型可视化、将动态图转为静态图、将训练好的模型进行推理部署、使用分布式训练完成训练加速、自定义飞桨框架算子、算子映射与飞桨框架在不同硬件上的支持情况等等。
• 应用实践：提供了丰富的端到端的深度学习场景的案例，可以帮助开发者在案例中，快速上手飞桨框架，场景包括快速上手、计算机视觉、自然语言处理、推荐系统、强化学习、时序数据、动转静等。
• API文档：飞桨框架的API文档，将所有公开API，按目录进行展示，并提供了中英文版本。每个子目录会有当前目录的Overview页面，按类别列举当前目录下的API。
• 常见问题与解答：以问答对的形式收录了开发过程中遇到的高频咨询类问题，包含了2.X版本的变化、安装、数据与数据处理、模型组网、训练、预测、模型保存与加载、参数调整、分布式等几类常见问题。
• Release Note：是当前版本的Release Note，说明了当前版本的最新特性、功能优化与bug修复等信息。

飞桨框架自开源以来，就提供了高质量的中英文文档。也有许多开发者为文档质量的提升，做出了重要的贡献，非常感谢每一位开发者对飞桨文档的支持，也非常欢迎你选择任意感兴趣的部分来参与。

[TCChenlong]

附录 - API文档

【方向说明】

• 技术标签：深度学习框架，Python
• 详细描述：有些有些飞桨框架的的API文档写的不够规范，我们联合 Docs Working Group，对API文档进行了全面的 review，并通过 Issues · PaddlePaddle/docs 说明了各个API文档中存在的问题，对适合修复的问题，都标记了 PR is welcome 的标签。你可以选择感兴趣的 Issue，直接提PR进行修复。

【参与指南】：

• 飞桨成立了 PFCC(Paddle Framework Contributor Club)，是一个有兴趣、正在、或者已经为飞桨开源框架做开源贡献的贡献者而成立的虚拟组织，在这里，飞桨开源框架的贡献者进行讨论、交流和分享，并为飞桨框架做出持续的贡献。欢迎你持续关注并加入（我们会定向邀请 Paddle repo 提交PR的开发者加入）。

• 如果你对文档方向感兴趣，可以在石墨表格《PFCC-Roadmap》之【报名页】填入你的 GitHub ID，之后一起讨论后续规划和分工。

【提交流程】

• 修复流程：请根据 Issue 中描述的API文档问题，参考 飞桨API文档书写规范、 中文API文档贡献指南、英文API文档贡献指南，提PR进行修复。

【提交内容】

• 修复 Issue 中描述的API文档问题的PR，在PR的描述中要写清楚，修复了哪个ISSUE，可以参考 #4321 fix paddle.tile cn docs by SigureMo。

【合入标准】

• 按照 飞桨API文档书写规范 修复 Issue 中存在的问题，并通过所有PR的CI检测。

【技术要求】

• 熟悉Paddle框架的API使用
• 熟练掌握 Python

【参考内容】

• 文档：Wiki · PaddlePaddle/docs
• PR模板： #4321 fix paddle.tile cn docs by SigureMo

[TCChenlong]

附录 - 应用实践

【方向说明】

• 技术标签：深度学习框架，Python
• 详细描述：目前飞桨框架2.3版本即将发布，在该版本中，飞桨框架面向用户体验做了一系列的升级优化。为了能够让用户快速掌握到飞桨框架升级内容，并了解和学习如何使用飞桨框架2.3 进行相关任务的开发，我们进行应用案例教程的立项，在不同的任务场景上为用户提供一个端到端的易学案例，来快速的传递相关知识和使用方法。

【参与指南】：

• 飞桨成立了 PFCC(Paddle Framework Contributor Club)，是一个有兴趣、正在、或者已经为飞桨开源框架做开源贡献的贡献者而成立的虚拟组织，在这里，飞桨开源框架的贡献者进行讨论、交流和分享，并为飞桨框架做出持续的贡献。欢迎你持续关注并加入（我们会定向邀请 Paddle repo 提交PR的开发者加入）。

• 如果你对文档方向感兴趣，可以在石墨表格《PFCC-Roadmap》之【报名页】填入你的 GitHub ID，之后一起讨论后续规划和分工。

【提交流程】

• 你可以参考 石墨表格《PFCC-Roadmap》之【文档 - 应用实践】 中的任务清单，选择感兴趣的任务进行认领。

【提交内容】

• 新增应用实践的PR，要求使用飞桨。

【合入标准】

• 按照飞桨文档写作规范，新增应用实践文档，并通过所有PR的CI检测。

【技术要求】

• 熟悉Paddle框架的API使用
• 熟练掌握 Python

【参考内容】

• 文档：Wiki · PaddlePaddle/docs