Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
PaddlePaddle
PaddleClas
提交
fcc2fac0
P
PaddleClas
项目概览
PaddlePaddle
/
PaddleClas
大约 1 年 前同步成功
通知
115
Star
4999
Fork
1114
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
19
列表
看板
标记
里程碑
合并请求
6
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
P
PaddleClas
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
19
Issue
19
列表
看板
标记
里程碑
合并请求
6
合并请求
6
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
fcc2fac0
编写于
1月 18, 2022
作者:
C
cuicheng01
提交者:
GitHub
1月 18, 2022
浏览文件
操作
浏览文件
下载
差异文件
Merge pull request #1619 from Sibo2rr/dev/doc2
change subtitle order
上级
8dac4204
359b9b5e
变更
10
隐藏空白更改
内联
并排
Showing
10 changed file
with
31 addition
and
251 deletion
+31
-251
docs/zh_CN/advanced_tutorials/index.rst
docs/zh_CN/advanced_tutorials/index.rst
+5
-3
docs/zh_CN/faq_series/index.rst
docs/zh_CN/faq_series/index.rst
+1
-1
docs/zh_CN/image_recognition_pipeline/index.rst
docs/zh_CN/image_recognition_pipeline/index.rst
+1
-1
docs/zh_CN/inference_deployment/index.rst
docs/zh_CN/inference_deployment/index.rst
+8
-5
docs/zh_CN/inference_deployment/paddle_serving_deploy.md
docs/zh_CN/inference_deployment/paddle_serving_deploy.md
+2
-2
docs/zh_CN/others/course_link.md
docs/zh_CN/others/course_link.md
+1
-1
docs/zh_CN/others/index.rst
docs/zh_CN/others/index.rst
+12
-7
docs/zh_CN/others/paddle_mobile_inference.md
docs/zh_CN/others/paddle_mobile_inference.md
+1
-1
docs/zh_CN/readFile.py
docs/zh_CN/readFile.py
+0
-64
readthedoc指南.md
readthedoc指南.md
+0
-166
未找到文件。
docs/zh_CN/advanced_tutorials/index.rst
浏览文件 @
fcc2fac0
...
...
@@ -4,8 +4,10 @@
.. toctree::
:maxdepth: 2
model_prune_quantiz
ation.md
DataAugment
ation.md
knowledge_distillation.md
how_to_contribute
.md
model_prune_quantization
.md
code_overview.md
DataAugmentation.md
how_to_contribute.md
docs/zh_CN/faq_series/index.rst
浏览文件 @
fcc2fac0
...
...
@@ -6,5 +6,5 @@ FAQ系列
faq_2021_s2.md
faq_2021_s1.md
faq_selected_30.md
faq_2020_s1.md
faq_selected_30.md
docs/zh_CN/image_recognition_pipeline/index.rst
浏览文件 @
fcc2fac0
...
...
@@ -4,6 +4,6 @@
.. toctree::
:maxdepth: 2
vector_search.md
mainbody_detection.md
feature_extraction.md
vector_search.md
docs/zh_CN/inference_deployment/index.rst
浏览文件 @
fcc2fac0
...
...
@@ -4,11 +4,14 @@
.. toctree::
:maxdepth: 2
paddle_serving_deploy.md
whl_deploy.md
cpp_deploy_on_windows.md
export_model.md
python_deploy.md
paddle_hub_serving_deploy.md
cpp_deploy.md
paddle_serving_deploy.md
paddle_hub_serving_deploy.md
paddle_lite_deploy.md
export_model.md
whl_deploy.md
cpp_deploy_on_windows.md
docs/zh_CN/inference_deployment/paddle_serving_deploy.md
浏览文件 @
fcc2fac0
# 模型服务化部署
\
----
# 模型服务化部署
----
----
## 目录
-
[
1. 简介
](
#1
)
-
[
2. Serving 安装
](
#2
)
...
...
docs/zh_CN/others/course_link.md
浏览文件 @
fcc2fac0
# 往期课程链接
:
# 往期课程链接
---
-
[
**【AI快车道PaddleClas系列直播课】**
](
https://aistudio.baidu.com/aistudio/course/introduce/24519
)
...
...
docs/zh_CN/others/index.rst
浏览文件 @
fcc2fac0
...
...
@@ -4,12 +4,17 @@
.. toctree::
:maxdepth: 2
competition_support.md
paddle_mobile_inference.md
feature_visiualization.md
VisualDL.md
versions.md
update_history.md
train_on_xpu.md
transfer_learning.md
train_with_DALI.md
VisualDL.md
train_on_xpu.md
feature_visiualization.md
paddle_mobile_inference.md
course_link.md
competition_support.md
update_history.md
versions.md
docs/zh_CN/others/paddle_mobile_inference.md
浏览文件 @
fcc2fac0
#
Paddle-Lite
#
手机端 benchmark
---
## 目录
...
...
docs/zh_CN/readFile.py
已删除
100644 → 0
浏览文件 @
8dac4204
import
os
def
file_name
(
file_dir
):
temp
=
[]
for
root
,
dirs
,
files
in
os
.
walk
(
file_dir
):
print
(
dirs
)
#当前路径下所有子目录
temp
=
dirs
#存储需要的子目录
break
# 删除不需要的子目录
temp
.
remove
(
'_templates'
)
temp
.
remove
(
'_build'
)
temp
.
remove
(
'_static'
)
chinese_name
=
[
'模型训练'
,
'介绍'
,
'图像识别流程'
,
'其他'
,
'FAQ系列'
,
'数据准备'
,
'安装'
,
'模型库'
,
'高级教程'
,
'算法介绍'
,
'推理部署'
,
'快速开始'
]
# 写根目录下的rst文件
with
open
(
'./index.rst'
,
'w'
)
as
f
:
f
.
write
(
'欢迎使用PaddleClas图像分类库!
\n
'
)
f
.
write
(
'================================
\n\n
'
)
f
.
write
(
'.. toctree::
\n
'
)
f
.
write
(
' :maxdepth: 1
\n\n
'
)
for
dir
in
temp
:
f
.
write
(
' '
+
dir
+
'/index
\n
'
)
f
.
close
()
# 写各个子目录下的rst文件
for
dir
in
temp
:
for
root
,
dirs
,
files
in
os
.
walk
(
dir
):
print
(
root
)
#当前目录路径
if
'index.rst'
in
files
:
files
.
remove
(
'index.rst'
)
print
(
files
)
#当前路径下所有非目录子文件
curDir
=
os
.
path
.
join
(
file_dir
,
dir
)
filename
=
curDir
+
'/index.rst'
idx
=
temp
.
index
(
dir
)
ch_name
=
chinese_name
[
idx
]
with
open
(
filename
,
'w'
)
as
f
:
f
.
write
(
ch_name
+
'
\n
'
)
f
.
write
(
'================================
\n\n
'
)
f
.
write
(
'.. toctree::
\n
'
)
f
.
write
(
' :maxdepth: 2
\n\n
'
)
for
f1
in
files
:
f
.
write
(
' '
+
f1
+
'
\n
'
)
f
.
close
()
def
readfile
(
filename
):
file
=
open
(
filename
)
i
=
0
while
1
:
line
=
file
.
readline
()
print
(
i
)
print
(
line
)
i
+=
1
if
not
line
:
break
pass
# do something
file
.
close
()
file_name
(
'./'
)
#filename = './index.rst'
#readfile(filename)
readthedoc指南.md
已删除
100644 → 0
浏览文件 @
8dac4204
1.
注册ReadtheDocs并连接到github
2.
在github上将项目克隆到本地
3.
在本地仓库中安装Sphinx
```
shell
pip
install
sphinx
```
4.
创建工程
```
shell
sphinx-quickstart
```
5.
对工程进行配置
5.
1 更改主题
在source/conf.py中更改或添加如下代码
```
python
import
sphinx_rtd_theme
html_theme
=
"sphinx_rtd_theme"
html_theme_path
=
[
sphinx_rtd_theme
.
get_html_theme_path
()]
```
5.
2 添加markdown支持和markdown表格支持
首先需要安装recommonmark和sphinx_markdown_tables
```
shell
pip
install
recommonmark
pip
install
sphinx_markdown_tables
```
在source/conf.py中更改或添加如下代码
```
python
from
recommonmark.parser
import
CommonMarkParser
source_parsers
=
{
'.md'
:
CommonMarkParser
,
}
source_suffix
=
[
'.rst'
,
'.md'
]
extensions
=
[
'recommonmark'
,
'sphinx_markdown_tables'
]
```
以上五步具体效果可以参考https://www.jianshu.com/p/d1d59d0cd58c
6.
在创建好项目以后,根目录下应该有如下几个文件:
-
**Makefile**
:在使用
`make`
命令时,可以使用这些指令(e.g.
`sphinx-build`
)来构建文档输出。
-
**_build**
:这是触发特定输出后用来存放所生成的文件的目录。
-
**_static**
:所有不属于源代码(e.g. 图片)一部分的文件均存放于此处,稍后会在构建目录中将它们链接在一起。
-
**conf.py**
:用于存放 Sphinx 的配置值,包括在终端执行
`sphinx-quickstart`
时选中的那些值。
-
**index.rst**
:文档项目的 root 目录。如果将文档划分为其他文件,该目录会连接这些文件
7.
**编写文档**
:在 index.rst 文件中的主标题之后,有一个内容清单,其中包括
`toctree`
声明,它将所有文档链接都汇集到 Index。
以根目录下的index.rst为例:
```
rst
欢迎使用PaddleClas图像分类库!
================================
.. toctree::
:maxdepth: 1
models_training/index
introduction/index
image_recognition_pipeline/index
others/index
faq_series/index
data_preparation/index
installation/index
models/index
advanced_tutorials/index
algorithm_introduction/index
inference_deployment/index
quick_start/index
```
可以用下面的python代码实现根目录和各个子目录下的
`index.rst`
文件的编写
注意:此代码应该在需要生成文档书的文件夹根目录上运行
```
python
import
os
def
file_name
(
file_dir
):
temp
=
[]
for
root
,
dirs
,
files
in
os
.
walk
(
file_dir
):
print
(
dirs
)
#当前路径下所有子目录
temp
=
dirs
#存储需要的子目录
break
# 删除不需要的子目录
temp
.
remove
(
'images'
)
temp
.
remove
(
'_templates'
)
temp
.
remove
(
'_build'
)
temp
.
remove
(
'_static'
)
chinese_name
=
[
'模型训练'
,
'介绍'
,
'图像识别流程'
,
'其他'
,
'FAQ系列'
,
'数据准备'
,
'安装'
,
'模型库'
,
'高级教程'
,
'算法介绍'
,
'推理部署'
,
'快速开始'
]
# 写根目录下的rst文件
with
open
(
'./index.rst'
,
'w'
)
as
f
:
f
.
write
(
'欢迎使用PaddleClas图像分类库!
\n
'
)
f
.
write
(
'================================
\n\n
'
)
f
.
write
(
'.. toctree::
\n
'
)
f
.
write
(
' :maxdepth: 1
\n\n
'
)
for
dir
in
temp
:
f
.
write
(
' '
+
dir
+
'/index
\n
'
)
f
.
close
()
# 写各个子目录下的rst文件
for
dir
in
temp
:
for
root
,
dirs
,
files
in
os
.
walk
(
dir
):
print
(
root
)
#当前目录路径
files
.
remove
(
'index.rst'
)
print
(
files
)
#当前路径下所有非目录子文件
curDir
=
os
.
path
.
join
(
file_dir
,
dir
)
filename
=
curDir
+
'/index.rst'
idx
=
temp
.
index
(
dir
)
ch_name
=
chinese_name
[
idx
]
with
open
(
filename
,
'w'
)
as
f
:
f
.
write
(
ch_name
+
'
\n
'
)
f
.
write
(
'================================
\n\n
'
)
f
.
write
(
'.. toctree::
\n
'
)
f
.
write
(
' :maxdepth: 2
\n\n
'
)
for
f1
in
files
:
f
.
write
(
' '
+
f1
+
'
\n
'
)
f
.
close
()
def
readfile
(
filename
):
file
=
open
(
filename
)
i
=
0
while
1
:
line
=
file
.
readline
()
print
(
i
)
print
(
line
)
i
+=
1
if
not
line
:
break
pass
# do something
file
.
close
()
file_name
(
'./'
)
# filename = './index.rst'
# readfile(filename)
```
8.
生成文档
运行
`make html`
命令
9.
使用浏览器查看在build/html目录下的
`index.html`
文件可以查看静态网页
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录