-
Notifications
You must be signed in to change notification settings - Fork 724
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.
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
【Docathon】补充缺失的中文 API 文档 #6193
Labels
HappyOpenSource
快乐开源活动issue与PR
Comments
【报名】: 64-67 |
【报名】: 4-25、56-61 |
This was referenced Oct 9, 2023
Merged
Closed
【报名】: 1,27-29 |
This was referenced Dec 7, 2023
26 tasks
【报名】: 26-40 |
【报名】:46-54 |
【报名】:55 |
This was referenced Dec 9, 2023
This was referenced Dec 10, 2023
【报名】: 47、48 |
26 tasks
This was referenced Dec 29, 2023
This was referenced Jan 5, 2024
【报名】: 2、3、43-45 |
This was referenced Jan 16, 2024
This was referenced Jan 19, 2024
【Docathon】补充缺失的中文 API 文档 已基本完成,感谢参与的小伙伴们!
备注: incubate的可能未来会有变动,量化相关的研发自行补充,paddle.callbacks.WandbCallback 是印度开发者提交的,暂时没找到 reviewer 。可以在后续活动完成。 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
背景
飞桨官网的 API 文档,有中文和英文两个版本,都存储于 GitHub 中,并通过技术手段转为 HTML 文件后呈现在官网。
中文 API 文档
存储于 docs 仓库下,具体路径为 PaddlePaddle/docs/docs/api/paddle。英文 API 文档
存储于 Paddle 仓库下的对应的 API 源码中,具体路径为 PaddlePaddle/Paddle/python/paddle。以
paddle.add
为例,在 develop 分支下原则上官网 API 文档必须提供中文和英文两个版本,但目前许多 API 文档只提供了英文版本,而缺失了中文版本,导致这些API不容易被开发者发现和有效利用。为了解决这个问题,我们号召大家一起努力来补充这些 API 的中文文档。
任务结束后,完成该任务的开发者将会在官网中进行展示哦🎉
任务描述:
我们提供了部分缺失中文文档的 API 清单,如下所示。请根据提供的 API 的英文文档,来补充相应的中文文档。补充完后请 request 对应的 API 负责人(Paddle 内部研发) review.
@Kaedeharai
@Kaedeharai
@Kaedeharai
paddle.profiler.SummaryViewpaddle.nn.quant.Stubpaddle.quantization.BaseObserverpaddle.quantization.BaseQuanterpaddle.quantization.QuantConfigpaddle.quantization.quanterpaddle.quantization.PTQ@jiangziyan-693 #6421 #6481 #6482
paddle.quantization.QAT@jiangziyan-693 #6410 #6482
paddle.jit.enable_to_staticpaddle.device.xpu.synchronizepaddle.incubate.asp.decoratepaddle.incubate.asp.prune_model任务认领
Note
1. Issue 回复格式:
为了自动填写报名信息,需要在 issue 下回复报名信息,如果报名格式不正确,则会在 comment 区提示报名不正确,格式如下:
Note
2. PR 标题格式:
PR的标题中以
[Docathon][Add CN Doc No.xxxx]
开头即可,程序会自动提取赛题编号并更新榜单。一个 PR 也可以提交多个赛题,多个赛题间以
顿号
或横线
分隔,比如 No.24、26-28、30 赛题。Note
3. PR 内容:
描述新增了什么文档、附上该 issue 链接、 附上英文文档链接、并 @sunzhongkai588 和表中的 API 负责人review
参考资料:
文档贡献指南
API 文档书写规范
Python 文档示例代码书写规范
看板信息
统计信息
The text was updated successfully, but these errors were encountered: