Skip to content

Commit 4f1bf30

Browse files
authored
Merge pull request #582 from hedaoyuan/refine_ui_doc
Refine ui cmd doc
2 parents b47aff6 + 94ea8aa commit 4f1bf30

File tree

5 files changed

+31
-26
lines changed

5 files changed

+31
-26
lines changed

doc_cn/ui/cmd/index.rst

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
1-
命令行参数
2-
==========
1+
PaddlePaddle的命令行参数
2+
========================
33

4-
安装好的PaddlePaddle脚本包括多条命令,他们是
4+
安装好PaddlePaddle后,在命令行直接敲击 ``paddle`` 或 ``paddle --help`` 会显示如下一些命令行参数。
55

6-
* paddle train即为PaddlePaddle的训练进程。可以使用paddle train完成单机多显卡多线程的训
7-
练。也可以和paddle pserver组合使用,完成多机训练。
8-
* paddle pserver为PaddlePaddle的parameter server进程。负责多机训练中的参数聚合工作。
9-
* paddle version可以打印出PaddlePaddle的版本和编译时信息。
10-
* merge_model 可以将PaddlePaddle的模型和配置打包成一个文件。方便部署分发。
11-
* dump_config 可以将PaddlePaddle的训练模型以proto string的格式打印出来
12-
* make_diagram 可以使用graphviz对PaddlePaddle的网络模型进行绘制,方便调试使用。
6+
* ``train`` Start a paddle_trainer
7+
启动一个PaddlePaddle训练进程。 ``paddle train`` 可以通过命令行参数 ``-local=true`` 启动一个单机的训练进程;也可以和 ``paddle pserver`` 一起使用启动多机的分布式训练进程。
8+
* ``pserver`` Start a paddle_pserver_main
9+
在多机分布式训练下启动PaddlePaddle的parameter server进程。
10+
* ``version`` Print paddle version
11+
用于打印当前PaddlePaddle的版本和编译选项相关信息。
12+
* ``merge_model`` Start a paddle_merge_model
13+
用于将PaddlePaddle的模型参数文件和模型配置文件打包成一个文件,方便做部署分发。
14+
* ``dump_config`` Dump the trainer config as proto string
15+
用于将PaddlePaddle的模型配置文件以proto string的格式打印出来。
16+
* ``make_diagram``
17+
使用graphviz对PaddlePaddle的模型配置文件进行绘制。
1318

14-
更详细的介绍请参考各个命令的命令行参数文档
19+
更详细的介绍请参考各命令行参数文档
1520

1621
.. toctree::
1722
:glob:

doc_cn/ui/cmd/paddle_pserver.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +0,0 @@
1-
paddle pserver的命令行参数
2-
==========================

doc_cn/ui/cmd/paddle_train.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +0,0 @@
1-
paddle train的命令行参数
2-
========================

doc_cn/ui/cmd/paddle_version.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
paddle version的命令行参数
22
==========================
33

4-
paddle version可以打印出paddle的版本信息和编译的选项。常见的输出格式为
4+
paddle version用于打印当前的版本信息和相关编译选项。常见的输出格式如下。第一行说明了PaddlePaddle的版本信息,后面跟着一些主要的编译选项。编译选项的具体意义可以参考
5+
`编译参数选项文件 <../../build_and_install/cmake/compile_options.html>`_
56

67
.. literalinclude:: paddle_version.txt
7-
8-
其第一行说明了paddle的版本,后面跟着一系列编译参数。这里可以参考paddle的
9-
`编译参数选项文件 <../../build/cmake/compile_options.html>`_

doc_cn/ui/index.rst

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1+
########
12
用户接口
2-
========
3+
########
34

45
数据提供
5-
''''''''
6+
========
67

78
.. toctree::
89
:maxdepth: 1
@@ -11,14 +12,19 @@
1112

1213

1314
命令行参数
14-
''''''''''
15-
* `Use Case <../../doc/ui/cmd_argument/use_case.html>`_
16-
* `Argument Outline <../../doc/ui/cmd_argument/argument_outline.html>`_
17-
* `Detail Description <../../doc/ui/cmd_argument/detail_introduction.html>`_
15+
==========
16+
17+
.. toctree::
18+
19+
cmd/index.rst
20+
21+
* `参数分类 <../../doc/ui/cmd_argument/argument_outline.html>`_
22+
* `参数描述 <../../doc/ui/cmd_argument/detail_introduction.html>`_
23+
* `参数用例 <../../doc/ui/cmd_argument/use_case.html>`_
1824

1925

2026
预测
21-
''''
27+
====
2228

2329
.. toctree::
2430

0 commit comments

Comments
 (0)