Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

[Docathon] 修复英文 API label #57363

Closed
sunzhongkai588 opened this issue Sep 15, 2023 · 12 comments
Closed

[Docathon] 修复英文 API label #57363

sunzhongkai588 opened this issue Sep 15, 2023 · 12 comments
Assignees
Labels
HappyOpenSource 快乐开源活动issue与PR status/close 已关闭

Comments

@sunzhongkai588
Copy link
Contributor

sunzhongkai588 commented Sep 15, 2023

Motivation

#56682

背景

每个文档都有对应的 api label,以便于相互引用,如

See more details in :ref:`api_nn_pooling_AvgPool1d` .

具体的文档引用说明可参考:https://github.com/PaddlePaddle/docs/wiki/飞桨文档相互引用

我们目前针对 api label 进行了规范,现在英文的 api label 的生成规则是 '_api_' + self.api_name.replace('.', '_'),比如 paddle.jit.to_static 对应 api_paddle_jit_to_static(前面的下划线只是 label 的语法前缀而已,因此不包含最前面的下划线)

英文 api label 一般出现在英文文档的引用中。目前的文档内容里仍留有不符合规范的英文 api label ,若不修复则会导致引用失效的问题。

任务描述

我们提供了需要修改的 label name ,和其出现的次数,如下所示。请在 Paddle 代码中全局搜索相应的 label name , 并按照上述的规范进行修改。

序号 label name 出现次数 认领人 PR 链接
1 api_ParamAttr 2 @enkilee #58848
2 api_base_CPUPlace 1 @liyongchao911 #58861
3 api_base_CUDAPlace 1 @liyongchao911 #58861
4 api_base_DataFeedDesc 1 @enkilee #58848
5 api_base_LoDTensor_en 1 @enkilee #58848
6 api_base_ParamAttr 19 @Sekiro-x #57512
7 api_base_Program 6 @zade23 #57563
8 api_base_Tensor 1 @zade23 #57614
9 api_base_clip_GradientClipByGlobalNorm 13 @zade23 #57614
10 api_base_clip_GradientClipByNorm 13 @zade23 #57614
11 api_base_clip_GradientClipByValue 13 @zade23 #57614
12 api_base_create_lod_tensor 1 @enkilee #58816
13 api_base_default_main_program 1 @zade23 #57658
14 api_base_default_startup_program 5 @zade23 #57658
15 api_base_dygraph_disable_dygraph 1 @zade23 #57658
16 api_base_dygraph_enable_dygraph 1 @zade23 #57658
17 api_base_dygraph_guard 1 @zade23 #57658
18 api_base_dygraph_to_variable 1 @zade23 #57658
19 api_base_io_firstn 1 @Kaedeharai #58827
20 api_base_io_load_params 1 @Kaedeharai #58827
21 api_base_io_shuffle 1 @entired #58891
22 api_base_layers_DynamicRNN 1 @zade23 #57657
23 api_base_layers_conv2d 1 @zade23 #57657
24 api_base_layers_create_global_var 1 @zade23 #57657
25 api_base_layers_create_tensor 1 @zade23 #57657
26 api_base_layers_while_loop 2 @zade23 #57657
27 api_base_layers_{1} 1 @enkilee #58816
28 api_base_regularizer_L1Decay 10 @zade23 #57623
29 api_base_regularizer_L2Decay 10 @zade23 #57623
30 api_base_transpiler_HashName 1 @zade23 #57630
31 api_base_transpiler_RoundRobin 1 @zade23 #57630
32 api_fluid_ParamAttr 3 @zade23 #57630
33 api_initializer_NumpyArrayInitializer 2 @zade23 #57630
34 api_logical_xor 1 @zade23 #57630
35 api_nn_Bilinear 1 @zade23 #57630
36 api_nn_cn_elu 1 @zade23 #57630
37 api_nn_cn_relu 1 @zade23 #57630
38 api_nn_cn_softmax 1 @zade23 #57630
39 api_nn_conv_ConvTranspose2d 1 @zade23 #57630
40 api_nn_conv_ConvTranspose3d 1 @zade23 #57630
41 api_nn_loss_BCELoss 1 @liyongchao911 #58329
42 api_nn_pooling_AdaptiveAvgPool1d 1 @liyongchao911 #58329
43 api_nn_pooling_AdaptiveMaxPool1d 1 @liyongchao911 #58329
44 api_nn_pooling_AdaptiveMaxPool2d 1 @liyongchao911 #58329
45 api_nn_pooling_AdaptiveMaxPool3d 1 @liyongchao911 #58329
46 api_nn_pooling_AvgPool1d 1 @liyongchao911 #58329
47 api_nn_pooling_AvgPool2d 1 @liyongchao911 #58329
48 api_nn_pooling_AvgPool3d 1 @liyongchao911 #58329
49 api_nn_pooling_MaxPool1d 1 @liyongchao911 #58329
50 api_nn_pooling_MaxPool2d 1 @liyongchao911 #58329
51 api_nn_pooling_MaxPool3d 1 @Sekiro-x #57666
52 api_nn_pooling_MaxUnPool2D 1 @Sekiro-x #57666
53 api_nn_vision_ChannelShuffle 1 @Sekiro-x #57666
54 api_sparse_pooling_MaxPool3d 1 @Sekiro-x #57666
55 api_static_nn_concat 1 @Sekiro-x #57666
56 api_static_nn_pool2d 1 @Sekiro-x #57666
57 api_static_nn_reshape 1 @Sekiro-x #57666
58 api_static_nn_reverse 1 @Sekiro-x #57666
59 api_static_nn_sequence_pad 1 @Sekiro-x #57666
60 api_static_nn_softmax 1 @Sekiro-x #57666
61 api_static_static_sequence_unpad 1 @Sekiro-x #57666
62 api_tensor_flatten 1 @Sekiro-x #57666
63 api_tensor_put_along_axis 1 @Sekiro-x #57666
64 api_tensor_uniform 1 @Sekiro-x #57666

任务流程

  1. 请直接在 issue 区回复任务序号进行认领
  2. 提交 PR 时,请注意 PR 描述的规范。
    a. PR 标题: [Docathon] Fix xxx API Label
    b. PR 内容: 描述修改的文件、附上该 issue 链接、 并 @ooooo-create @sunzhongkai588
  3. PR 合入后即完成任务啦~
@whisky-12
Copy link
Contributor

认领 NO.1~NO.5

@Sekiro-x
Copy link
Contributor

认领 NO.6

@zade23
Copy link
Contributor

zade23 commented Sep 20, 2023

认领 NO.7 #57559 #57563

@Sekiro-x
Copy link
Contributor

认领 NO.51-NO.64

@zade23
Copy link
Contributor

zade23 commented Sep 21, 2023

认领 NO.8-NO.11 #57614

@zade23
Copy link
Contributor

zade23 commented Sep 22, 2023

认领 NO.28-NO.29 #57623

@zade23
Copy link
Contributor

zade23 commented Sep 22, 2023

认领 NO.30-NO.40 #57630

@zade23
Copy link
Contributor

zade23 commented Sep 22, 2023

认领 NO.13-NO.18 #57658

认领 NO.22-NO.26 #57657

@entired
Copy link
Contributor

entired commented Nov 3, 2023

认领 NO.21

@Kaedeharai
Copy link
Contributor

认领 NO.19,20

@liyongchao911
Copy link
Contributor

认领No.2,No.3

@luotao1
Copy link
Contributor

luotao1 commented Nov 13, 2023

[Docathon] 修复英文 API label 已全部完成,感谢参与的小伙伴们!

@enkilee @liyongchao911 @Sekiro-x @zade23 @Kaedeharai @entired

欢迎继续参与快乐开源的其他任务

@luotao1 luotao1 closed this as completed Nov 13, 2023
@github-project-automation github-project-automation bot moved this from In Progress to Done in Call for Contributions Nov 13, 2023
@paddle-bot paddle-bot bot added the status/close 已关闭 label Nov 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
HappyOpenSource 快乐开源活动issue与PR status/close 已关闭
Projects
Development

No branches or pull requests

9 participants