【Docathon】补充缺失的中文 API 文档（Inplace 类）

[sunzhongkai588]

Note

上一期参考： #6193

背景

飞桨官网的 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 的中文文档。

任务结束后，完成该任务的开发者将会在官网中进行展示哦🎉

任务描述：

我们提供了 Inplace 类的中文文档的 API 清单，如下所示。请根据提供的 API 的英文文档，来补充相应的中文文档。

Inplace 含义见 Tensor 介绍 3.1.3 节

序号	英文 API	认领人/状态/PR
1	paddle.addmm_
2	paddle.baddbmm_
3	paddle.bitwise_and_
4	paddle.bitwise_invert_
5	paddle.bitwise_not_
6	paddle.bitwise_or_
7	paddle.bitwise_xor_
8	paddle.cast_
9	paddle.cauchy_
10	paddle.cumprod_
11	paddle.cumsum_
12	paddle.digamma_
13	paddle.divide_
14	paddle.equal_
15	paddle.floor_divide_
16	paddle.frac_
17	paddle.gcd_
18	paddle.geometric_
19	paddle.greater_equal_
20	paddle.greater_than_
21	paddle.i0_
22	paddle.lcm_
23	paddle.ldexp_
24	paddle.less_
25	paddle.less_equal_
26	paddle.less_than_
27	paddle.lgamma_
28	paddle.log_
29	paddle.log10_
30	paddle.log2_
31	paddle.logical_and_
32	paddle.logical_not_
33	paddle.logical_or_
34	paddle.logit_
35	paddle.multiply_
36	paddle.nan_to_num_
37	paddle.neg_
38	paddle.normal_
39	paddle.polygamma_
40	paddle.pow_
41	paddle.renorm_
42	paddle.t_
43	paddle.transpose_
44	paddle.tril_
45	paddle.triu_
46	paddle.trunc_
47	paddle.where_

Warning

注意：补充文档时，还需要注意下是否需要在相应的 overview.rst 等综述页面增加相关 API 描述，如 paddle/Overview_cn.rst

任务认领

Note

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

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

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

Note

2. PR 标题格式：

[Docathon][Add Inplace CN Doc No.2、3、6-10]

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

Note

3. PR 内容：
描述新增了什么文档、附上该 issue 链接、 附上英文文档链接、并 @sunzhongkai588 review

参考资料：

文档贡献指南

API 文档书写规范

Python 文档示例代码书写规范