Merge pull request #8732 from kuke/commands_doc

Add guideline for the doc of cmd parameters
7 years ago · bb60e920a1
parent 01654212da 5fc1e38273
commit bb60e920a1
1 changed files with 15 additions and 0 deletions
--- a/doc/howto/cmd_parameter/index_cn.rst
+++ b/doc/howto/cmd_parameter/index_cn.rst
@ -2,10 +2,25 @@

 命令行参数设置
 ===============
+深度学习算法的实现有着多样化的特点，运行环境、运行阶段、模型结构、训练策略等等这些都是常见的变化因素。PaddlePaddle支持用户灵活地设置各种命令行参数，以实现对模型训练或预测流程的控制。
+
+在这一部分，首先以几个实际场景为例，展示了部分命令行参数的使用:

 ..  toctree::
  :maxdepth: 1

  use_case_cn.md
+
+接着对所有参数的使用场合进行概述和分类:
+
+..  toctree::
+  :maxdepth: 1
+
  arguments_cn.md
+
+最后给出细节描述，详细解释这些参数的属性和意义:
+
+..  toctree::
+  :maxdepth: 1
+
  detail_introduction_cn.md