Skip to content

【Docathon】补充缺失的中文 API 文档(Inplace 类) #7090

Closed
@sunzhongkai588

Description

@sunzhongkai588

Note

上一期参考: #6193

背景

飞桨官网的 API 文档,有中文和英文两个版本,都存储于 GitHub 中,并通过技术手段转为 HTML 文件后呈现在官网。

paddle.add 为例,在 develop 分支下

原则上官网 API 文档必须提供中文和英文两个版本,但目前许多 API 文档只提供了英文版本,而缺失了中文版本,导致这些API不容易被开发者发现和有效利用。为了解决这个问题,我们号召大家一起努力来补充这些 API 的中文文档。

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

任务描述:

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

Inplace 含义见 Tensor 介绍 3.1.3 节

序号 英文 API 认领人/状态/PR
1 paddle.addmm_ @Echo-Nie #7097
2 paddle.baddbmm_ @APPARENT1 #7111 #7149
3 paddle.bitwise_and_ @jiangtao-zha #7103
@Keywennn #7233
@Dipan112233
4 paddle.bitwise_invert_ @jiangtao-zha #7103
@Keywennn #7233
5 paddle.bitwise_not_ @Rorschach730 #7137
@hanlintang #7294
6 paddle.bitwise_or_ @Rorschach730 #7137
@hanlintang #7294
7 paddle.bitwise_xor_ @DomineeringFireLong
@crashbussy #7143
8 paddle.cast_ @jianglongchen
@594233 #7152
@Echo-Nie #7268
9 paddle.cauchy_ @DomineeringFireLong
@QuarryFlow
@superdonkey007 #7230
@Keywennn #7232
@VVX94 #7234
@Dipan112233
@zrz0359 #7237
10 paddle.cumprod_ @ZJhorseloudly #7114
11 paddle.cumsum_ @ZJhorseloudly #7114
12 paddle.digamma_ @DomineeringFireLong
@rigidwill666 #7189 #7277
@QuarryFlow
@hanlintang #7294
13 paddle.divide_ @Echo-Nie #7108
14 paddle.equal_ @Echo-Nie #7108
15 paddle.floor_divide_ @Echo-Nie #7108
16 paddle.frac_ @Echo-Nie #7108
17 paddle.gcd_ @Echo-Nie #7108
18 paddle.geometric_ @Lorenz5622 #7126
19 paddle.greater_equal_ @mayiru1021 #7131
20 paddle.greater_than_ @mayiru1021 #7131
21 paddle.i0_ @mayiru1021 #7131
22 paddle.lcm_ @mayiru1021 #7131
23 paddle.ldexp_ @APPARENT1 #7111 #7149
24 paddle.less_ @APPARENT1 #7111 #7149
25 paddle.less_equal_ @APPARENT1 #7111 #7149
26 paddle.less_than_ @APPARENT1 #7111 #7149
27 paddle.lgamma_ @APPARENT1 #7111 #7149
28 paddle.log_ @Ericsciencer #7146
@Redamancy8013 #7209
@594233 #7152
@quite125
@Echo-Nie #7263
29 paddle.log10_ @Ericsciencer
@Redamancy8013 #7209
@594233 #7152
@Echo-Nie #7263
30 paddle.log2_ @Ericsciencer
@Redamancy8013 #7209
@594233 #7152
@Echo-Nie #7263
31 paddle.logical_and_ @DomineeringFireLong
@Redamancy8013 #7209
@RicardoBYang
@QuarryFlow #7187
@Echo-Nie #7263
32 paddle.logical_not_ @sshenshuo #7128
@Echo-Nie #7271
33 paddle.logical_or_ @DomineeringFireLong
@RicardoBYang
@QuarryFlow #7188
@Echo-Nie #7264
34 paddle.logit_ @hanlintang #7139
35 paddle.multiply_ @hanlintang #7129
36 paddle.nan_to_num_ @GKLeong #7119
37 paddle.neg_ @BaolanChen
@LanCole #7113
38 paddle.normal_ @BaolanChen #7113
@LanCole #7113
39 paddle.polygamma_ @hanlintang #7139
40 paddle.pow_ @Nancyhhibj
@Ismoothly #7144
41 paddle.renorm_ @lygitgit #7133
@ZMS-PNG
42 paddle.t_ @lygitgit #7133
@ZMS-PNG
43 paddle.transpose_ @nuclearslippers #7120
44 paddle.tril_ @zhaop-l #7121 #7151
45 paddle.triu_ @zhaop-l #7121 #7151
46 paddle.trunc_ @zhaop-l #7121 #7151
47 paddle.where_ @zhaop-l #7121 #7151

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 文档示例代码书写规范

看板信息

任务方向 任务数量 提交作品 / 任务认领 提交率 完成 完成率
补充缺失的中文 API 文档(Inplace 类) 47 47 / 47 100.0% 47 100.0%

统计信息

排名不分先后 @Echo-Nie (13) @APPARENT1 (6) @Keywennn (2) @hanlintang (6) @crashbussy (1) @superdonkey007 (1) @ZJhorseloudly (2) @Lorenz5622 (1) @mayiru1021 (4) @GKLeong (1) @LanCole (2) @Ismoothly (1) @lygitgit (2) @nuclearslippers (1) @zhaop-l (4)

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions