detail_introduction_en.html



<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Detail Description &mdash; PaddlePaddle  documentation</title>
  

    <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
  

        <link rel="index" title="Index"
              href="../../../genindex.html"/>
        <link rel="search" title="Search" href="../../../search.html"/>
    <link rel="top" title="PaddlePaddle  documentation" href="../../../index.html"/>
        <link rel="up" title="Set Command-line Parameters" href="index_en.html"/>
        <link rel="next" title="PaddlePaddle Distributed Training" href="../cluster/cluster_train_en.html"/>
        <link rel="prev" title="Argument Outline" href="arguments_en.html"/> 

  <link rel="stylesheet" href="https://cdn.jsdelivr.net/perfect-scrollbar/0.6.14/css/perfect-scrollbar.min.css" type="text/css" />
  <link rel="stylesheet" href="../../../_static/css/override.css" type="text/css" />
  <script>
  var _hmt = _hmt || [];
  (function() {
    var hm = document.createElement("script");
    hm.src = "//hm.baidu.com/hm.js?b9a314ab40d04d805655aab1deee08ba";
    var s = document.getElementsByTagName("script")[0]; 
    s.parentNode.insertBefore(hm, s);
  })();
  </script>

  
  <script src="../../../_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

  
  <header class="site-header">
    <div class="site-logo">
      <a href="/"><img src="../../../_static/images/PP_w.png"></a>
    </div>
    <div class="site-nav-links">
      <div class="site-menu">
        <a class="fork-on-github" href="https://github.com/PaddlePaddle/Paddle" target="_blank"><i class="fa fa-github"></i>Fork me on Github</a>
        <div class="language-switcher dropdown">
          <a type="button" data-toggle="dropdown">
            <span>English</span>
            <i class="fa fa-angle-up"></i>
            <i class="fa fa-angle-down"></i>
          </a>
          <ul class="dropdown-menu">
            <li><a href="/doc_cn">中文</a></li>
            <li><a href="/doc">English</a></li>
          </ul>
        </div>
        <ul class="site-page-links">
          <li><a href="/">Home</a></li>
        </ul>
      </div>
      <div class="doc-module">
        
        <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../../getstarted/index_en.html">GET STARTED</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../../index_en.html">HOW TO</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../api/index_en.html">API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../mobile/index_en.html">MOBILE</a></li>
</ul>

        
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>        
      </div>
    </div>
  </header>
  
  <div class="main-content-wrap">

    
    <nav class="doc-menu-vertical" role="navigation">
        
          
          <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../../getstarted/index_en.html">GET STARTED</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../../getstarted/build_and_install/index_en.html">Install and Build</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../../getstarted/build_and_install/pip_install_en.html">Install Using pip</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../getstarted/build_and_install/docker_install_en.html">Run in Docker Containers</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../dev/build_en.html">Build using Docker</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../getstarted/build_and_install/build_from_source_en.html">Build from Sources</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1 current"><a class="reference internal" href="../../index_en.html">HOW TO</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="index_en.html">Set Command-line Parameters</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="use_case_en.html">Use Case</a></li>
<li class="toctree-l3"><a class="reference internal" href="arguments_en.html">Argument Outline</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">Detail Description</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../cluster/cluster_train_en.html">PaddlePaddle Distributed Training</a></li>
<li class="toctree-l2"><a class="reference internal" href="../k8s/k8s_en.html">Paddle On Kubernetes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../k8s/k8s_aws_en.html">Distributed PaddlePaddle Training on AWS with Kubernetes</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../dev/new_layer_en.html">Write New Layers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../dev/contribute_to_paddle_en.html">Contribute Code</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../dev/write_docs_en.html">Contribute Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../deep_model/rnn/index_en.html">RNN Models</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../deep_model/rnn/rnn_config_en.html">RNN Configuration</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../optimization/gpu_profiling_en.html">Tune GPU Performance</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../../api/index_en.html">API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../../api/v2/model_configs.html">Model Configuration</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../../api/v2/config/activation.html">Activation</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../api/v2/config/layer.html">Layers</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../api/v2/config/evaluators.html">Evaluators</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../api/v2/config/optimizer.html">Optimizer</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../api/v2/config/pooling.html">Pooling</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../api/v2/config/networks.html">Networks</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../api/v2/config/attr.html">Parameter Attribute</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/v2/data.html">Data Reader Interface and DataSets</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../../api/v2/data/data_reader.html">Data Reader Interface</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../api/v2/data/image.html">Image Interface</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../api/v2/data/dataset.html">Dataset</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/v2/run_logic.html">Training and Inference</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../api/v2/fluid.html">Fluid</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../../api/v2/fluid/layers.html">Layers</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../api/v2/fluid/data_feeder.html">DataFeeder</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../api/v2/fluid/executor.html">Executor</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../api/v2/fluid/initializer.html">Initializer</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../api/v2/fluid/evaluator.html">Evaluator</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../api/v2/fluid/nets.html">Nets</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../api/v2/fluid/optimizer.html">Optimizer</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../api/v2/fluid/param_attr.html">ParamAttr</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../api/v2/fluid/profiler.html">Profiler</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../api/v2/fluid/regularizer.html">Regularizer</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../../mobile/index_en.html">MOBILE</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../../mobile/cross_compiling_for_android_en.html">Build PaddlePaddle for Android</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../mobile/cross_compiling_for_raspberry_en.html">Build PaddlePaddle for Raspberry Pi</a></li>
</ul>
</li>
</ul>

        
    </nav>
    
    <section class="doc-content-wrap">

      
<div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
      
        <li><a href="../../index_en.html">HOW TO</a> > </li>
      
        <li><a href="index_en.html">Set Command-line Parameters</a> > </li>
      
    <li>Detail Description</li>
  </ul>
</div>
      
      <div class="wy-nav-content" id="doc-content">
        <div class="rst-content">
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="detail-description">
<span id="detail-description"></span><span id="cmd-detail-introduction"></span><h1>Detail Description<a class="headerlink" href="#detail-description" title="Permalink to this headline">¶</a></h1>
<div class="section" id="common">
<span id="common"></span><h2>Common<a class="headerlink" href="#common" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">--job</span></code><ul>
<li>Job mode, including: <strong>train, test, checkgrad</strong>, where checkgrad is mainly for developers and users do not need to care about.</li>
<li>type: string (default: train)</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--config</span></code><ul>
<li>Use to specfiy network configure file.</li>
<li>type: string (default: null).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--use_gpu</span></code><ul>
<li>Whether to use GPU for training, false is cpu mode and true is gpu mode.</li>
<li>type: bool (default: 1).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--local</span></code><ul>
<li>Whether the training is in local mode or not. True when training locally or using one node in cluster. False when using multiple machines in cluster.</li>
<li>type: bool (default: 1).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--trainer_count</span></code><ul>
<li>Define the number of threads used in one machine. For example, trainer_count = 4, means use 4 GPU in GPU mode and 4 threads in CPU mode. Each thread (or GPU) is assigned to 1/4 samples in current batch. That is to say, if setting batch_size of 512 in trainer config, each thread train 128 samples.</li>
<li>type: int32 (default: 1).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--num_passes</span></code><ul>
<li>When <code class="docutils literal"><span class="pre">--job=train</span></code>, means training for num_passes passes. One pass means training all samples in dataset one time. When <code class="docutils literal"><span class="pre">--job=test</span></code>, means testing data from model of test_pass to  model of (num_passes - 1).</li>
<li>type: int32 (default: 100).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--config_args</span></code><ul>
<li>arguments passed to config file. Format: key1=value1,key2=value2.</li>
<li>type: string (default: null).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--version</span></code><ul>
<li>Whether to print version information.</li>
<li>type: bool (default: 0).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--show_layer_stat</span></code><ul>
<li>Whether to show the statistics of each layer <strong>per batch</strong>.</li>
<li>type: bool (default: 0).</li>
</ul>
</li>
</ul>
</div>
<div class="section" id="train">
<span id="train"></span><h2>Train<a class="headerlink" href="#train" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">--log_period</span></code><ul>
<li>Log progress every log_period batches.</li>
<li>type: int32 (default: 100).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--dot_period</span></code><ul>
<li>Print &#8216;.&#8217; every dot_period batches.</li>
<li>type: int32 (default: 1).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--saving_period</span></code><ul>
<li>Save parameters every saving_period passes</li>
<li>type: int32 (default: 1).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--save_dir</span></code><ul>
<li>Directory for saving model parameters. It needs to be specified, but no need to be created in advance.</li>
<li>type: string (default: null).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--start_pass</span></code><ul>
<li>Start training from this pass. It will load parameters from the previous pass.</li>
<li>type: int32 (default: 0).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--show_parameter_stats_period</span></code><ul>
<li>Show parameter statistic during training every show_parameter_stats_period batches. It will not show by default.</li>
<li>type: int32 (default: 0).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--save_only_one</span></code><ul>
<li>Save the parameters only in last pass, while the previous parameters will be removed.</li>
<li>type: bool (default: 0).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--load_missing_parameter_strategy</span></code><ul>
<li>Specify the loading operation when model file is missing. Now support fail/rand/zero three operations.<ul>
<li><code class="docutils literal"><span class="pre">fail</span></code>: program will exit.</li>
<li><code class="docutils literal"><span class="pre">rand</span></code>: uniform or normal distribution according to <strong>initial_strategy</strong> in network config. Uniform range is: <strong>[mean - std, mean + std]</strong>, where mean and std are configures in trainer config.</li>
<li><code class="docutils literal"><span class="pre">zero</span></code>: all parameters are zero.</li>
</ul>
</li>
<li>type: string (default: fail).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--init_model_path</span></code><ul>
<li>Path of the initialization model. If it was set, start_pass will be ignored. It can be used to specify model path in testing mode as well.</li>
<li>type: string (default: null).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--saving_period_by_batches</span></code><ul>
<li>Save parameters every saving_period_by_batches batches in one pass.</li>
<li>type: int32 (default: 0).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--log_error_clipping</span></code><ul>
<li>Whether to print error clipping log when setting <strong>error_clipping_threshold</strong> in layer config. If it is true, log will be printed in backward propagation <strong>per batch</strong>. This clipping effects on <strong>gradient of output</strong>.</li>
<li>type: bool (default: 0).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--log_clipping</span></code><ul>
<li>Enable print log clipping or not when setting <strong>gradient_clipping_threshold</strong> in trainer config. This clipping effects on <strong>gradient w.r.t. (with respect to) weight</strong>.</li>
<li>type: bool (default: 0).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--use_old_updater</span></code><ul>
<li>Whether to use the old RemoteParameterUpdater. Default use ConcurrentRemoteParameterUpdater. It is mainly for deverlopers and users usually do not need to care about.</li>
<li>type: bool (default: 0).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--enable_grad_share</span></code><ul>
<li>threshold for enable gradient parameter, which is shared for batch multi-cpu training.</li>
<li>type: int32 (default: 100 * 1024 * 1024).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--grad_share_block_num</span></code><ul>
<li>block number of gradient parameter, which is shared for batch multi-cpu training.</li>
<li>type: int32 (default: 64).</li>
</ul>
</li>
</ul>
</div>
<div class="section" id="test">
<span id="test"></span><h2>Test<a class="headerlink" href="#test" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">--test_pass</span></code><ul>
<li>Load parameter from this pass to test.</li>
<li>type: int32 (default: -1).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--test_period</span></code><ul>
<li>if equal 0, do test on all test data at the end of each pass. While if equal non-zero, do test on all test data every test_period batches.</li>
<li>type: int32 (default: 0).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--test_wait</span></code>
&nbsp;- Whether to wait for parameter per pass if not exist. It can be used when user launch another process to perfom testing during the training process.<ul>
<li>type: bool (default: 0).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--model_list</span></code><ul>
<li>File that saves the model list when testing.</li>
<li>type: string (default: &#8220;&#8221;, null).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--predict_output_dir</span></code><ul>
<li>Directory that saves the layer output. It is configured in Outputs() in network config. Default, this argument is null, meaning save nothing. Specify this directory if you want to save feature map of some layers in testing mode. Note that, layer outputs are values after activation function.</li>
<li>type: string (default: &#8220;&#8221;, null).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--average_test_period</span></code><ul>
<li>Do test on average parameter every <code class="docutils literal"><span class="pre">average_test_period</span></code> batches. It MUST be devided by FLAGS_log_period. Default 0 means do not test on average parameter.</li>
<li>type: int32 (default: 0).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--distribute_test</span></code><ul>
<li>Testing in distribute environment will merge results from multiple machines.</li>
<li>type: bool (default: 0).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--predict_file</span></code><ul>
<li>File name for saving predicted result. Default, this argument is null, meaning save nothing. Now, this argument is only used in AucValidationLayer and PnpairValidationLayer, and saves predicted result every pass.</li>
<li>type: string (default: &#8220;&#8221;, null).</li>
</ul>
</li>
</ul>
</div>
<div class="section" id="gpu">
<span id="gpu"></span><h2>GPU<a class="headerlink" href="#gpu" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">--gpu_id</span></code><ul>
<li>Which gpu core to use.</li>
<li>type: int32 (default: 0).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--allow_only_one_model_on_one_gpu</span></code><ul>
<li>If true, do not allow multiple models on one GPU device.</li>
<li>type: bool (default: 1).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--parallel_nn</span></code><ul>
<li>Whether to use multi-thread to calculate one neural network or not. If false, use gpu_id specify which gpu core to use (the device property in trainer config will be ingored). If true, the gpu core is specified in trainer config (gpu_id will be ignored).</li>
<li>type: bool (default: 0).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--cudnn_dir</span></code><ul>
<li>Choose path to dynamic load NVIDIA CuDNN library, for instance, /usr/local/cuda/lib64. [Default]: LD_LIBRARY_PATH</li>
<li>type: string (default: &#8220;&#8221;, null)</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--cuda_dir</span></code><ul>
<li>Choose path to dynamic load NVIDIA CUDA library, for instance, /usr/local/cuda/lib64. [Default]: LD_LIBRARY_PATH</li>
<li>type: string (default: &#8220;&#8221;, null)</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--cudnn_conv_workspace_limit_in_mb</span></code><ul>
<li>Specify cuDNN max workspace limit, in units MB, 4096MB=4GB by default.</li>
<li>type: int32 (default: 4096MB=4GB)</li>
</ul>
</li>
</ul>
</div>
<div class="section" id="nlp-rnn-lstm-gru">
<span id="nlp-rnn-lstm-gru"></span><h2>NLP: RNN/LSTM/GRU<a class="headerlink" href="#nlp-rnn-lstm-gru" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">--rnn_use_batch</span></code><ul>
<li>Whether to use batch method for calculation in simple RecurrentLayer.</li>
<li>type: bool (default: 0).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--prev_batch_state</span></code><ul>
<li>batch is continue with next batch.</li>
<li>type: bool (default: 0).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--beam_size</span></code><ul>
<li>Beam search uses breadth-first search to build its search tree. At each level of the tree, it generates all successors of the states at the current level, sorting them in increasing order of heuristic cost. However, it only stores a predetermined number of best states at each level (called the beam size).</li>
<li>type: int32 (default: 1).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--diy_beam_search_prob_so</span></code><ul>
<li>Specify shared dynamic library. It can be defined out of paddle by user.</li>
<li>type: string (default: &#8220;&#8221;, null).</li>
</ul>
</li>
</ul>
</div>
<div class="section" id="dataprovider">
<span id="dataprovider"></span><h2>DataProvider<a class="headerlink" href="#dataprovider" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">--memory_threshold_on_load_data</span></code><ul>
<li>Stop loading data when memory is not sufficient.</li>
<li>type: double (default: 1.0).</li>
</ul>
</li>
</ul>
</div>
<div class="section" id="unit-test">
<span id="unit-test"></span><h2>Unit Test<a class="headerlink" href="#unit-test" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">--checkgrad_eps</span></code><ul>
<li>parameter change size for checkgrad.</li>
<li>type: double (default: 1e-05).</li>
</ul>
</li>
</ul>
</div>
<div class="section" id="parameter-server-and-distributed-communication">
<span id="parameter-server-and-distributed-communication"></span><h2>Parameter Server and Distributed Communication<a class="headerlink" href="#parameter-server-and-distributed-communication" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">--start_pserver</span></code><ul>
<li>Whether to start pserver (parameter server).</li>
<li>type: bool (default: 0).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--pservers</span></code><ul>
<li>Comma separated IP addresses of pservers.</li>
<li>type: string (default: &#8220;127.0.0.1&#8221;).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--port</span></code><ul>
<li>Listening port for pserver.</li>
<li>type: int32 (default: 20134).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--ports_num</span></code><ul>
<li>The ports number for parameter send, increment based on default port number.</li>
<li>type: int32 (default: 1).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--trainer_id</span></code><ul>
<li>In distributed training, each trainer must be given an unique id ranging from 0 to num_trainers-1. Trainer 0 is the master trainer. User do not need to care this flag.</li>
<li>type: int32 (default: 0).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--num_gradient_servers</span></code><ul>
<li>Numbers of gradient servers. This arguments is set automatically in cluster submitting environment.</li>
<li>type: int32 (default: 1).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--small_messages</span></code><ul>
<li>If message size is small, recommend set it True to enable quick ACK and no delay</li>
<li>type: bool (default: 0).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--sock_send_buf_size</span></code><ul>
<li>Restrict socket send buffer size. It can reduce network congestion if set carefully.</li>
<li>type: int32 (default: 1024 * 1024 * 40).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--sock_recv_buf_size</span></code><ul>
<li>Restrict socket recieve buffer size.</li>
<li>type: int32 (default: 1024 * 1024 * 40).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--parameter_block_size</span></code><ul>
<li>Parameter block size for pserver, will automatically calculate a suitable value if it&#8217;s not set.</li>
<li>type: int32 (default: 0).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--parameter_block_size_for_sparse</span></code><ul>
<li>Parameter block size for sparse update pserver, will automatically calculate a suitable value if it&#8217;s not set.</li>
<li>type: int32 (default: 0).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--log_period_server</span></code><ul>
<li>Log progress every log_period_server batches at pserver end.</li>
<li>type: int32 (default: 500).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--loadsave_parameters_in_pserver</span></code><ul>
<li>Load and save parameters in pserver. Only work when parameter set sparse_remote_update.</li>
<li>type: bool (default: 0).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--pserver_num_threads</span></code><ul>
<li>number of threads for sync op exec.</li>
<li>type: bool (default: 1).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--ports_num_for_sparse</span></code><ul>
<li>The ports number for parameter send, increment based on default (port + ports_num). It is used by sparse Tranning.</li>
<li>type: int32 (default: 0).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--nics</span></code><ul>
<li>Network device name for pservers, already set in cluster submitting environment.</li>
<li>type: string (default: &#8220;xgbe0,xgbe1&#8221;).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--rdma_tcp</span></code><ul>
<li>Use rdma or tcp transport protocol, already set in cluster submitting environment.</li>
<li>type: string (default: &#8220;tcp&#8221;).</li>
</ul>
</li>
</ul>
</div>
<div class="section" id="async-sgd">
<span id="async-sgd"></span><h2>Async SGD<a class="headerlink" href="#async-sgd" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">--async_count</span></code><ul>
<li>Defined the asynchronous training length, if 0, then use synchronized training.</li>
<li>type: int32 (default: 0).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--async_lagged_ratio_min</span></code><ul>
<li>Control the minimize value of <code class="docutils literal"><span class="pre">config_.async_lagged_grad_discard_ratio()</span></code>.</li>
<li>type: double (default: 1.0).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--async_lagged_ratio_default</span></code><ul>
<li>If async_lagged_grad_discard_ratio is not set in network config, use it as defalut value.</li>
<li>type: double (default: 1.5).</li>
</ul>
</li>
</ul>
</div>
<div class="section" id="performance-tuning">
<span id="performance-tuning"></span><h2>Performance Tuning<a class="headerlink" href="#performance-tuning" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">--log_barrier_abstract</span></code><ul>
<li>If true, show abstract barrier performance information.</li>
<li>type: bool (default: 1).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--log_barrier_show_log</span></code><ul>
<li>If true, always show barrier abstract even with little gap.</li>
<li>type: bool (default: 0).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--log_barrier_lowest_nodes</span></code><ul>
<li>How many lowest node will be logged.</li>
<li>type: int32 (default: 5).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--check_sparse_distribution_in_pserver</span></code><ul>
<li>Whether to check that the distribution of sparse parameter on all pservers is balanced.</li>
<li>type: bool (default: 0).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--show_check_sparse_distribution_log</span></code><ul>
<li>show log details for sparse parameter distribution in pserver.</li>
<li>type: bool (default: 0).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--check_sparse_distribution_batches</span></code><ul>
<li>Running sparse parameter distribution check every so many batches.</li>
<li>type: int32 (default: 100).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--check_sparse_distribution_ratio</span></code><ul>
<li>If parameters dispatched to different pservers have an unbalanced distribution for check_sparse_distribution_ratio *  check_sparse_distribution_batches times, crash program.</li>
<li>type: double (default: 0.6).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--check_sparse_distribution_unbalance_degree</span></code><ul>
<li>The ratio of maximum data size / minimun data size for different pserver.</li>
<li>type: double (default: 2).</li>
</ul>
</li>
</ul>
</div>
<div class="section" id="matrix-vector-randomnumber">
<span id="matrix-vector-randomnumber"></span><h2>Matrix/Vector/RandomNumber<a class="headerlink" href="#matrix-vector-randomnumber" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">--enable_parallel_vector</span></code><ul>
<li>threshold for enable parallel vector.</li>
<li>type: int32 (default: 0).</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--seed</span></code><ul>
<li>random number seed. 0 for srand(time)</li>
<li>type: int32 (default: 1)</li>
</ul>
</li>
<li><code class="docutils literal"><span class="pre">--thread_local_rand_use_global_seed</span></code><ul>
<li>Whether to use global seed in rand of thread local.</li>
<li>type: bool (default: 0).</li>
</ul>
</li>
</ul>
</div>
</div>


           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="../cluster/cluster_train_en.html" class="btn btn-neutral float-right" title="PaddlePaddle Distributed Training" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="arguments_en.html" class="btn btn-neutral" title="Argument Outline" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2016, PaddlePaddle developers.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'../../../',
            VERSION:'',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true,
            SOURCELINK_SUFFIX: ".txt",
        };
    </script>
      <script type="text/javascript" src="../../../_static/jquery.js"></script>
      <script type="text/javascript" src="../../../_static/underscore.js"></script>
      <script type="text/javascript" src="../../../_static/doctools.js"></script>
      <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
       
  
    <script type="text/javascript" src="../../../_static/js/theme.js"></script>
  
  
  <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
  <script src="https://cdn.jsdelivr.net/perfect-scrollbar/0.6.14/js/perfect-scrollbar.jquery.min.js"></script>
  <script src="../../../_static/js/paddle_doc_init.js"></script> 

</body>
</html>