Merge pull request PaddlePaddle#582 from hedaoyuan/refine_ui_doc

Refine ui cmd doc
Shying · Nov 25, 2016 · 4f1bf30 · 4f1bf30
2 parents b47aff6 + 94ea8aa
commit 4f1bf30
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 26 deletions.
diff --git a/doc_cn/ui/cmd/index.rst b/doc_cn/ui/cmd/index.rst
@@ -1,17 +1,22 @@
-命令行参数
-==========
+PaddlePaddle的命令行参数
+========================
 
-安装好的PaddlePaddle脚本包括多条命令，他们是
+安装好PaddlePaddle后，在命令行直接敲击 ``paddle`` 或 ``paddle --help`` 会显示如下一些命令行参数。
 
-* paddle train即为PaddlePaddle的训练进程。可以使用paddle train完成单机多显卡多线程的训
-  练。也可以和paddle pserver组合使用，完成多机训练。
-* paddle pserver为PaddlePaddle的parameter server进程。负责多机训练中的参数聚合工作。
-* paddle version可以打印出PaddlePaddle的版本和编译时信息。
-* merge_model 可以将PaddlePaddle的模型和配置打包成一个文件。方便部署分发。
-* dump_config 可以将PaddlePaddle的训练模型以proto string的格式打印出来
-* make_diagram 可以使用graphviz对PaddlePaddle的网络模型进行绘制，方便调试使用。
+* ``train`` Start a paddle_trainer
+    启动一个PaddlePaddle训练进程。 ``paddle train`` 可以通过命令行参数 ``-local=true`` 启动一个单机的训练进程；也可以和 ``paddle pserver`` 一起使用启动多机的分布式训练进程。
+* ``pserver`` Start a paddle_pserver_main
+    在多机分布式训练下启动PaddlePaddle的parameter server进程。
+* ``version`` Print paddle version
+    用于打印当前PaddlePaddle的版本和编译选项相关信息。
+* ``merge_model`` Start a paddle_merge_model
+    用于将PaddlePaddle的模型参数文件和模型配置文件打包成一个文件，方便做部署分发。
+* ``dump_config`` Dump the trainer config as proto string
+    用于将PaddlePaddle的模型配置文件以proto string的格式打印出来。
+* ``make_diagram``
+    使用graphviz对PaddlePaddle的模型配置文件进行绘制。
 
-更详细的介绍请参考各个命令的命令行参数文档。
+更详细的介绍请参考各命令行参数文档。
 
 ..  toctree::
     :glob:

diff --git a/doc_cn/ui/cmd/paddle_pserver.rst b/doc_cn/ui/cmd/paddle_pserver.rst
@@ -1,2 +0,0 @@
-paddle pserver的命令行参数
-==========================

diff --git a/doc_cn/ui/cmd/paddle_train.rst b/doc_cn/ui/cmd/paddle_train.rst
@@ -1,2 +0,0 @@
-paddle train的命令行参数
-========================

diff --git a/doc_cn/ui/cmd/paddle_version.rst b/doc_cn/ui/cmd/paddle_version.rst
@@ -1,9 +1,7 @@
 paddle version的命令行参数
 ==========================
 
-paddle version可以打印出paddle的版本信息和编译的选项。常见的输出格式为
+paddle version用于打印当前的版本信息和相关编译选项。常见的输出格式如下。第一行说明了PaddlePaddle的版本信息，后面跟着一些主要的编译选项。编译选项的具体意义可以参考
+`编译参数选项文件 <../../build_and_install/cmake/compile_options.html>`_
 
 ..  literalinclude:: paddle_version.txt
-
-其第一行说明了paddle的版本，后面跟着一系列编译参数。这里可以参考paddle的
-`编译参数选项文件 <../../build/cmake/compile_options.html>`_
diff --git a/doc_cn/ui/index.rst b/doc_cn/ui/index.rst
@@ -1,8 +1,9 @@
+########
 用户接口
-========
+########
 
 数据提供
-''''''''
+========
 
 ..  toctree::
     :maxdepth: 1
@@ -11,14 +12,19 @@
 
 
 命令行参数
-''''''''''
-* `Use Case <../../doc/ui/cmd_argument/use_case.html>`_
-* `Argument Outline <../../doc/ui/cmd_argument/argument_outline.html>`_
-* `Detail Description <../../doc/ui/cmd_argument/detail_introduction.html>`_
+==========
+
+..  toctree::
+
+    cmd/index.rst
+
+* `参数分类 <../../doc/ui/cmd_argument/argument_outline.html>`_
+* `参数描述 <../../doc/ui/cmd_argument/detail_introduction.html>`_
+* `参数用例 <../../doc/ui/cmd_argument/use_case.html>`_
 
 
 预测
-''''
+====
 
 ..  toctree::
Original file line number	Diff line number	Diff line change
		@@ -1,2 +0,0 @@
		paddle pserver的命令行参数
		==========================
Original file line number	Diff line number	Diff line change
		@@ -1,2 +0,0 @@
		paddle train的命令行参数
		========================