【Docathon】补充缺失的中文 API 文档

[sunzhongkai588]

背景

飞桨官网的 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.

序号	英文 API	对应 API 负责人	认领人/状态/PR
1	paddle.sin_	@caizejun	@Turingg #6384 #6383
2	paddle.sinh_	@caizejun	@Turingg #6475 #6477
3	paddle.incubate.nn.functional.fused_linear	@sneaxiy	@Turingg #6479
4	paddle.incubate.nn.functional.fused_matmul_bias	@sneaxiy	@zade23 #6362
5	paddle.incubate.nn.FusedLinear	@sneaxiy	@zade23 #6362
6	paddle.acos_	@wuyefeilin	@zade23 #6361
7	paddle.atan_	@wuyefeilin	@zade23 #6361
8	paddle.cos_	@wuyefeilin	@zade23 #6361
9	paddle.erf_	@wuyefeilin	@zade23 #6361
10	paddle.get_rng_state	@QingshuChen	@zade23 #6363
11	paddle.set_rng_state	@QingshuChen	@zade23 #6363
12	paddle.nn.functional.thresholdedrelu	@csy0225	@zade23 #6365
13	paddle.geometric.weighted_sample_neighbors	@DesmonDay	@zade23 #6366
14	paddle.abs_	@haoyuying	@zade23 #6367
15	paddle.version.xpu	@houj04	@zade23 #6368
16	paddle.version.xpu_xccl	@houj04	@zade23 #6368
17	paddle.incubate.nn.functional.fused_multi_transformer	@Courtesy-Xs	@zade23 #6369
18	paddle.nn.functional.hardtanh_	@qili93	@zade23 #6370
19	paddle.static.nn.static_pylayer	@qili93	@zade23 #6370
20	paddle.nn.quant.llm_int8_linear	@zhenyun-li	@zade23 #6371
21	paddle.nn.quant.weight_only_linear	@zhenyun-li	@zade23 #6371
22	paddle.nn.quant.weight_quantize	@zhenyun-li	@zade23 #6371
23	paddle.static.ctr_metric_bundle	@danleifeng	@zade23 #6372
24	paddle.sparse.nn.functional.conv2d	@Xreki	@zade23 #6360
25	paddle.sparse.nn.Conv2D	@Xreki	@zade23 #6360
26	paddle.nn.functional.scaled_dot_product_attention	@liuzhenhai93	@Kaedeharai #6390 #6484
27	paddle.utils.try_import	@kangguangli	@Turingg #6385 #6387 @Kaedeharai
28	paddle.amp.debugging.check_layer_numerics	@zhangting2020	@Turingg #6382 @Kaedeharai
29	paddle.incubate.nn.functional.fused_linear_activation	@zhangting2020	@Turingg #6382 @Kaedeharai
30	paddle.incubate.nn.functional.fused_rotary_position_embedding	@zhangting2020	@Kaedeharai #6447
31	paddle.sparse.nn.functional.subm_conv2d	@zhangting2020	@Kaedeharai #6447
32	paddle.sparse.nn.SubmConv2D	@zhangting2020	@Kaedeharai #6430
33	paddle.incubate.nn.functional.fused_dropout_add	@ForFishes	@Kaedeharai #6431
34	paddle.incubate.nn.FusedDropoutAdd	@ForFishes	@Kaedeharai #6431
35	paddle.incubate.distributed.utils.io.dist_save.save	@SylarTiaNII	@Kaedeharai #6442
36	paddle.incubate.distributed.utils.io.dist_save.save_for_auto_inference	@SylarTiaNII	@Kaedeharai #6442
37	paddle.incubate.distributed.utils.io.save_for_auto.save_for_auto_inference	@SylarTiaNII	@Kaedeharai #6442
38	paddle.profiler.SummaryView	@tianhaodongbd	@Kaedeharai #6446
39	paddle.callbacks.WandbCallback		@Kaedeharai #6446
40	paddle.incubate.nn.functional.variable_length_memory_efficient_attention		@Kaedeharai #6446
41	paddle.expm1_	@ronny1996	@entired #6373
42	paddle.nn.quant.Stub	@wanghaoshuang	@entired #6452
43	paddle.quantization.BaseObserver	@wanghaoshuang	@Turingg #6485
44	paddle.quantization.BaseQuanter	@wanghaoshuang	@Turingg
45	paddle.quantization.QuantConfig	@wanghaoshuang	@Turingg
46	paddle.quantization.quanter	@wanghaoshuang	@entired #6453
47	paddle.quantization.PTQ	@wanghaoshuang	@entired @jiangziyan-693 #6421 #6481 #6482
48	paddle.quantization.QAT	@wanghaoshuang	@entired @jiangziyan-693 #6410 #6482
49	paddle.jit.enable_to_static	@0x45f	@entired #6374
50	paddle.incubate.distributed.fleet.recompute_hybrid	@wuhuachaocoding	@entired #6375
51	paddle.incubate.distributed.fleet.recompute_sequential	@wuhuachaocoding	@entired #6375
52	paddle.square_	@yangjianfengo1	@entired #6378
53	paddle.incubate.nn.FusedMultiTransformer	@iosmers	@entired #6451
54	paddle.device.xpu.synchronize	@XiaociZhang	@entired #6377
55	paddle.incubate.xpu.resnet_block.resnet_basic_block	@zhangyk0314	@entired #6376
56	paddle.incubate.nn.functional.fused_bias_dropout_residual_layer_norm	@Vvsmile	@zade23 #6358
57	paddle.incubate.nn.FusedBiasDropoutResidualLayerNorm	@Vvsmile	@zade23 #6358
58	paddle.incubate.nn.functional.masked_multihead_attention	@xiaoxiaohehe001	@zade23 #6356
59	paddle.nn.functional.leakyrelu	@xiaoxiaohehe001	@zade23 #6356
60	paddle.incubate.nn.functional.fused_layer_norm	@MARD1NO	@zade23 #6211
61	paddle.incubate.nn.functional.fused_rms_norm	@MARD1NO	@zade23 #6211
62	paddle.incubate.asp.decorate	@mingxu1067
63	paddle.incubate.asp.prune_model	@mingxu1067
64	paddle.incubate.asp.reset_excluded_layers	@mingxu1067	@ooooo-create #6224
65	paddle.incubate.asp.set_excluded_layers	@mingxu1067	@ooooo-create #6224
66	paddle.incubate.asp.add_supported_layer	@mingxu1067	@ooooo-create #6224
67	paddle.incubate.asp.calculate_density	@mingxu1067	@ooooo-create #6224

⚠️注意：补充文档时，还需要注意下是否需要在相应的 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

参考资料：

文档贡献指南

API 文档书写规范

Python 文档示例代码书写规范

看板信息

任务方向	任务数量	提交作品 / 任务认领	提交率	完成	完成率
Docathon	67	63 / 65	94.03%	47	70.15%

统计信息

排名不分先后 @Turingg (6) @zade23 (28) @Kaedeharai (6) @entired (3) @ooooo-create (4)

[ooooo-create]

【报名】: 64-67

[zade23]

【报名】: 4-25、56-61

[Turingg]

【报名】: 1，27-29

[Kaedeharai]

【报名】: 26-40

[jiangziyan-693]

【报名】: 47、48

[Turingg]

【报名】: 2、3、43-45

[luotao1]

【Docathon】补充缺失的中文 API 文档 已基本完成，感谢参与的小伙伴们！

排名不分先后 @Turingg (6) @zade23 (28) @Kaedeharai (6) @entired (3) @ooooo-create (4)

备注: incubate的可能未来会有变动，量化相关的研发自行补充，paddle.callbacks.WandbCallback 是印度开发者提交的，暂时没找到 reviewer 。可以在后续活动完成。