From e9d825c1751d36b56f2a9099cbcf5e6816233447 Mon Sep 17 00:00:00 2001 From: hedaoyuan Date: Wed, 23 Nov 2016 22:52:44 +0800 Subject: [PATCH] refine cmd doc --- doc_cn/ui/cmd/index.rst | 27 ++++++++++++++++----------- doc_cn/ui/cmd/paddle_pserver.rst | 2 -- doc_cn/ui/cmd/paddle_train.rst | 2 -- 3 files changed, 16 insertions(+), 15 deletions(-) diff --git a/doc_cn/ui/cmd/index.rst b/doc_cn/ui/cmd/index.rst index 6d62180a6a..f975d432c0 100644 --- 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 index 891975c34a..e69de29bb2 100644 --- 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 index 87b84f5cbd..e69de29bb2 100644 --- a/doc_cn/ui/cmd/paddle_train.rst +++ b/doc_cn/ui/cmd/paddle_train.rst @@ -1,2 +0,0 @@ -paddle train的命令行参数 -======================== -- GitLab