Skip to content

Commit b93a125

Browse files
authored
Merge pull request #364 from yinhaofeng/config
readthedocs
2 parents ff4a580 + 759b883 commit b93a125

28 files changed

+240
-2203
lines changed

doc/quick_start.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

doc/requirements.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
sphinx==2.1.0
2+
mistune
3+
sphinx_rtd_theme
4+
paddlepaddle>=1.8
5+
zmq
6+
sphinx-markdown-tables
7+
recommonmark

doc/source/index.rst

Lines changed: 6 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -19,67 +19,27 @@
1919
paddlerec/rec_background.md
2020
paddlerec/ps_background.md
2121

22-
.. toctree::
23-
:maxdepth: 1
24-
:numbered:
25-
:caption: 快速开始
26-
:name: quick start
27-
28-
paddlerec/quick_start.md
29-
3022
.. toctree::
3123
:maxdepth: 1
3224
:numbered:
3325
:caption: 入门教程
3426
:name: Getting started
3527

36-
paddlerec/slot_reader.md
37-
paddlerec/train.md
38-
paddlerec/model.md
39-
paddlerec/predict.md
40-
paddlerec/serving.md
41-
42-
进阶教程
43-
====================
44-
45-
- 1. `PaddleRec 设计 <paddlerec/design.html>`_
46-
.. image:: media/design.png
47-
:align: center
48-
:alt: design
49-
:width: 10.03529in
50-
:height: 3.97222in
51-
- 2. `yaml配置说明 <paddlerec/yaml.html>`_
52-
- 3. `如何自定义Reader <paddlerec/custom_reader.html>`_
53-
- 4. `如何添加自定义模型 <paddlerec/model_develop.html>`_
54-
- 5. `如何给模型增加Metric <paddlerec/metrics.html>`_
55-
- 6. `内置的Trainer训练流程 <paddlerec/exist_develop.html>`_
56-
- 7. `如何添加自定义Trainer训练流程 <paddlerec/trainer_develop.html>`_
57-
- 8. `如何启动分布式训练 <paddlerec/distributed_train.html>`_
28+
paddlerec/introduction.md
29+
paddlerec/dygraph_mode.md
30+
paddlerec/static_mode.md
31+
paddlerec/fleet_mode.md
5832

5933
.. toctree::
60-
:hidden:
6134
:maxdepth: 1
6235
:numbered:
6336
:caption: 进阶教程
6437
:name: Advanced course
6538

66-
paddlerec/design.md
67-
paddlerec/yaml.md
6839
paddlerec/custom_reader.md
6940
paddlerec/model_develop.md
70-
paddlerec/metrics.md
71-
paddlerec/exist_develop.md
72-
paddlerec/trainer_develop.md
73-
paddlerec/distributed_train.md
74-
75-
76-
.. toctree::
77-
:maxdepth: 1
78-
:numbered:
79-
:caption: 模型介绍
80-
:name: Model introduction
81-
82-
paddlerec/model_introduce.md
41+
paddlerec/yaml.md
42+
paddlerec/benchmark.md
8343

8444
.. toctree::
8545
:maxdepth: 1

doc/source/media/design.png

-470 KB
Binary file not shown.

doc/source/paddlerec/__init__.py

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

doc/source/paddlerec/benchmark.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# PaddleRec Benchmark
1+
# Benchmark
22

33
`PaddleRec`中各模型在各种模式下的效果及性能数据将随版本迭代不断更新,欢迎持续关注并监督,如有任何问题,欢迎在[Github Issue](https://github.com/PaddlePaddle/PaddleRec/issues)提出。
44

0 commit comments

Comments
 (0)