attrs.html 11.6 KB
Newer Older
Y
Yu Yang 已提交
1 2 3 4 5 6 7 8
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
9
    <title>Parameter and Extra Layer Attribute &#8212; PaddlePaddle  documentation</title>
Y
Yu Yang 已提交
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
    
    <link rel="stylesheet" href="../../../_static/classic.css" type="text/css" />
    <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../../../',
        VERSION:     '',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </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://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
    <link rel="top" title="PaddlePaddle  documentation" href="../../../index.html" />
Y
Yu Yang 已提交
28
    <link rel="up" title="Model Config Interface" href="index.html" />
Y
Yu Yang 已提交
29
    <link rel="next" title="Use Case" href="../../cmd_argument/use_case.html" />
Y
Yu Yang 已提交
30
    <link rel="prev" title="Base" href="evaluators.html" /> 
Y
Yu Yang 已提交
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
  </head>
  <body role="document">
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../../../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="../../cmd_argument/use_case.html" title="Use Case"
             accesskey="N">next</a> |</li>
        <li class="right" >
Y
Yu Yang 已提交
46
          <a href="evaluators.html" title="Base"
Y
Yu Yang 已提交
47
             accesskey="P">previous</a> |</li>
48 49 50
        <li class="nav-item nav-item-0"><a href="../../../index.html">PaddlePaddle  documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../../index.html" >User Interface</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Model Config Interface</a> &#187;</li> 
Y
Yu Yang 已提交
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="module-paddle.trainer_config_helpers.attrs">
<span id="parameter-and-extra-layer-attribute"></span><h1>Parameter and Extra Layer Attribute<a class="headerlink" href="#module-paddle.trainer_config_helpers.attrs" title="Permalink to this headline"></a></h1>
<dl class="class">
<dt id="paddle.trainer_config_helpers.attrs.ParameterAttribute">
<em class="property">class </em><code class="descclassname">paddle.trainer_config_helpers.attrs.</code><code class="descname">ParameterAttribute</code><span class="sig-paren">(</span><em>name=None</em>, <em>is_static=False</em>, <em>initial_std=None</em>, <em>initial_mean=None</em>, <em>initial_max=None</em>, <em>initial_min=None</em>, <em>l1_rate=None</em>, <em>l2_rate=None</em>, <em>learning_rate=None</em>, <em>momentum=None</em>, <em>sparse_update=False</em><span class="sig-paren">)</span><a class="headerlink" href="#paddle.trainer_config_helpers.attrs.ParameterAttribute" title="Permalink to this definition"></a></dt>
<dd><p>Parameter Attributes object. To fine-tuning network training process, user
can set attribute to control training details, such as l1,l2 rate / learning
rate / how to init param.</p>
<p>NOTE: IT IS A HIGH LEVEL USER INTERFACE.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>is_static</strong> (<em>bool</em>) &#8211; True if this parameter will be fixed while training.</li>
<li><strong>initial_std</strong> (<em>float or None</em>) &#8211; Gauss Random initialization standard deviation.
None if not using Gauss Random initialize parameter.</li>
<li><strong>initial_mean</strong> (<em>float or None</em>) &#8211; Gauss Random initialization mean.
None if not using Gauss Random initialize parameter.</li>
<li><strong>initial_max</strong> (<em>float or None</em>) &#8211; Uniform initialization max value.</li>
<li><strong>initial_min</strong> (<em>float or None</em>) &#8211; Uniform initialization min value.</li>
<li><strong>l1_rate</strong> (<em>float or None</em>) &#8211; the l1 regularization factor</li>
<li><strong>l2_rate</strong> (<em>float or None</em>) &#8211; the l2 regularization factor</li>
<li><strong>learning_rate</strong> (<em>float or None</em>) &#8211; The parameter learning rate. None means 1.
The learning rate when optimize is LEARNING_RATE =
GLOBAL_LEARNING_RATE * PARAMETER_LEARNING_RATE
* SCHEDULER_FACTOR.</li>
<li><strong>momentum</strong> (<em>float or None</em>) &#8211; The parameter momentum. None means use global value.</li>
<li><strong>sparse_update</strong> (<em>bool</em>) &#8211; Enable sparse update for this parameter. It will
enable both local and remote sparse update.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="paddle.trainer_config_helpers.attrs.ParameterAttribute.set_default_parameter_name">
<code class="descname">set_default_parameter_name</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#paddle.trainer_config_helpers.attrs.ParameterAttribute.set_default_parameter_name" title="Permalink to this definition"></a></dt>
<dd><p>Set default parameter name. If parameter not set, then will use default
parameter name.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> (<em>basestring</em>) &#8211; default parameter name.</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="paddle.trainer_config_helpers.attrs.ExtraLayerAttribute">
113
<em class="property">class </em><code class="descclassname">paddle.trainer_config_helpers.attrs.</code><code class="descname">ExtraLayerAttribute</code><span class="sig-paren">(</span><em>error_clipping_threshold=None</em>, <em>drop_rate=None</em>, <em>device=None</em><span class="sig-paren">)</span><a class="headerlink" href="#paddle.trainer_config_helpers.attrs.ExtraLayerAttribute" title="Permalink to this definition"></a></dt>
Y
Yu Yang 已提交
114 115 116 117 118 119 120 121 122 123 124
<dd><p>Some high level layer attributes config. You can set all attributes here,
but some layer doesn&#8217;t support all attributes. If you set an attribute to a
layer that not support this attribute, paddle will print an error and core.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>error_clipping_threshold</strong> (<em>float</em>) &#8211; Error clipping threshold.</li>
<li><strong>drop_rate</strong> (<em>float</em>) &#8211; Dropout rate. Dropout will create a mask on layer output.
The dropout rate is the zero rate of this mask. The
125 126 127 128
details of what dropout is please refer to <a class="reference external" href="https://www.cs.toronto.edu/~hinton/absps/JMLRdropout.pdf">here</a>.</li>
<li><strong>device</strong> (<em>int</em>) &#8211; <p>device ID of layer. device=-1, use CPU. device&gt;0, use GPU.
The details allocation in parallel_nn please refer to <a class="reference external" href="http://www.paddlepaddle.org/doc/ui/cmd_argument/use_case.html#case-2-specify-layers-in-different-devices">here</a>.</p>
</li>
Y
Yu Yang 已提交
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="attribute">
<dt id="paddle.trainer_config_helpers.attrs.ParamAttr">
<code class="descclassname">paddle.trainer_config_helpers.attrs.</code><code class="descname">ParamAttr</code><a class="headerlink" href="#paddle.trainer_config_helpers.attrs.ParamAttr" title="Permalink to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="#paddle.trainer_config_helpers.attrs.ParameterAttribute" title="paddle.trainer_config_helpers.attrs.ParameterAttribute"><code class="xref py py-class docutils literal"><span class="pre">ParameterAttribute</span></code></a></p>
</dd></dl>

<dl class="attribute">
<dt id="paddle.trainer_config_helpers.attrs.ExtraAttr">
<code class="descclassname">paddle.trainer_config_helpers.attrs.</code><code class="descname">ExtraAttr</code><a class="headerlink" href="#paddle.trainer_config_helpers.attrs.ExtraAttr" title="Permalink to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="#paddle.trainer_config_helpers.attrs.ExtraLayerAttribute" title="paddle.trainer_config_helpers.attrs.ExtraLayerAttribute"><code class="xref py py-class docutils literal"><span class="pre">ExtraLayerAttribute</span></code></a></p>
</dd></dl>

</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h4>Previous topic</h4>
  <p class="topless"><a href="evaluators.html"
Y
Yu Yang 已提交
158
                        title="previous chapter">Base</a></p>
Y
Yu Yang 已提交
159 160 161 162 163 164 165 166 167 168 169 170 171
  <h4>Next topic</h4>
  <p class="topless"><a href="../../cmd_argument/use_case.html"
                        title="next chapter">Use Case</a></p>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../../../_sources/ui/api/trainer_config_helpers/attrs.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <form class="search" action="../../../search.html" method="get">
172 173
      <div><input type="text" name="q" /></div>
      <div><input type="submit" value="Go" /></div>
Y
Yu Yang 已提交
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../../../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="../../cmd_argument/use_case.html" title="Use Case"
             >next</a> |</li>
        <li class="right" >
Y
Yu Yang 已提交
196
          <a href="evaluators.html" title="Base"
Y
Yu Yang 已提交
197
             >previous</a> |</li>
198 199 200
        <li class="nav-item nav-item-0"><a href="../../../index.html">PaddlePaddle  documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../../index.html" >User Interface</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="index.html" >Model Config Interface</a> &#187;</li> 
Y
Yu Yang 已提交
201 202 203
      </ul>
    </div>
    <div class="footer" role="contentinfo">
204 205
        &#169; Copyright 2016, PaddlePaddle developers.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
Y
Yu Yang 已提交
206 207 208
    </div>
  </body>
</html>