Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[Docathon] 英文文档格式修复(Fix 'System Message') #58237

Closed
sunzhongkai588 opened this issue Oct 19, 2023 · 9 comments
Closed

[Docathon] 英文文档格式修复(Fix 'System Message') #58237

sunzhongkai588 opened this issue Oct 19, 2023 · 9 comments
Assignees
Labels
HappyOpenSource 快乐开源活动issue与PR

Comments

@sunzhongkai588
Copy link
Contributor

sunzhongkai588 commented Oct 19, 2023

背景

由于检查英文文档的CI在一段时间内失效,导致部分不合规的 PR 合入,从而产生了一些文档显示的问题。其中,比较突出的问题是「由格式问题导致文档内容解析错误」,表现为文档内容中出现 「System Message: Warning / Error」。

Example:

batch_norm 为例,在参数描述中出现 [System Message:Warning], 如下图所示:
image

在源码中,对应描述为:

    param_attr(ParamAttr|None): The parameter attribute for Parameter `scale`
         of batch_norm. If it is set to None or one attribute of ParamAttr, batch_norm
     will create ParamAttr as param_attr, the name of scale can be set in ParamAttr.
     If the Initializer of the param_attr is not set, the parameter is initialized
     with Xavier. Default: None.

实际上,由于 RST 语法的要求,同一段落缩进必须相同,因此修改为

    param_attr(ParamAttr|None): The parameter attribute for Parameter `scale`
         of batch_norm. If it is set to None or one attribute of ParamAttr, batch_norm
         will create ParamAttr as param_attr, the name of scale can be set in ParamAttr.
         If the Initializer of the param_attr is not set, the parameter is initialized
         with Xavier. Default: None.

Important

  1. 一般出现 System Message:Warning/Error 的问题,往往是由于 同一段落缩进不一致不同段落间没用空行相隔code_block下没加空行 等,英文文档格式务必参考 英文模板
  2. 同时,想了解更多 RST 语法,可参考 reStructuredText Primer

任务描述

我们提供以下存在 System Message:Warning/Error 问题的文档,请在该 issue 回复序号进行认领,并在相应的源码中进行修改

序号 英文文档链接 认领人/状态/PR
1 static/nn/batch_norm_en @BernieHuang2008 #58503
2 distributed/fleet/DistributedStrategy_en @ooooo-create #59295
3 Model_en @BernieHuang2008 #58664
4 Tensor/to_dense_en @Tomoko-hjf #58626
5 Tensor/to_sparse_coo_en @Tomoko-hjf #58626
6 Tensor/values_en @Tomoko-hjf #58626
7 device/Event_en @Tomoko-hjf #58626
@Sekiro-x #58508
8 distributed/fleet/Fleet_en @Tomoko-hjf #58626
9 get_rng_state_en @BernieHuang2008 #58664
10 distributed/fleet/MultiSlotStringDataGenerator_en @BernieHuang2008 #58664
11 device/current_stream_en @Sekiro-x #58508
@BernieHuang2008 #58664
12 Tensor_en @liyongchao911 #59361
@ooooo-create #59445
13 static/Variable_en @liyongchao911 #58864
@ooooo-create #59725
14 nn/TripletMarginWithDistanceLoss_en @BernieHuang2008 #58664
@liyongchao911
15 amp/debugging/enable_operator_stats_collection_en @BernieHuang2008 #58664
16 nn/utils/clip_grad_value__en @Liyulingyue #58741
17 incubate/optimizer/LBFGS_en @Liyulingyue #58742
18 linalg/eigh_en @SigureMo #58206
19 incubate/distributed/utils/io/dist_save/save_for_auto_inference_en @Liyulingyue #58743
20 incubate/distributed/utils/io/dist_save/save_en @Liyulingyue #58744
21 jit/to_static_en @SigureMo #58257
22 distributed/fleet/MultiSlotDataGenerator_en @wenxiaohahaha #58784
23 hub/help_en @Sekiro-x #58733
24 Tensor/fill_diagonal__en @Sekiro-x
25 device/synchronize_en @Sekiro-x #58508
@BernieHuang2008 #58664
26 static/nn/instance_norm_en @BernieHuang2008 #58503
27 metric/Metric_en @Sekiro-x #58733
28 device/Stream_en @Sekiro-x #58508

Note

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

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

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

Note

2. PR 标题格式

[Docathon][Fix System Message No.2、3、6-10]

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

看板信息

任务方向 任务数量 提交作品 / 任务认领 提交率 完成 完成率
Docathon 28 24 / 24 85.71% 24 85.71%

统计信息

排名不分先后 @BernieHuang2008 (6) @ooooo-create (3) @Tomoko-hjf (4) @Sekiro-x (6) @Liyulingyue (4) @wenxiaohahaha (1)

@ooooo-create
Copy link
Contributor

【报名】: 2

@BernieHuang2008
Copy link
Contributor

BernieHuang2008 commented Oct 30, 2023

【报名】: 1、26

@Sekiro-x
Copy link
Contributor

Sekiro-x commented Oct 30, 2023

【报名】: 7、11、25、28

@huajiao-hjyp
Copy link
Contributor

【报名】:4-8

@BernieHuang2008
Copy link
Contributor

BernieHuang2008 commented Nov 3, 2023

【报名】: 3、9-11、14-15、25

@wenxiaohahaha
Copy link
Contributor

【报名】: 22

@liyongchao911
Copy link
Contributor

【报名】: 12-14

@luotao1 luotao1 added the HappyOpenSource 快乐开源活动issue与PR label Nov 6, 2023
@Sekiro-x
Copy link
Contributor

Sekiro-x commented Nov 6, 2023

【报名】: 23、24、27

@luotao1
Copy link
Contributor

luotao1 commented Dec 12, 2023

[Docathon] 英文文档格式修复(Fix 'System Message') 已全部完成,感谢参与的小伙伴们!

排名不分先后 @BernieHuang2008 (6) @ooooo-create (3) @Tomoko-hjf (4) @Sekiro-x (6) @Liyulingyue (4) @wenxiaohahaha (1)

@luotao1 luotao1 closed this as completed Dec 12, 2023
@github-project-automation github-project-automation bot moved this from In Progress to Done in Call for Contributions Dec 12, 2023
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
HappyOpenSource 快乐开源活动issue与PR
Projects
Development

No branches or pull requests

9 participants