Merge pull request PaddlePaddle#639 from luotao1/doc

refine doc_cn/ui/index.rst
purplegourd · Nov 28, 2016 · 922ee9b · 922ee9b
2 parents 30fc33c + ddb948a
commit 922ee9b
Show file tree

Hide file tree

Showing 9 changed files with 17 additions and 31 deletions.
diff --git a/doc_cn/ui/cmd/dump_config.rst b/doc_cn/ui/cmd/dump_config.rst
diff --git a/doc_cn/ui/cmd/index.rst b/doc_cn/ui/cmd/index.rst
@@ -1,29 +1,20 @@
-PaddlePaddle的命令行参数
-========================
+命令
+====
 
-安装好PaddlePaddle后，在命令行直接敲击 ``paddle`` 或 ``paddle --help`` 会显示如下一些命令行参数。
+安装好PaddlePaddle后，在命令行直接敲击 ``paddle`` 或 ``paddle --help`` 会显示如下一些命令。
 
 * ``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的版本和编译选项相关信息。
+    用于打印当前PaddlePaddle的版本和编译选项相关信息。常见的输出格式如下：1）第一行说明了PaddlePaddle的版本信息；2）第二行开始说明了一些主要的编译选项，具体意义可以参考 `编译参数选项文件 <../../build_and_install/cmake/compile_options.html>`_ 。
+
+    ..  literalinclude:: paddle_version.txt
+
 * ``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:
-
-    paddle_train.rst
-    paddle_pserver.rst
-    paddle_version.rst
-    merge_model.rst
-    dump_config.rst
-    make_diagram.rst
+    使用graphviz对PaddlePaddle的模型配置文件进行绘制。
diff --git a/doc_cn/ui/cmd/make_diagram.rst b/doc_cn/ui/cmd/make_diagram.rst
diff --git a/doc_cn/ui/cmd/merge_model.rst b/doc_cn/ui/cmd/merge_model.rst
diff --git a/doc_cn/ui/cmd/paddle_pserver.rst b/doc_cn/ui/cmd/paddle_pserver.rst
diff --git a/doc_cn/ui/cmd/paddle_train.rst b/doc_cn/ui/cmd/paddle_train.rst
diff --git a/doc_cn/ui/cmd/paddle_version.rst b/doc_cn/ui/cmd/paddle_version.rst
diff --git a/doc_cn/ui/index.rst b/doc_cn/ui/index.rst
@@ -11,21 +11,23 @@
     data_provider/index.rst
 
 
-命令行参数
-==========
+命令及命令行参数
+================
 
 ..  toctree::
+    :maxdepth: 1
 
     cmd/index.rst
 
+* `参数用例 <../../doc/ui/cmd_argument/use_case.html>`_
 * `参数分类 <../../doc/ui/cmd_argument/argument_outline.html>`_
 * `参数描述 <../../doc/ui/cmd_argument/detail_introduction.html>`_
-* `参数用例 <../../doc/ui/cmd_argument/use_case.html>`_
 
 
 预测
 ====
 
 ..  toctree::
+    :maxdepth: 1
 
     predict/swig_py_paddle.rst
diff --git a/doc_cn/ui/predict/swig_py_paddle.rst b/doc_cn/ui/predict/swig_py_paddle.rst
@@ -1,8 +1,8 @@
 基于Python的预测
 ================
 
-Python预测接口
---------------
+预测流程
+--------
 
 PaddlePaddle使用swig对常用的预测接口进行了封装，通过编译会生成py_paddle软件包，安装该软件包就可以在python环境下实现模型预测。可以使用python的 ``help()`` 函数查询软件包相关API说明。
 
@@ -20,8 +20,8 @@ PaddlePaddle使用swig对常用的预测接口进行了封装，通过编译会
   通过调用 ``forwardTest()`` 传入预测数据，直接返回计算结果。
 
 
-基于Python的预测Demo
---------------------
+预测Demo
+--------
 
 如下是一段使用mnist model来实现手写识别的预测代码。完整的代码见 ``src_root/doc/ui/predict/predict_sample.py`` 。mnist model可以通过 ``src_root\demo\mnist`` 目录下的demo训练出来。