Skip to content

Commit 629a947

Browse files
t checkout -b test
Merge branch 'develop' of https://github.com/PaddlePaddle/docs into develop
2 parents 611acf1 + e249d28 commit 629a947

File tree

1,406 files changed

+62505
-7643
lines changed

Some content is hidden

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

1,406 files changed

+62505
-7643
lines changed

.github/ISSUE_TEMPLATE/4_eval_distributed_PS_docs-issue.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
name: 📝 分布式文档——Parameter Sever快速开始体验评估 Eval Issue
2-
description: 第三期分布式文档——Parameter Sever快速开始体验评估报告
1+
name: 📝 分布式文档——参数服务器(Parameter Sever)快速开始体验评估 Eval Issue
2+
description: 第六期分布式文档——参数服务器(Parameter Sever)快速开始体验评估报告
33
labels: [distributed_ps_eval]
44

55
body:
66
- type: markdown
77
attributes:
88
value: >
9-
#### 此模板用于第三期分布式文档(Parameter Sever快速开始)评估工作小组成员,向飞桨团队反馈文档问题。如非工作小组成员,请使用 「📚文档」模板,感谢配合~
9+
#### 此模板用于第六期分布式文档-参数服务器(Parameter Sever)快速开始评估工作小组成员,向飞桨团队反馈文档问题。如非工作小组成员,请使用 「📚文档」模板,感谢配合~
1010
1111
#### This template is used by members of the distributed 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
@@ -26,7 +26,7 @@ body:
2626
- type: markdown
2727
attributes:
2828
value: >
29-
# Parameter Sever任务一 体验评估报告
29+
# 参数服务器(Parameter Sever)任务一 体验评估报告
3030
3131
3232
- type: textarea
@@ -104,9 +104,9 @@ body:
104104
- type: textarea
105105
id: distributed_ps_eval5
106106
attributes:
107-
label: 5.定义同步训练 Strategy 及 Optimizer
107+
label: 5.定义参数更新策略及优化器
108108
description: |
109-
针对 定义同步训练 Strategy 及 Optimizer 这一环节,请回答以下内容
109+
针对 定义参数更新策略及优化器 这一环节,请回答以下内容
110110
value: |
111111
- 完成情况(成功/不成功) :
112112
- 遇到问题:
@@ -150,7 +150,7 @@ body:
150150
- type: markdown
151151
attributes:
152152
value: >
153-
# Parameter Sever任务二 体验评估报告
153+
# 参数服务器(Parameter Sever)任务二 体验评估报告
154154
155155
156156
- type: textarea
@@ -228,9 +228,9 @@ body:
228228
- type: textarea
229229
id: distributed_ps_eval15
230230
attributes:
231-
label: 5.定义同步训练 Strategy 及 Optimizer
231+
label: 5.定义参数更新策略及优化器
232232
description: |
233-
针对 定义同步训练 Strategy 及 Optimizer 这一环节,请回答以下内容
233+
针对 定义参数更新策略及优化器 这一环节,请回答以下内容
234234
value: |
235235
- 完成情况(成功/不成功) :
236236
- 遇到问题:

.pre-commit-config.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
repos:
2-
- repo: https://github.com/pre-commit/mirrors-yapf.git
3-
rev: v0.32.0
2+
- repo: https://github.com/psf/black.git
3+
rev: 22.8.0
44
hooks:
5-
- id: yapf
5+
- id: black
66
files: \.py$
77
- repo: https://github.com/pre-commit/pre-commit-hooks
88
rev: v4.1.0

.pre-commit-hooks/convert_markdown_into_html.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,8 @@ def convert_markdown_into_html(argv=None):
8080

8181
for filename in args.filenames:
8282
with open(
83-
re.sub(r"README", "index", re.sub(r"\.md$", ".html",
84-
filename)), "w") as output:
83+
re.sub(r"README", "index", re.sub(r"\.md$", ".html", filename)), "w"
84+
) as output:
8585
output.write(HEAD)
8686
with open(filename) as input:
8787
for line in input:

.travis.yml

Lines changed: 0 additions & 44 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ PaddlePaddle's API documentation contains an introduction to the API. We welcome
2626

2727
### Guides
2828

29-
This part of the content is stored in the [docs/docs/guides](https://github.com/PaddlePaddle/docs/tree/develop/docs/guides) directory, you can make your changes by submitting a PR. For more information, please refer to: [Document Contribution Guide](https://github.com/PaddlePaddle/docs/wiki/%E6%96%87%E6%A1%A3%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97) .
29+
This part of the content is stored in the [docs/docs/guides](https://github.com/PaddlePaddle/docs/tree/develop/docs/guides) directory, you can make your changes by submitting a PR. For more information, please refer to: [Document Contribution Guide](https://github.com/PaddlePaddle/docs/wiki/%E6%96%87%E6%A1%A3%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97).
3030

3131
### Practice
3232

@@ -38,4 +38,4 @@ PaddlePaddle provides API documentation in both Chinese and English. The English
3838

3939
## Submit PR
4040

41-
Any modification of PaddlePaddle documentation should be completed by submitting a PR. For more information, please refer to [Submit PR](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/08_contribution/local_dev_guide.html)
41+
Any modification of PaddlePaddle documentation should be completed by submitting a PR. For more information, please refer to [Submit PR](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/08_contribution/local_dev_guide.html).

CONTRIBUTING_cn.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ API 文档是飞桨框架的 API 文档,包含了飞桨框架 API 的说明介
3030

3131
### 应用实践
3232

33-
这部分内容分为源代码与官网文档两部分,源代码的部分以 notebook 的形式,存放在 [book/paddle2.0_docs](https://github.com/PaddlePaddle/book/tree/develop/paddle2.0_docs) 目录下,你可以提交你的 notebook 格式的源码于该目录中;在你的 notebook 文件被合入后,我们会将其转为 md 文件,存储在[docs/docs/tutorial](https://github.com/PaddlePaddle/docs/tree/develop/docs/tutorial)中,然后呈现到官网。具体信息请参考:[[Call for Contribution] Tutorials for PaddlePaddle 2.0](https://github.com/PaddlePaddle/book/issues/905).
33+
这部分内容分为源代码与官网文档两部分,源代码的部分以 notebook 的形式,存放在 [book/paddle2.0_docs](https://github.com/PaddlePaddle/book/tree/develop/paddle2.0_docs) 目录下,你可以提交你的 notebook 格式的源码于该目录中;在你的 notebook 文件被合入后,我们会将其转为 md 文件,存储在 [docs/docs/tutorial](https://github.com/PaddlePaddle/docs/tree/develop/docs/tutorial) 中,然后呈现到官网。具体信息请参考:[[Call for Contribution] Tutorials for PaddlePaddle 2.0](https://github.com/PaddlePaddle/book/issues/905)
3434

3535
### API 文档
3636

37-
飞桨框架同时提供中英文 API 文档。其中,英文 API 文档存于[Paddle](https://github.com/PaddlePaddle/Paddle/tree/develop/python/paddle)源代码中,绝大部分通过官网文档的源代码即可链接到,你可以在此位置对英文文档进行修改;而中文 API 文档存放在[docs/docs/api](https://github.com/PaddlePaddle/docs/tree/develop/docs/api)目录下。你可以针对文档中的任何错误与内容进行修复与完善,或者是新增你认为该文档中所需要的内容,我们非常感谢你对于 API 文档所付出的一切。具体修改方式请参考:[英文 API 文档贡献指南](https://github.com/PaddlePaddle/docs/wiki/%E8%8B%B1%E6%96%87API%E6%96%87%E6%A1%A3%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97)[中文 API 文档贡献指南](https://github.com/PaddlePaddle/docs/wiki/%E4%B8%AD%E6%96%87API%E6%96%87%E6%A1%A3%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97)
37+
飞桨框架同时提供中英文 API 文档。其中,英文 API 文档存于 [Paddle](https://github.com/PaddlePaddle/Paddle/tree/develop/python/paddle) 源代码中,绝大部分通过官网文档的源代码即可链接到,你可以在此位置对英文文档进行修改;而中文 API 文档存放在 [docs/docs/api](https://github.com/PaddlePaddle/docs/tree/develop/docs/api) 目录下。你可以针对文档中的任何错误与内容进行修复与完善,或者是新增你认为该文档中所需要的内容,我们非常感谢你对于 API 文档所付出的一切。具体修改方式请参考:[英文 API 文档贡献指南](https://github.com/PaddlePaddle/docs/wiki/%E8%8B%B1%E6%96%87API%E6%96%87%E6%A1%A3%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97)[中文 API 文档贡献指南](https://github.com/PaddlePaddle/docs/wiki/%E4%B8%AD%E6%96%87API%E6%96%87%E6%A1%A3%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97)
3838

3939
## 提交 PR
4040

41-
你对于飞桨文档的任何修改,都应该通过提交 PR 的方式来完成,具体的方法可以参考[提交 PR](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/08_contribution/local_dev_guide.html)
41+
你对于飞桨文档的任何修改,都应该通过提交 PR 的方式来完成,具体的方法可以参考[提交 PR](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/08_contribution/local_dev_guide.html)

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ Note: English version API docs are generaly docstrings in [PaddlePaddle/Paddle](
99

1010
## Codebase structure
1111

12-
- [docs](docs): PaddlePaddle 2.0 & above docs source file,
13-
- [docs/api](docs/api): PaddlePaddle API docs
14-
- [docs/guides](docs/guides): PaddlePaddle guides docs
15-
- [docs/tutorial](docs/tutorial): PaddlePaddle tutorial docs
16-
- [ci_scripts](ci_scripts): docs CI scripts
12+
- [docs](docs): PaddlePaddle 2.0 & above docs source file.
13+
- [docs/api](docs/api): PaddlePaddle API docs.
14+
- [docs/guides](docs/guides): PaddlePaddle guides docs.
15+
- [docs/tutorial](docs/tutorial): PaddlePaddle tutorial docs.
16+
- [ci_scripts](ci_scripts): docs CI scripts.
1717

1818
## How to build
1919

README_cn.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ docs 是 [PaddlePaddle 官网文档](https://www.paddlepaddle.org.cn/documentati
3030
bash docs-build.sh -f absolute_path_docs
3131
```
3232
- step3: preview docs
33-
输出的文件会保存在 docs/output 路径下.
33+
输出的文件会保存在 docs/output 路径下
3434
3535
## 贡献
3636

ci_scripts/Dockerfile

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ pytest' >requirements && \
2828
RUN echo 'Pillow\n\
2929
numpy\n\
3030
gast==0.3.3\n\
31-
six\n\
3231
protobuf\n\
3332
urllib3\n\
3433
certifi\n\

ci_scripts/check_api_cn.sh

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
#!/bin/bash
22
set -x
33

4+
OUTPUTDIR=${OUTPUTDIR:=/docs}
5+
VERSIONSTR=${VERSIONSTR:=develop}
6+
47
SCRIPT_DIR="$( cd "$( dirname "$0" )" && pwd )"
58
source ${SCRIPT_DIR}/utils.sh
69

@@ -30,6 +33,13 @@ function filter_cn_api_files() {
3033

3134
need_check_cn_doc_files="$1"
3235
echo $need_check_cn_doc_files
36+
# Check COPY-FROM is parsed into Sample Code
37+
echo "Run COPY-FROM parsed into Sample Code Check"
38+
python check_copy_from_parsed_into_sample_code.py "${OUTPUTDIR}/zh/${VERSIONSTR}/" $need_check_cn_doc_files
39+
if [ $? -ne 0 ];then
40+
echo "ERROR: Exist COPY-FROM has not been parsed into sample code, please check COPY-FROM in the above files"
41+
exit 1
42+
fi
3343
need_check_files=$(filter_cn_api_files "${need_check_cn_doc_files}")
3444
echo "$need_check_files"
3545
if [ "$need_check_files" = "" ]

0 commit comments

Comments
 (0)