Skip to content
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] 中文文档 copy-from 清理 #6300

Closed
ooooo-create opened this issue Nov 8, 2023 · 6 comments
Closed

[Docathon] 中文文档 copy-from 清理 #6300

ooooo-create opened this issue Nov 8, 2023 · 6 comments
Assignees
Labels
HappyOpenSource 快乐开源活动issue与PR PFCC Paddle Framework Contributor Club,https://github.com/PaddlePaddle/community/tree/master/pfcc

Comments

@ooooo-create
Copy link
Collaborator

ooooo-create commented Nov 8, 2023

背景

为了使中、英文 API 文档的示例代码保持一致,飞桨中文 API 文档使用 COPY-FROM 来直接引用英文的 API 示例代码。
但是,目前中文 API 文档中还存在一些 COPY-FROM 不成功的情况,表现形式为无法显示代码示例,例如 Conll05st
image

原因分析

一般无法正确显示代码示例,会分为 2 种情况:中文文档的 COPY-FROM 引用方式写法存在错误,或者是被引用的英文文档的示例代码写法存在错误。

1. COPY-FROM 后面的 API 名称或路径不正确。

Conll05st 为例,COPY-FROM 后面的路径为 paddle.text.datasets.Conll05st,但实际的 API 路径为 paddle.text.Conll05st(可以直接看官网左侧 API 的目录来确定路径)

Important

正确的引用方式可以参考:中文API文档复制英文API文档示例代码
需要注意的是其中 api_name 为该 API 的 公开路径,英文官网 api 文档中展示的就是所有公开的 API。

2. 被 COPY-FROM 的 API 没有规范的书写格式

典型场景为英文文档的示例代码缺少空行,如

image

  • .. code-block:: python 之后没有空行 (在不需要 name: code_id 标识符时)
    **代码示例**
    .. code-block:: python
    # 这个示例需要由 fleetrun 启动,用法为:
    # fleetrun --gpus=0,1 example.py
    # 脚本 example.py 中的代码是下面这个示例。

任务描述

序号 中文文档链接 认领人/状态/PR
1 Event_cn @entired #6308 #6326 #6381
2 Conll05st_cn @entired #6308 #6326 #6381
@Liyulingyue #6304
3 Stream_cn @entired #6308 #6326 #6381
4 Imikolov_cn @Sekiro-x #6309
5 Imdb_cn @Sekiro-x #6309
6 UCIHousing_cn @Kaedeharai #6311
7 InMemoryDataset_cn @Kaedeharai #6311
8 WMT16_cn @Kaedeharai #6311
9 Movielens_cn @Kaedeharai #6311
10 WMT14_cn @Kaedeharai #6311
11 Fleet_cn @Turingg #6310 #6349
12 Adadelta_cn @Turingg #6310 #6349
13 AdamW_cn @Turingg #6310 #6349
14 Adam_cn @Turingg #6310 #6349
15 Adamax_cn @Turingg #6310 #6349
16 Lamb_cn @entired #6327 #6379
17 Optimizer_cn @entired #6327 #6379
18 RMSProp_cn @entired #6327 #6379
19 DistributedStrategy_cn @entired #6327 #6379

任务认领

Note

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

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

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

Note

2. PR 标题格式

[Docathon][Fix COPY-FROM No.2、3、6-10]

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

Note

3. PR 内容
需要描述修改的文件、附上活动 issue 链接、 并 @ooooo-create @sunzhongkai588

看板信息

任务方向 任务数量 提交作品 / 任务认领 提交率 完成 完成率
Docathon 19 19 / 19 100.0% 19 100.0%

统计信息

排名不分先后 @entired (7) @Sekiro-x (2) @Kaedeharai (5) @Turingg (5)

@paddle-bot paddle-bot bot added the PFCC Paddle Framework Contributor Club,https://github.com/PaddlePaddle/community/tree/master/pfcc label Nov 8, 2023
@luotao1 luotao1 moved this to In Progress in Call for Contributions Nov 10, 2023
@entired
Copy link
Contributor

entired commented Nov 10, 2023

【报名】: 1、2、3

@Kaedeharai
Copy link
Contributor

【报名】: 6-10

@Turingg
Copy link
Contributor

Turingg commented Nov 11, 2023

【报名】: 11-15

@Sekiro-x
Copy link
Contributor

【报名】: 4、5

@entired
Copy link
Contributor

entired commented Nov 12, 2023

【报名】: 16-19

@luotao1
Copy link
Collaborator

luotao1 commented Dec 13, 2023

[Docathon] 中文文档 copy-from 清理 已全部完成,感谢参与的小伙伴们!

排名不分先后 @entired (7) @Sekiro-x (2) @Kaedeharai (5) @Turingg (5)

@luotao1 luotao1 closed this as completed Dec 13, 2023
@github-project-automation github-project-automation bot moved this from In Progress to Done in Call for Contributions Dec 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
HappyOpenSource 快乐开源活动issue与PR PFCC Paddle Framework Contributor Club,https://github.com/PaddlePaddle/community/tree/master/pfcc
Projects
Development

No branches or pull requests

7 participants