docs
docs copied to clipboard
PaddlePaddle
【Docathon】补充缺失的中文 API 文档
背景
飞桨官网的 API 文档，有中文和英文两个版本，都存储于 GitHub 中，并通过技术手段转为 HTML 文件后呈现在官网。
-
中文 API 文档存储于 docs 仓库下，具体路径为 PaddlePaddle/docs/docs/api/paddle。 -
英文 API 文档存储于 Paddle 仓库下的对应的 API 源码中，具体路径为 PaddlePaddle/Paddle/python/paddle。
以 paddle.add 为例，在 develop 分支下
- 中文文档 URL： https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/add_cn.html，api/paddle/add_cn.html即对应 (docs/docs/)api/paddle/add_cn.rst
- 英文文档 URL：https://www.paddlepaddle.org.cn/documentation/docs/en/develop/api/paddle/add_en.html， 进入文档页面中点击 [source] 即可跳转至 add 源代码中。
原则上官网 API 文档必须提供中文和英文两个版本，但目前许多 API 文档只提供了英文版本，而缺失了中文版本，导致这些API不容易被开发者发现和有效利用。为了解决这个问题，我们号召大家一起努力来补充这些 API 的中文文档。
任务结束后，完成该任务的开发者将会在官网中进行展示哦🎉
任务描述：
我们提供了部分缺失中文文档的 API 清单，如下所示。请根据提供的 API 的英文文档，来补充相应的中文文档。补充完后请 request 对应的 API 负责人（Paddle 内部研发） review.
⚠️注意：补充文档时，还需要注意下是否需要在相应的
overview.rst等综述页面增加相关 API 描述
任务认领
[!NOTE] 1. Issue 回复格式： 为了自动填写报名信息，需要在 issue 下回复报名信息，如果报名格式不正确，则会在 comment 区提示报名不正确，格式如下：
【报名】: 2、3、6-10其中【报名】: 后直接是报名的赛题序号，多个赛题之间需要用中文顿号
、分隔，多个连续赛题可以用横线表示
[!NOTE] 2. PR 标题格式：
[Docathon][Add CN Doc No.2、3、6-10]PR的标题中以
[Docathon][Add CN Doc No.xxxx]开头即可，程序会自动提取赛题编号并更新榜单。 一个 PR 也可以提交多个赛题，多个赛题间以顿号或横线分隔，比如 No.24、26-28、30 赛题。
[!NOTE] 3. PR 内容： 描述新增了什么文档、附上该 issue 链接、 附上英文文档链接、并 @sunzhongkai588 和表中的 API 负责人review
参考资料：
看板信息
| 任务方向 | 任务数量 | 提交作品 / 任务认领 | 提交率 | 完成 | 完成率 |
|---|---|---|---|---|---|
| Docathon | 67 | 63 / 65 | 94.03% | 47 | 70.15% |
统计信息
排名不分先后 @Turingg (6) @zade23 (28) @Kaedeharai (6) @entired (3) @ooooo-create (4)
