[Docathon] 中文文档格式日常修复

[sunzhongkai588]

以下为脚本自动筛查到的中文 API 文档格式问题清单。不同条目存在的问题类型并不相同，具体说明见下文各小节。

Important

在修复问题之前，先确认该问题是否存在。同时，如果发现认领的文档有其他类似的问题，尽量一并修复～

1. 中文文档出现 COPY-FROM

为确保中英文 API 的示例代码一致，飞桨中文文档使用 COPY-FROM 从英文文档中直接引用示例代码。

目前部分中文文档存在 COPY-FROM 引用失败，表现为示例代码不显示。问题成因与背景可参考历史任务说明 #6300。本节仅列出疑似存在该问题的文档，供认领修复。

序号	中文文档链接	认领人/状态/PR
1	index_add_	@WanRui37 #7455
2	index_fill_	@WanRui37 #7455
3	index_put_	@WanRui37 #7455
4	isfinite	@wanglezz #7458 #7463
5	tensor_split	@wanglezz @dai-junjie #7466
6	lu_solve	@wanglezz #7458 #7463
7	BuildStrategy	@wanglezz #7458 #7463
8	Program	@NJX-njx #7482
9	data_norm	@zhuyanhuazhuyanhua #7472
10	global_gather	@aztice #7480 #7481
11	global_scatter	@aztice #7481

2. 中文文档出现 ``

在中英文 API 文档中，内联代码/术语通常用一对反引号 `` xxx `` 包裹，并要求反引号前后各加一个空格，示例：

输出 Tensor，与 ``x`` 维度相同、数据类型相同。

但往往在文档撰写过程中，会漏掉加空格，以 bucketize_cn 为例

    - **right** (bool，可选) - 根据给定 ``x`` 在 ``sorted_sequence`` 查找对应的上边界或下边界。如果 ``sorted_sequence``的值为 nan 或 inf，则返回最内层维度的大小。默认值为 False，表示在 ``sorted_sequence`` 的查找给定 ``x`` 的下边界。

sorted_sequence 后面的反引号没有加空格，由于 Sphinx 对空格与缩进较为敏感，缺少空格会导致渲染与预期不符。

因此，需要修复以下出现 `` 的文档

序号	中文文档链接	认领人/状态/PR
12	bucketize_cn	@jackson-119
13	DataParallel_cn	@jackson-119
14	gather_cn	@jackson-119
15	increment_cn	@jackson-119
16	logical_and_cn	@jackson-119
17	logical_xor_cn	@Le-soleile
18	logical_or_cn	@Le-soleile
19	searchsorted_cn	@Le-soleile #7460
20	GradScaler_cn	@Le-soleile #7460
21	saved_tensors_hooks_cn	@algorithm1832 #7468 #7469 #7504
22	ParallelEnv_cn	@xxiu1
23	parallelize_cn	@xxiu1
24	Strategy_cn	@xxiu1
25	hfft_cn	@LiaoYFBH #7483 #7488
26	irfftn_cn	@LiaoYFBH #7483 #7488
27	irfft_cn	@LiaoYFBH #7483 #7488
28	ModelAverage_cn	@123wjr #7501
29	DistributedBatchSampler_cn	@123wjr #7501
30	RNNTLoss_cn	@123wjr #7501
31	export_cn	@shiyuasuka #7491 #7495
32	L1Decay_cn	@tumytime
33	IpuStrategy_cn	@Luxorion-12
34	distribute_fpn_proposals_cn	@Luxorion-12
35	embedding_cn	@Luxorion-12
36	sparse_embedding_cn	@L-CXQD #7503
37	while_loop_cn	@scyyh11
38	affine_grid_cn	@scyyh11
39	conv1d_transpose_cn	@shiyuasuka #7496
40	conv2d_transpose_cn	@shiyuasuka #7506
41	dropout_cn
42	prelu_cn	@Dayuxiaoshui
43	rnnt_loss_cn	@heiiilover
44	UtilBase_cn
45	LogMelSpectrogram_cn
46	compute_fbank_matrix_cn

3. 文档出现 :attr:`` 和 :math:``

中、英文 API 文档中常用 :attr:`` 和 :math:`` 标注属性、数学符号或公式，如

为 :attr:`x` 中的每个元素计算由 :attr:`y` 中相对应元素决定的赫维赛德阶跃函数，其计算公式为

但同样的，若 :attr:`` 和 :math:`` 前后未加空格，会导致渲染结果和预期不符。以下是疑似存在该问题的文档

（1） :attr:``

序号	中文文档链接	认领人/状态/PR
47	WMT16_cn	@tjujingzong #7461
48	UCIHousing_cn	@tjujingzong #7461
49	Imdb_cn	@tjujingzong #7461
50	WMT14_cn	@tjujingzong #7461
51	Imikolov_cn	@jackson-119 #7465
52	Movielens_cn	@jackson-119 #7465
53	clip_grad_norm__cn	@jackson-119 #7465

（2） :math:``

序号	中文文档链接	认领人/状态/PR
54	Exponential_cn	@algorithm1832 #7473
55	LayerNorm_cn	@youge325 #7476
56	MaxPool3D_cn	@youge325 #7476
57	BatchNorm_cn	@youge325 #7476
58	SubmConv2D_cn	@youge325 #7476
59	max_pool3d_cn	@youge325 #7476

任务认领

Note

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

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

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

Note

2. PR 标题格式：

[Docathon][Fix Doc Format No.2、3、6-10] fix/delete/add xxxx API

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

Note

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

看板信息

任务方向	任务数量	提交作品 / 任务认领	提交率	完成	完成率
中文文档出现 COPY-FROM	11	11 / 11	100.0%	6	54.55%
中文文档出现 ``	35	13 / 31	37.14%	8	22.86%
文档出现 :attr: 和 :math:	13	13 / 13	100.0%	13	100.0%

统计信息

排名不分先后 @WanRui37 (3) @wanglezz (2) @zhuyanhuazhuyanhua (1) @Le-soleile (2) @algorithm1832 (2) @LiaoYFBH (3) @shiyuasuka (2) @tjujingzong (4) @jackson-119 (3) @youge325 (5)

[WanRui37]

【报名】:1-3

[wanglezz]

【报名】: 4-7

[jackson-119]

【报名】: 12-16

[Le-soleile]

【报名】: 17-20

[tjujingzong]

【报名】: 47-50