Skip to content

Commit 168cd0c

Browse files
committed
Merge branch 'develop' into ci/split-ci-workflow
2 parents 484802e + 8f0f08b commit 168cd0c

File tree

2,651 files changed

+8186
-20934
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

2,651 files changed

+8186
-20934
lines changed

.editorconfig

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# EditorConfig is a cross-editor configuration file
2+
# that helps to unify code styles for multiple
3+
# developers collaborative projects.
4+
# See more at https://editorconfig.org/
5+
6+
root = true
7+
8+
[*]
9+
indent_style = space
10+
end_of_line = lf
11+
charset = utf-8
12+
trim_trailing_whitespace = true
13+
insert_final_newline = true
14+
15+
[*.{yml,yaml}]
16+
indent_size = 2
17+
18+
[*.{py,pyi,toml}]
19+
indent_size = 4

.github/ISSUE_TEMPLATE/1_documentation-issue.yml

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,36 +3,36 @@ description: 反馈一个官网文档错误。 Report an issue related to https:
33
labels: []
44

55
body:
6-
- type: markdown
7-
attributes:
8-
value: >
9-
#### 请确认反馈的问题来自PaddlePaddle官网文档:https://www.paddlepaddle.org.cn/ 。
6+
- type: markdown
7+
attributes:
8+
value: >
9+
#### 请确认反馈的问题来自PaddlePaddle官网文档:https://www.paddlepaddle.org.cn/ 。
1010
11-
#### Before submitting a Documentation Issue, Please make sure that issue is related to https://www.paddlepaddle.org.cn/.
11+
#### Before submitting a Documentation Issue, Please make sure that issue is related to https://www.paddlepaddle.org.cn/.
1212
13-
- type: textarea
14-
id: link
15-
attributes:
16-
label: 文档链接&描述 Document Links & Description
17-
description: |
18-
请说明有问题的文档链接以及该文档存在的问题。
19-
Please fill in the link to the document and describe the question.
20-
validations:
21-
required: true
13+
- type: textarea
14+
id: link
15+
attributes:
16+
label: 文档链接&描述 Document Links & Description
17+
description: |
18+
请说明有问题的文档链接以及该文档存在的问题。
19+
Please fill in the link to the document and describe the question.
20+
validations:
21+
required: true
2222

2323

24-
- type: textarea
25-
id: error
26-
attributes:
27-
label: 请提出你的建议/提个PR修复这个问题 Please give your suggestion/update a PR to fix it
28-
description: |
29-
请告诉我们,你希望如何改进这个文档。
30-
Please tell us how you would like to improve this document.
24+
- type: textarea
25+
id: error
26+
attributes:
27+
label: 请提出你的建议/提个PR修复这个问题 Please give your suggestion/update a PR to fix it
28+
description: |
29+
请告诉我们,你希望如何改进这个文档。
30+
Please tell us how you would like to improve this document.
3131
32-
validations:
33-
required: false
32+
validations:
33+
required: false
3434

35-
- type: markdown
36-
attributes:
37-
value: >
38-
感谢你的贡献 🎉!Thanks for your contribution 🎉!
35+
- type: markdown
36+
attributes:
37+
value: >
38+
感谢你的贡献 🎉!Thanks for your contribution 🎉!

.github/ISSUE_TEMPLATE/2_eval-issue.yml

Lines changed: 72 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -3,84 +3,84 @@ description: 文档评估工作小组。 Document evaluation working group.
33
labels: [eval]
44

55
body:
6-
- type: markdown
7-
attributes:
8-
value: >
9-
#### 此模板用于文档评估工作小组成员向飞桨团队反馈文档问题,如非工作小组成员,请使用「📚 文档」模板,感谢配合~
6+
- type: markdown
7+
attributes:
8+
value: >
9+
#### 此模板用于文档评估工作小组成员向飞桨团队反馈文档问题,如非工作小组成员,请使用「📚 文档」模板,感谢配合~
1010
11-
#### This template is used by members of the document evaluation working group to report documentation issues to the Paddle Team. If you are not a member of the working group, please use the "📚 Documentation Issue" template, thank you for your cooperation~
11+
#### This template is used by members of the document evaluation working group to report documentation issues to the Paddle Team. If you are not a member of the working group, please use the "📚 Documentation Issue" template, thank you for your cooperation~
1212
13-
- type: textarea
14-
id: link
15-
attributes:
16-
label: 文档中英文链接
17-
description: |
18-
请输入你评估的文档链接(需含中英文两个链接)。请注意评估文档要是develop版本。
19-
validations:
20-
required: true
13+
- type: textarea
14+
id: link
15+
attributes:
16+
label: 文档中英文链接
17+
description: |
18+
请输入你评估的文档链接(需含中英文两个链接)。请注意评估文档要是develop版本。
19+
validations:
20+
required: true
2121

22-
- type: textarea
23-
id: eval1
24-
attributes:
25-
label: 红线问题
26-
description: |
27-
请按照如下维度评估本篇文档,如有红线问题,请在以下文本框中说明。
28-
- API文档对该API的描述,是否与API的行为保持一致?
29-
- API文档提供的示例代码能否跑通?
30-
- 中英文API文档的内容是否严格一致?
31-
validations:
32-
required: false
22+
- type: textarea
23+
id: eval1
24+
attributes:
25+
label: 红线问题
26+
description: |
27+
请按照如下维度评估本篇文档,如有红线问题,请在以下文本框中说明。
28+
- API文档对该API的描述,是否与API的行为保持一致?
29+
- API文档提供的示例代码能否跑通?
30+
- 中英文API文档的内容是否严格一致?
31+
validations:
32+
required: false
3333

34-
- type: textarea
35-
id: eval2
36-
attributes:
37-
label: 结构问题
38-
description: |
39-
请评估本篇文档,是否按API文档推荐的结构书写,并且没有遗漏(无需写的部分可以省略)?
40-
如有结构问题,请在以下文本框中说明。
34+
- type: textarea
35+
id: eval2
36+
attributes:
37+
label: 结构问题
38+
description: |
39+
请评估本篇文档,是否按API文档推荐的结构书写,并且没有遗漏(无需写的部分可以省略)?
40+
如有结构问题,请在以下文本框中说明。
4141
42-
API文档推荐的书写结构:API名称、API功能描述、API参数、API返回、API代码示例、API属性(class)、API方法(methods)
43-
validations:
44-
required: false
42+
API文档推荐的书写结构:API名称、API功能描述、API参数、API返回、API代码示例、API属性(class)、API方法(methods)
43+
validations:
44+
required: false
4545

46-
- type: textarea
47-
id: eval3
48-
attributes:
49-
label: 内容问题
50-
description: |
51-
请按照如下维度评估本篇文档,如有内容问题,请在以下文本框中说明。
52-
- 全文语句通畅、准确、易理解。
53-
- API描述部分是否描述清楚,在什么场景下使用该API?
54-
- API参数,是否描述清楚不同参数下,API的行为区别?
55-
- 示例代码是否以注释给出了运行结果?
56-
- 没有死链、错字、错误标点等低级错误。
57-
validations:
58-
required: false
46+
- type: textarea
47+
id: eval3
48+
attributes:
49+
label: 内容问题
50+
description: |
51+
请按照如下维度评估本篇文档,如有内容问题,请在以下文本框中说明。
52+
- 全文语句通畅、准确、易理解。
53+
- API描述部分是否描述清楚,在什么场景下使用该API?
54+
- API参数,是否描述清楚不同参数下,API的行为区别?
55+
- 示例代码是否以注释给出了运行结果?
56+
- 没有死链、错字、错误标点等低级错误。
57+
validations:
58+
required: false
5959

60-
- type: textarea
61-
id: eval4
62-
attributes:
63-
label: 格式问题
64-
description: |
65-
请按照如下维度评估本篇文档,如有格式问题,请在以下文本框中说明。
66-
- 是否使用深度学习领域通用的词汇和说法?
67-
- API文档格式是否满足格式规范?
68-
- 示例代码是否仅使用Paddle API,没有使用numpy等创建输入?
69-
validations:
70-
required: false
60+
- type: textarea
61+
id: eval4
62+
attributes:
63+
label: 格式问题
64+
description: |
65+
请按照如下维度评估本篇文档,如有格式问题,请在以下文本框中说明。
66+
- 是否使用深度学习领域通用的词汇和说法?
67+
- API文档格式是否满足格式规范?
68+
- 示例代码是否仅使用Paddle API,没有使用numpy等创建输入?
69+
validations:
70+
required: false
7171

72-
- type: textarea
73-
id: eval_fix
74-
attributes:
75-
label: 主观评价
76-
description: |
77-
请在此给出你对本篇文档的主观评价,API文档是否足够好,能够有效的帮助自己了解并使用这个API?
78-
加分项:是否有图来协助说明,让本篇API文档更加易于理解?
79-
如你已经发现了文档的错误并且判断其容易被修复,欢迎你为[Paddle](https://github.com/PaddlePaddle/Paddle/pulls)与[docs](https://github.com/PaddlePaddle/docs/pulls)提PR,直接修复此文档,并将PR链接贴在以下文本框中~
80-
validations:
81-
required: true
72+
- type: textarea
73+
id: eval_fix
74+
attributes:
75+
label: 主观评价
76+
description: |
77+
请在此给出你对本篇文档的主观评价,API文档是否足够好,能够有效的帮助自己了解并使用这个API?
78+
加分项:是否有图来协助说明,让本篇API文档更加易于理解?
79+
如你已经发现了文档的错误并且判断其容易被修复,欢迎你为[Paddle](https://github.com/PaddlePaddle/Paddle/pulls)与[docs](https://github.com/PaddlePaddle/docs/pulls)提PR,直接修复此文档,并将PR链接贴在以下文本框中~
80+
validations:
81+
required: true
8282

83-
- type: markdown
84-
attributes:
85-
value: >
86-
感谢你的贡献 🎉!Thanks for your contribution 🎉!
83+
- type: markdown
84+
attributes:
85+
value: >
86+
感谢你的贡献 🎉!Thanks for your contribution 🎉!

0 commit comments

Comments
 (0)