Modified: incubator/singa/site/trunk/en/docs/optimizer.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/optimizer.html?rev=1857911&r1=1857910&r2=1857911&view=diff ============================================================================== --- incubator/singa/site/trunk/en/docs/optimizer.html (original) +++ incubator/singa/site/trunk/en/docs/optimizer.html Sun Apr 21 13:56:42 2019 @@ -18,15 +18,21 @@ - - + <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> + <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></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="../_static/language_data.js"></script> + + <script type="text/javascript" src="../_static/js/theme.js"></script> - + - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> @@ -44,21 +50,16 @@ } </style> - - - <script src="../_static/js/modernizr.min.js"></script> - </head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> - <div class="wy-side-nav-search"> + <div class="wy-side-nav-search" > @@ -226,33 +227,29 @@ <p>The base python optimizer class.</p> <p>Typically, an optimizer is used as follows:</p> <ol class="arabic simple"> -<li>construct the optimizer</li> -<li>(optional) register each parameter with its specs.</li> -<li>use the optimizer to update parameter values given parameter gradients -and other optional info</li> +<li><p>construct the optimizer</p></li> +<li><p>(optional) register each parameter with its specs.</p></li> +<li><p>use the optimizer to update parameter values given parameter gradients +and other optional info</p></li> </ol> <p>The subclasses should override the apply_with_lr function to do the real parameter udpate.</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>lr</strong> (<em>float</em>) â a constant value for the learning rate</li> -<li><strong>momentum</strong> (<em>float</em>) â a constant value for the momentum value</li> -<li><strong>weight_decay</strong> (<em>float</em>) â the coefficent for L2 regularizer, which is -mutually exclusive with âregularizerâ.</li> -<li><strong>regularizer</strong> â an instance of Regularizer or RegularizerConf; If set, +<dl class="field-list simple"> +<dt class="field-odd">Parameters</dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>lr</strong> (<em>float</em>) â a constant value for the learning rate</p></li> +<li><p><strong>momentum</strong> (<em>float</em>) â a constant value for the momentum value</p></li> +<li><p><strong>weight_decay</strong> (<em>float</em>) â the coefficent for L2 regularizer, which is +mutually exclusive with âregularizerâ.</p></li> +<li><p><strong>regularizer</strong> â an instance of Regularizer or RegularizerConf; If set, regularization would be applied in apply_with_lr(). -Users can also do regularization outside.</li> -<li><strong>constraint</strong> â an instance of Constraint or ConstraintConf; If set, +Users can also do regularization outside.</p></li> +<li><p><strong>constraint</strong> â an instance of Constraint or ConstraintConf; If set, constraint would be applied inside apply_with_lr(). Users can -also apply constraint outside.</li> +also apply constraint outside.</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <dl class="method"> <dt id="singa.optimizer.Optimizer.register"> <code class="descname">register</code><span class="sig-paren">(</span><em>name</em>, <em>specs</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.optimizer.Optimizer.register" title="Permalink to this definition">¶</a></dt> @@ -261,19 +258,15 @@ constraint per param object. Param speci have higher priority than the global ones. If all parameters share the same setting for learning rate, regularizer and constraint, then there is no need to call this function.</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>name</strong> (<em>str</em>) â parameter name</li> -<li><strong>specs</strong> (<em>ParamSpec</em>) â protobuf obj, including regularizer and -constraint, multipliers for learning rate and weight decay.</li> -</ul> -</td> -</tr> -</tbody> -</table> +<dl class="field-list simple"> +<dt class="field-odd">Parameters</dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>name</strong> (<em>str</em>) â parameter name</p></li> +<li><p><strong>specs</strong> (<em>ParamSpec</em>) â protobuf obj, including regularizer and +constraint, multipliers for learning rate and weight decay.</p></li> +</ul> +</dd> +</dl> </dd></dl> <dl class="method"> @@ -282,24 +275,20 @@ constraint, multipliers for learning rat <dd><p>Apply regularization and constraint if available.</p> <p>If there are both global regularizer (constraint) and param specific regularizer (constraint), it would use the param specific one.</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 simple"> -<li><strong>epoch</strong> (<em>int</em>) â training epoch ID</li> -<li><strong>value</strong> (<a class="reference internal" href="tensor.html#singa.tensor.Tensor" title="singa.tensor.Tensor"><em>Tensor</em></a>) â parameter value Tensor</li> -<li><strong>grad</strong> (<a class="reference internal" href="tensor.html#singa.tensor.Tensor" title="singa.tensor.Tensor"><em>Tensor</em></a>) â parameter gradient Tensor</li> -<li><strong>name</strong> (<em>string</em>) â to get parameter specific regularizer or constraint</li> -<li><strong>step</strong> (<em>int</em>) â iteration ID within one epoch</li> -</ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the updated gradient Tensor</p> -</td> -</tr> -</tbody> -</table> +<dl class="field-list simple"> +<dt class="field-odd">Parameters</dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>epoch</strong> (<em>int</em>) â training epoch ID</p></li> +<li><p><strong>value</strong> (<a class="reference internal" href="tensor.html#singa.tensor.Tensor" title="singa.tensor.Tensor"><em>Tensor</em></a>) â parameter value Tensor</p></li> +<li><p><strong>grad</strong> (<a class="reference internal" href="tensor.html#singa.tensor.Tensor" title="singa.tensor.Tensor"><em>Tensor</em></a>) â parameter gradient Tensor</p></li> +<li><p><strong>name</strong> (<em>string</em>) â to get parameter specific regularizer or constraint</p></li> +<li><p><strong>step</strong> (<em>int</em>) â iteration ID within one epoch</p></li> +</ul> +</dd> +<dt class="field-even">Returns</dt> +<dd class="field-even"><p>the updated gradient Tensor</p> +</dd> +</dl> </dd></dl> <dl class="method"> @@ -309,26 +298,22 @@ regularizer (constraint), it would use t empty.</p> <p>The subclass optimizer must override this function. This function do nothing if the grad is empty.</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 simple"> -<li><strong>epoch</strong> (<em>int</em>) â training epoch ID</li> -<li><strong>lr</strong> (<em>float</em>) â learning rate</li> -<li><strong>grad</strong> (<a class="reference internal" href="tensor.html#singa.tensor.Tensor" title="singa.tensor.Tensor"><em>Tensor</em></a>) â parameter gradient</li> -<li><strong>value</strong> (<em>Tesnor</em>) â parameter value</li> -<li><strong>name</strong> (<em>string</em>) â paramter name to index parameter specific -updating rules (including regularizer and constraint)</li> -<li><strong>step</strong> (<em>int</em>) â iteration ID within one epoch</li> -</ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">updated parameter value</p> -</td> -</tr> -</tbody> -</table> +<dl class="field-list simple"> +<dt class="field-odd">Parameters</dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>epoch</strong> (<em>int</em>) â training epoch ID</p></li> +<li><p><strong>lr</strong> (<em>float</em>) â learning rate</p></li> +<li><p><strong>grad</strong> (<a class="reference internal" href="tensor.html#singa.tensor.Tensor" title="singa.tensor.Tensor"><em>Tensor</em></a>) â parameter gradient</p></li> +<li><p><strong>value</strong> (<em>Tesnor</em>) â parameter value</p></li> +<li><p><strong>name</strong> (<em>string</em>) â paramter name to index parameter specific +updating rules (including regularizer and constraint)</p></li> +<li><p><strong>step</strong> (<em>int</em>) â iteration ID within one epoch</p></li> +</ul> +</dd> +<dt class="field-even">Returns</dt> +<dd class="field-even"><p>updated parameter value</p> +</dd> +</dl> </dd></dl> <dl class="method"> @@ -336,25 +321,21 @@ updating rules (including regularizer an <code class="descname">apply</code><span class="sig-paren">(</span><em>epoch</em>, <em>grad</em>, <em>value</em>, <em>name=None</em>, <em>step=-1</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.optimizer.Optimizer.apply" title="Permalink to this definition">¶</a></dt> <dd><p>Do update assuming the learning rate generator is set.</p> <p>The subclass optimizer does not need to override this function.</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 simple"> -<li><strong>epoch</strong> (<em>int</em>) â training epoch ID</li> -<li><strong>grad</strong> (<a class="reference internal" href="tensor.html#singa.tensor.Tensor" title="singa.tensor.Tensor"><em>Tensor</em></a>) â parameter gradient</li> -<li><strong>value</strong> (<em>Tesnor</em>) â parameter value</li> -<li><strong>name</strong> (<em>string</em>) â paramter name to retrieval parameter specific -updating rules (including regularizer and constraint)</li> -<li><strong>step</strong> (<em>int</em>) â training iteration ID within one epoch</li> -</ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">updated parameter value</p> -</td> -</tr> -</tbody> -</table> +<dl class="field-list simple"> +<dt class="field-odd">Parameters</dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>epoch</strong> (<em>int</em>) â training epoch ID</p></li> +<li><p><strong>grad</strong> (<a class="reference internal" href="tensor.html#singa.tensor.Tensor" title="singa.tensor.Tensor"><em>Tensor</em></a>) â parameter gradient</p></li> +<li><p><strong>value</strong> (<em>Tesnor</em>) â parameter value</p></li> +<li><p><strong>name</strong> (<em>string</em>) â paramter name to retrieval parameter specific +updating rules (including regularizer and constraint)</p></li> +<li><p><strong>step</strong> (<em>int</em>) â training iteration ID within one epoch</p></li> +</ul> +</dd> +<dt class="field-even">Returns</dt> +<dd class="field-even"><p>updated parameter value</p> +</dd> +</dl> </dd></dl> </dd></dl> @@ -372,26 +353,22 @@ updating rules (including regularizer an empty.</p> <p>The subclass optimizer must override this function. This function do nothing if the grad is empty.</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 simple"> -<li><strong>epoch</strong> (<em>int</em>) â training epoch ID</li> -<li><strong>lr</strong> (<em>float</em>) â learning rate</li> -<li><strong>grad</strong> (<a class="reference internal" href="tensor.html#singa.tensor.Tensor" title="singa.tensor.Tensor"><em>Tensor</em></a>) â parameter gradient</li> -<li><strong>value</strong> (<em>Tesnor</em>) â parameter value</li> -<li><strong>name</strong> (<em>string</em>) â paramter name to index parameter specific -updating rules (including regularizer and constraint)</li> -<li><strong>step</strong> (<em>int</em>) â iteration ID within one epoch</li> -</ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">updated parameter value</p> -</td> -</tr> -</tbody> -</table> +<dl class="field-list simple"> +<dt class="field-odd">Parameters</dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>epoch</strong> (<em>int</em>) â training epoch ID</p></li> +<li><p><strong>lr</strong> (<em>float</em>) â learning rate</p></li> +<li><p><strong>grad</strong> (<a class="reference internal" href="tensor.html#singa.tensor.Tensor" title="singa.tensor.Tensor"><em>Tensor</em></a>) â parameter gradient</p></li> +<li><p><strong>value</strong> (<em>Tesnor</em>) â parameter value</p></li> +<li><p><strong>name</strong> (<em>string</em>) â paramter name to index parameter specific +updating rules (including regularizer and constraint)</p></li> +<li><p><strong>step</strong> (<em>int</em>) â iteration ID within one epoch</p></li> +</ul> +</dd> +<dt class="field-even">Returns</dt> +<dd class="field-even"><p>updated parameter value</p> +</dd> +</dl> </dd></dl> </dd></dl> @@ -409,26 +386,22 @@ updating rules (including regularizer an empty.</p> <p>The subclass optimizer must override this function. This function do nothing if the grad is empty.</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 simple"> -<li><strong>epoch</strong> (<em>int</em>) â training epoch ID</li> -<li><strong>lr</strong> (<em>float</em>) â learning rate</li> -<li><strong>grad</strong> (<a class="reference internal" href="tensor.html#singa.tensor.Tensor" title="singa.tensor.Tensor"><em>Tensor</em></a>) â parameter gradient</li> -<li><strong>value</strong> (<em>Tesnor</em>) â parameter value</li> -<li><strong>name</strong> (<em>string</em>) â paramter name to index parameter specific -updating rules (including regularizer and constraint)</li> -<li><strong>step</strong> (<em>int</em>) â iteration ID within one epoch</li> -</ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">updated parameter value</p> -</td> -</tr> -</tbody> -</table> +<dl class="field-list simple"> +<dt class="field-odd">Parameters</dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>epoch</strong> (<em>int</em>) â training epoch ID</p></li> +<li><p><strong>lr</strong> (<em>float</em>) â learning rate</p></li> +<li><p><strong>grad</strong> (<a class="reference internal" href="tensor.html#singa.tensor.Tensor" title="singa.tensor.Tensor"><em>Tensor</em></a>) â parameter gradient</p></li> +<li><p><strong>value</strong> (<em>Tesnor</em>) â parameter value</p></li> +<li><p><strong>name</strong> (<em>string</em>) â paramter name to index parameter specific +updating rules (including regularizer and constraint)</p></li> +<li><p><strong>step</strong> (<em>int</em>) â iteration ID within one epoch</p></li> +</ul> +</dd> +<dt class="field-even">Returns</dt> +<dd class="field-even"><p>updated parameter value</p> +</dd> +</dl> </dd></dl> </dd></dl> @@ -439,18 +412,14 @@ updating rules (including regularizer an <dd><p>Bases: <a class="reference internal" href="#singa.optimizer.Optimizer" title="singa.optimizer.Optimizer"><code class="xref py py-class docutils literal notranslate"><span class="pre">singa.optimizer.Optimizer</span></code></a></p> <p>RMSProp optimizer.</p> <p>See the base Optimizer for all constructor args.</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>rho</strong> (<em>float</em>) â float within [0, 1]</li> -<li><strong>epsilon</strong> (<em>float</em>) â small value for preventing numeric error</li> -</ul> -</td> -</tr> -</tbody> -</table> +<dl class="field-list simple"> +<dt class="field-odd">Parameters</dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>rho</strong> (<em>float</em>) â float within [0, 1]</p></li> +<li><p><strong>epsilon</strong> (<em>float</em>) â small value for preventing numeric error</p></li> +</ul> +</dd> +</dl> <dl class="method"> <dt id="singa.optimizer.RMSProp.apply_with_lr"> <code class="descname">apply_with_lr</code><span class="sig-paren">(</span><em>epoch</em>, <em>lr</em>, <em>grad</em>, <em>value</em>, <em>name</em>, <em>step=-1</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.optimizer.RMSProp.apply_with_lr" title="Permalink to this definition">¶</a></dt> @@ -458,26 +427,22 @@ updating rules (including regularizer an empty.</p> <p>The subclass optimizer must override this function. This function do nothing if the grad is empty.</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 simple"> -<li><strong>epoch</strong> (<em>int</em>) â training epoch ID</li> -<li><strong>lr</strong> (<em>float</em>) â learning rate</li> -<li><strong>grad</strong> (<a class="reference internal" href="tensor.html#singa.tensor.Tensor" title="singa.tensor.Tensor"><em>Tensor</em></a>) â parameter gradient</li> -<li><strong>value</strong> (<em>Tesnor</em>) â parameter value</li> -<li><strong>name</strong> (<em>string</em>) â paramter name to index parameter specific -updating rules (including regularizer and constraint)</li> -<li><strong>step</strong> (<em>int</em>) â iteration ID within one epoch</li> -</ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">updated parameter value</p> -</td> -</tr> -</tbody> -</table> +<dl class="field-list simple"> +<dt class="field-odd">Parameters</dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>epoch</strong> (<em>int</em>) â training epoch ID</p></li> +<li><p><strong>lr</strong> (<em>float</em>) â learning rate</p></li> +<li><p><strong>grad</strong> (<a class="reference internal" href="tensor.html#singa.tensor.Tensor" title="singa.tensor.Tensor"><em>Tensor</em></a>) â parameter gradient</p></li> +<li><p><strong>value</strong> (<em>Tesnor</em>) â parameter value</p></li> +<li><p><strong>name</strong> (<em>string</em>) â paramter name to index parameter specific +updating rules (including regularizer and constraint)</p></li> +<li><p><strong>step</strong> (<em>int</em>) â iteration ID within one epoch</p></li> +</ul> +</dd> +<dt class="field-even">Returns</dt> +<dd class="field-even"><p>updated parameter value</p> +</dd> +</dl> </dd></dl> </dd></dl> @@ -488,14 +453,11 @@ updating rules (including regularizer an <dd><p>Bases: <a class="reference internal" href="#singa.optimizer.Optimizer" title="singa.optimizer.Optimizer"><code class="xref py py-class docutils literal notranslate"><span class="pre">singa.optimizer.Optimizer</span></code></a></p> <p>AdaGrad optimizer.</p> <p>See the base Optimizer for all constructor args.</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>epsilon</strong> (<em>float</em>) â small number for preventing numeric error.</td> -</tr> -</tbody> -</table> +<dl class="field-list simple"> +<dt class="field-odd">Parameters</dt> +<dd class="field-odd"><p><strong>epsilon</strong> (<em>float</em>) â small number for preventing numeric error.</p> +</dd> +</dl> <dl class="method"> <dt id="singa.optimizer.AdaGrad.apply_with_lr"> <code class="descname">apply_with_lr</code><span class="sig-paren">(</span><em>epoch</em>, <em>lr</em>, <em>grad</em>, <em>value</em>, <em>name</em>, <em>step=-1</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.optimizer.AdaGrad.apply_with_lr" title="Permalink to this definition">¶</a></dt> @@ -503,26 +465,22 @@ updating rules (including regularizer an empty.</p> <p>The subclass optimizer must override this function. This function do nothing if the grad is empty.</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 simple"> -<li><strong>epoch</strong> (<em>int</em>) â training epoch ID</li> -<li><strong>lr</strong> (<em>float</em>) â learning rate</li> -<li><strong>grad</strong> (<a class="reference internal" href="tensor.html#singa.tensor.Tensor" title="singa.tensor.Tensor"><em>Tensor</em></a>) â parameter gradient</li> -<li><strong>value</strong> (<em>Tesnor</em>) â parameter value</li> -<li><strong>name</strong> (<em>string</em>) â paramter name to index parameter specific -updating rules (including regularizer and constraint)</li> -<li><strong>step</strong> (<em>int</em>) â iteration ID within one epoch</li> -</ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">updated parameter value</p> -</td> -</tr> -</tbody> -</table> +<dl class="field-list simple"> +<dt class="field-odd">Parameters</dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>epoch</strong> (<em>int</em>) â training epoch ID</p></li> +<li><p><strong>lr</strong> (<em>float</em>) â learning rate</p></li> +<li><p><strong>grad</strong> (<a class="reference internal" href="tensor.html#singa.tensor.Tensor" title="singa.tensor.Tensor"><em>Tensor</em></a>) â parameter gradient</p></li> +<li><p><strong>value</strong> (<em>Tesnor</em>) â parameter value</p></li> +<li><p><strong>name</strong> (<em>string</em>) â paramter name to index parameter specific +updating rules (including regularizer and constraint)</p></li> +<li><p><strong>step</strong> (<em>int</em>) â iteration ID within one epoch</p></li> +</ul> +</dd> +<dt class="field-even">Returns</dt> +<dd class="field-even"><p>updated parameter value</p> +</dd> +</dl> </dd></dl> </dd></dl> @@ -533,31 +491,24 @@ updating rules (including regularizer an <dd><p>Bases: <a class="reference internal" href="#singa.optimizer.Optimizer" title="singa.optimizer.Optimizer"><code class="xref py py-class docutils literal notranslate"><span class="pre">singa.optimizer.Optimizer</span></code></a></p> <p>Adam optimizer.</p> <p>See the base Optimizer for all constructor args.</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>beta_1</strong> (<em>float</em>) â coefficient of momentum</li> -<li><strong>beta_2</strong> (<em>float</em>) â coefficient of aggregated squared gradient</li> -<li><strong>epsilon</strong> (<em>float</em>) â small value for preventing numeric error</li> -</ul> -</td> -</tr> -</tbody> -</table> +<dl class="field-list simple"> +<dt class="field-odd">Parameters</dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>beta_1</strong> (<em>float</em>) â coefficient of momentum</p></li> +<li><p><strong>beta_2</strong> (<em>float</em>) â coefficient of aggregated squared gradient</p></li> +<li><p><strong>epsilon</strong> (<em>float</em>) â small value for preventing numeric error</p></li> +</ul> +</dd> +</dl> <dl class="method"> <dt id="singa.optimizer.Adam.apply_with_lr"> <code class="descname">apply_with_lr</code><span class="sig-paren">(</span><em>epoch</em>, <em>lr</em>, <em>grad</em>, <em>value</em>, <em>name</em>, <em>step</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.optimizer.Adam.apply_with_lr" title="Permalink to this definition">¶</a></dt> <dd><p>Update one parameter object.</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>step</strong> (<em>int</em>) â the accumulated training iterations, not the iteration ID</td> -</tr> -</tbody> -</table> +<dl class="field-list simple"> +<dt class="field-odd">Parameters</dt> +<dd class="field-odd"><p><strong>step</strong> (<em>int</em>) â the accumulated training iterations, not the iteration ID</p> +</dd> +</dl> </dd></dl> </dd></dl> @@ -579,14 +530,11 @@ updating rules (including regularizer an <em class="property">class </em><code class="descclassname">singa.optimizer.</code><code class="descname">CppRegularizer</code><span class="sig-paren">(</span><em>conf</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.optimizer.CppRegularizer" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="#singa.optimizer.Regularizer" title="singa.optimizer.Regularizer"><code class="xref py py-class docutils literal notranslate"><span class="pre">singa.optimizer.Regularizer</span></code></a></p> <p>Wrapper for regularizer implemented using C++.</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>conf</strong> (<em>RegularizerConf</em>) â protobuf message for the configuration.</td> -</tr> -</tbody> -</table> +<dl class="field-list simple"> +<dt class="field-odd">Parameters</dt> +<dd class="field-odd"><p><strong>conf</strong> (<em>RegularizerConf</em>) â protobuf message for the configuration.</p> +</dd> +</dl> <dl class="method"> <dt id="singa.optimizer.CppRegularizer.apply"> <code class="descname">apply</code><span class="sig-paren">(</span><em>epoch</em>, <em>value</em>, <em>grad</em>, <em>step=-1</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.optimizer.CppRegularizer.apply" title="Permalink to this definition">¶</a></dt> @@ -599,14 +547,11 @@ updating rules (including regularizer an <em class="property">class </em><code class="descclassname">singa.optimizer.</code><code class="descname">L2Regularizer</code><span class="sig-paren">(</span><em>coefficient</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.optimizer.L2Regularizer" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="#singa.optimizer.Regularizer" title="singa.optimizer.Regularizer"><code class="xref py py-class docutils literal notranslate"><span class="pre">singa.optimizer.Regularizer</span></code></a></p> <p>L2 regularization</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>coefficient</strong> (<em>float</em>) â regularization coefficient.</td> -</tr> -</tbody> -</table> +<dl class="field-list simple"> +<dt class="field-odd">Parameters</dt> +<dd class="field-odd"><p><strong>coefficient</strong> (<em>float</em>) â regularization coefficient.</p> +</dd> +</dl> <dl class="method"> <dt id="singa.optimizer.L2Regularizer.apply"> <code class="descname">apply</code><span class="sig-paren">(</span><em>epoch</em>, <em>value</em>, <em>grad</em>, <em>step=-1</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.optimizer.L2Regularizer.apply" title="Permalink to this definition">¶</a></dt> @@ -631,14 +576,11 @@ updating rules (including regularizer an <em class="property">class </em><code class="descclassname">singa.optimizer.</code><code class="descname">CppConstraint</code><span class="sig-paren">(</span><em>conf</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.optimizer.CppConstraint" title="Permalink to this definition">¶</a></dt> <dd><p>Bases: <a class="reference internal" href="#singa.optimizer.Constraint" title="singa.optimizer.Constraint"><code class="xref py py-class docutils literal notranslate"><span class="pre">singa.optimizer.Constraint</span></code></a></p> <p>Wrapper for constraints implemented using C++.</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>conf</strong> (<em>ConstraintConf</em>) â protobuf message for the configuration.</td> -</tr> -</tbody> -</table> +<dl class="field-list simple"> +<dt class="field-odd">Parameters</dt> +<dd class="field-odd"><p><strong>conf</strong> (<em>ConstraintConf</em>) â protobuf message for the configuration.</p> +</dd> +</dl> <dl class="method"> <dt id="singa.optimizer.CppConstraint.apply"> <code class="descname">apply</code><span class="sig-paren">(</span><em>epoch</em>, <em>value</em>, <em>grad</em>, <em>step=-1</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.optimizer.CppConstraint.apply" title="Permalink to this definition">¶</a></dt> @@ -671,7 +613,7 @@ updating rules (including regularizer an <a href="autograd.html" class="btn btn-neutral float-right" title="Autograd in Singa" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="metric.html" class="btn btn-neutral" title="Metric" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="metric.html" class="btn btn-neutral float-left" title="Metric" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> @@ -680,7 +622,7 @@ updating rules (including regularizer an <div role="contentinfo"> <p> - © Copyright 2019 The Apache Software Foundation. All rights reserved. Apache SINGA, Apache, the Apache feather logo, and the Apache SINGA project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.. + © Copyright 2019 The Apache Software Foundation. All rights reserved. Apache SINGA, Apache, the Apache feather logo, and the Apache SINGA project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners. </p> </div> @@ -697,36 +639,17 @@ updating rules (including regularizer an - - - <script type="text/javascript"> - var DOCUMENTATION_OPTIONS = { - URL_ROOT:'../', - VERSION:'1.1.0', - LANGUAGE:'None', - 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="../_static/js/theme.js"></script> - - <script type="text/javascript"> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> + + + + + <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> <span class="rst-current-version" data-toggle="rst-current-version"> <span class="fa fa-book"> incubator-singa </span>
Modified: incubator/singa/site/trunk/en/docs/security.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/security.html?rev=1857911&r1=1857910&r2=1857911&view=diff ============================================================================== --- incubator/singa/site/trunk/en/docs/security.html (original) +++ incubator/singa/site/trunk/en/docs/security.html Sun Apr 21 13:56:42 2019 @@ -18,20 +18,26 @@ - - + <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> + <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></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="../_static/language_data.js"></script> + + <script type="text/javascript" src="../_static/js/theme.js"></script> - + - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="next" title="Download SINGA" href="../downloads.html" /> - <link rel="prev" title="â>" href="model_zoo/imagenet/vgg/README.html" /> + <link rel="prev" title="name: VGG models on ImageNet SINGA version: 1.1.1 SINGA commit: license: https://github.com/pytorch/vision/blob/master/torchvision/models/vgg.py"; href="model_zoo/imagenet/vgg/README.html" /> <link href="../_static/style.css" rel="stylesheet" type="text/css"> <!--link href="../_static/fontawesome-all.min.css" rel="stylesheet" type="text/css"--> <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.13/css/all.css"; integrity="sha384-DNOHZ68U8hZfKXOrtjWvjxusGo9WQnrNx2sqG0tfsghAvtVlRW3tvkXWZh58N9jp" crossorigin="anonymous"> @@ -44,21 +50,16 @@ } </style> - - - <script src="../_static/js/modernizr.min.js"></script> - </head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> - <div class="wy-side-nav-search"> + <div class="wy-side-nav-search" > @@ -219,7 +220,7 @@ <a href="../downloads.html" class="btn btn-neutral float-right" title="Download SINGA" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="model_zoo/imagenet/vgg/README.html" class="btn btn-neutral" title="â>" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="model_zoo/imagenet/vgg/README.html" class="btn btn-neutral float-left" title="name: VGG models on ImageNet SINGA version: 1.1.1 SINGA commit: license: https://github.com/pytorch/vision/blob/master/torchvision/models/vgg.py"; accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> @@ -228,7 +229,7 @@ <div role="contentinfo"> <p> - © Copyright 2019 The Apache Software Foundation. All rights reserved. Apache SINGA, Apache, the Apache feather logo, and the Apache SINGA project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.. + © Copyright 2019 The Apache Software Foundation. All rights reserved. Apache SINGA, Apache, the Apache feather logo, and the Apache SINGA project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners. </p> </div> @@ -245,36 +246,17 @@ - - - <script type="text/javascript"> - var DOCUMENTATION_OPTIONS = { - URL_ROOT:'../', - VERSION:'1.1.0', - LANGUAGE:'None', - 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="../_static/js/theme.js"></script> - - <script type="text/javascript"> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> + + + + + <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> <span class="rst-current-version" data-toggle="rst-current-version"> <span class="fa fa-book"> incubator-singa </span> Modified: incubator/singa/site/trunk/en/docs/snapshot.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/snapshot.html?rev=1857911&r1=1857910&r2=1857911&view=diff ============================================================================== --- incubator/singa/site/trunk/en/docs/snapshot.html (original) +++ incubator/singa/site/trunk/en/docs/snapshot.html Sun Apr 21 13:56:42 2019 @@ -18,15 +18,21 @@ - - + <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> + <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></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="../_static/language_data.js"></script> + + <script type="text/javascript" src="../_static/js/theme.js"></script> - + - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> @@ -44,21 +50,16 @@ } </style> - - - <script src="../_static/js/modernizr.min.js"></script> - </head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> - <div class="wy-side-nav-search"> + <div class="wy-side-nav-search" > @@ -224,32 +225,25 @@ <dt id="singa.snapshot.Snapshot.read"> <code class="descname">read</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#singa.snapshot.Snapshot.read" title="Permalink to this definition">¶</a></dt> <dd><p>Call read method to load all (param_name, param_val)</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">Returns:</th><td class="field-body">a dict of (parameter name, parameter Tensor)</td> -</tr> -</tbody> -</table> +<dl class="field-list simple"> +<dt class="field-odd">Returns</dt> +<dd class="field-odd"><p>a dict of (parameter name, parameter Tensor)</p> +</dd> +</dl> </dd></dl> <dl class="method"> <dt id="singa.snapshot.Snapshot.write"> <code class="descname">write</code><span class="sig-paren">(</span><em>param_name</em>, <em>param_val</em><span class="sig-paren">)</span><a class="headerlink" href="#singa.snapshot.Snapshot.write" title="Permalink to this definition">¶</a></dt> <dd><p>Call Write method to write a parameter</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>param_name</strong> (<em>string</em>) â name of the parameter</li> -<li><strong>param_val</strong> (<a class="reference internal" href="tensor.html#singa.tensor.Tensor" title="singa.tensor.Tensor"><em>Tensor</em></a>) â value tensor of the parameter</li> +<dl class="field-list simple"> +<dt class="field-odd">Parameters</dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>param_name</strong> (<em>string</em>) â name of the parameter</p></li> +<li><p><strong>param_val</strong> (<a class="reference internal" href="tensor.html#singa.tensor.Tensor" title="singa.tensor.Tensor"><em>Tensor</em></a>) â value tensor of the parameter</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> </dd></dl> </dd></dl> @@ -267,7 +261,7 @@ <a href="converter.html" class="btn btn-neutral float-right" title="Caffe Converter" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="image_tool.html" class="btn btn-neutral" title="Image Tool" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="image_tool.html" class="btn btn-neutral float-left" title="Image Tool" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> @@ -276,7 +270,7 @@ <div role="contentinfo"> <p> - © Copyright 2019 The Apache Software Foundation. All rights reserved. Apache SINGA, Apache, the Apache feather logo, and the Apache SINGA project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.. + © Copyright 2019 The Apache Software Foundation. All rights reserved. Apache SINGA, Apache, the Apache feather logo, and the Apache SINGA project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners. </p> </div> @@ -293,36 +287,17 @@ - - - <script type="text/javascript"> - var DOCUMENTATION_OPTIONS = { - URL_ROOT:'../', - VERSION:'1.1.0', - LANGUAGE:'None', - 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="../_static/js/theme.js"></script> - - <script type="text/javascript"> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> + + + + + <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> <span class="rst-current-version" data-toggle="rst-current-version"> <span class="fa fa-book"> incubator-singa </span> Modified: incubator/singa/site/trunk/en/docs/software_stack.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/en/docs/software_stack.html?rev=1857911&r1=1857910&r2=1857911&view=diff ============================================================================== --- incubator/singa/site/trunk/en/docs/software_stack.html (original) +++ incubator/singa/site/trunk/en/docs/software_stack.html Sun Apr 21 13:56:42 2019 @@ -18,15 +18,21 @@ - - + <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> + <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></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="../_static/language_data.js"></script> + + <script type="text/javascript" src="../_static/js/theme.js"></script> - + - <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> @@ -44,21 +50,16 @@ } </style> - - - <script src="../_static/js/modernizr.min.js"></script> - </head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> - <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> - <div class="wy-side-nav-search"> + <div class="wy-side-nav-search" > @@ -214,19 +215,18 @@ regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">www</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">licenses</span><span class="o">/</span><span class="n">LICENSE</span><span class="o">-</span><span class="mf">2.0</span> + with the License. You may obtain a copy of the License at -<span class="n">Unless</span> <span class="n">required</span> <span class="n">by</span> <span class="n">applicable</span> <span class="n">law</span> <span class="ow">or</span> <span class="n">agreed</span> <span class="n">to</span> <span class="ow">in</span> <span class="n">writing</span><span class="p">,</span> -<span class="n">software</span> <span class="n">distributed</span> <span class="n">under</span> <span class="n">the</span> <span class="n">License</span> <span class="ow">is</span> <span class="n">distributed</span> <span class="n">on</span> <span class="n">an</span> -<span class="s2">"AS IS"</span> <span class="n">BASIS</span><span class="p">,</span> <span class="n">WITHOUT</span> <span class="n">WARRANTIES</span> <span class="n">OR</span> <span class="n">CONDITIONS</span> <span class="n">OF</span> <span class="n">ANY</span> -<span class="n">KIND</span><span class="p">,</span> <span class="n">either</span> <span class="n">express</span> <span class="ow">or</span> <span class="n">implied</span><span class="o">.</span> <span class="n">See</span> <span class="n">the</span> <span class="n">License</span> <span class="k">for</span> <span class="n">the</span> -<span class="n">specific</span> <span class="n">language</span> <span class="n">governing</span> <span class="n">permissions</span> <span class="ow">and</span> <span class="n">limitations</span> -<span class="n">under</span> <span class="n">the</span> <span class="n">License</span><span class="o">.</span> -</pre></div> -</div> -<p>â></p> -<div class="section" id="software-stack"> -<span id="software-stack"></span><h1>Software Stack<a class="headerlink" href="#software-stack" title="Permalink to this headline">¶</a></h1> + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--><div class="section" id="software-stack"> +<h1>Software Stack<a class="headerlink" href="#software-stack" title="Permalink to this headline">¶</a></h1> <p>SINGAâs software stack includes three major components, namely, core, IO and model. Figure 1 illustrates these components together with the hardware. The core component provides memory management and tensor operations; @@ -234,11 +234,10 @@ IO has classes for reading (and writing) model component provides data structures and algorithms for machine learning models, e.g., layers for neural network models, optimizers/initializer/metric/loss for general machine learning models.</p> -<p><img src="../_static/images/singav1-sw.png" align="center" width="500px"/> +<img src="../_static/images/singav1-sw.png" align="center" width="500px"/> <br/> -<span><strong>Figure 1 - SINGA V1 software stack.</strong></span></p> -<div class="section" id="core"> -<span id="core"></span><h2>Core<a class="headerlink" href="#core" title="Permalink to this headline">¶</a></h2> +<span><strong>Figure 1 - SINGA V1 software stack.</strong></span><div class="section" id="core"> +<h2>Core<a class="headerlink" href="#core" title="Permalink to this headline">¶</a></h2> <p><a class="reference external" href="tensor.html">Tensor</a> and <a class="reference external" href="device.html">Device</a> are two core abstractions in SINGA. Tensor class represents a multi-dimensional array, which stores model variables and provides linear algebra operations for machine learning @@ -250,19 +249,19 @@ tensor operations on its execution units <p>Depending on the hardware and the programming language, SINGA have implemented the following specific device classes:</p> <ul class="simple"> -<li><strong>CudaGPU</strong> represents an Nvidia GPU card. The execution units are the CUDA streams.</li> -<li><strong>CppCPU</strong> represents a normal CPU. The execution units are the CPU threads.</li> -<li><strong>OpenclGPU</strong> represents normal GPU card from both Nvidia and AMD. +<li><p><strong>CudaGPU</strong> represents an Nvidia GPU card. The execution units are the CUDA streams.</p></li> +<li><p><strong>CppCPU</strong> represents a normal CPU. The execution units are the CPU threads.</p></li> +<li><p><strong>OpenclGPU</strong> represents normal GPU card from both Nvidia and AMD. The execution units are the CommandQueues. Given that OpenCL is compatible with many hardware devices, e.g. FPGA and ARM, the OpenclGPU has the potential to be -extended for other devices.</li> +extended for other devices.</p></li> </ul> <p>Different types of devices use different programming languages to write the kernel functions for tensor operations,</p> <ul class="simple"> -<li>CppMath (tensor_math_cpp.h) implements the tensor operations using Cpp for CppCPU</li> -<li>CudaMath (tensor_math_cuda.h) implements the tensor operations using CUDA for CudaGPU</li> -<li>OpenclMath (tensor_math_opencl.h) implements the tensor operations using OpenCL for OpenclGPU</li> +<li><p>CppMath (tensor_math_cpp.h) implements the tensor operations using Cpp for CppCPU</p></li> +<li><p>CudaMath (tensor_math_cuda.h) implements the tensor operations using CUDA for CudaGPU</p></li> +<li><p>OpenclMath (tensor_math_opencl.h) implements the tensor operations using OpenCL for OpenclGPU</p></li> </ul> <p>In addition, different types of data, such as float32 and float16, could be supported by adding the corresponding tensor functions.</p> @@ -282,35 +281,35 @@ manages both operation execution and mem would be described in the <a class="reference external" href="device.html">Device page</a>.</p> </div> <div class="section" id="model"> -<span id="model"></span><h2>Model<a class="headerlink" href="#model" title="Permalink to this headline">¶</a></h2> +<h2>Model<a class="headerlink" href="#model" title="Permalink to this headline">¶</a></h2> <p>On top of the Tensor and Device abstractions, SINGA provides some higher level classes for machine learning modules.</p> <ul class="simple"> -<li><a class="reference external" href="layer.html">Layer</a> and its subclasses are specific for neural networks. Every layer provides +<li><p><a class="reference external" href="layer.html">Layer</a> and its subclasses are specific for neural networks. Every layer provides functions for forward propagating features and backward propagating gradients w.r.t the training loss functions. They wraps the complex layer operations so that users can easily create neural nets -by connecting a set of layers.</li> -<li><a class="reference external" href="initializer.html">Initializer</a> and its subclasses provide variant methods of initializing -model parameters (stored in Tensor instances), following Uniform, Gaussian, etc.</li> -<li><a class="reference external" href="loss.html">Loss</a> and its subclasses defines the training objective loss functions. +by connecting a set of layers.</p></li> +<li><p><a class="reference external" href="initializer.html">Initializer</a> and its subclasses provide variant methods of initializing +model parameters (stored in Tensor instances), following Uniform, Gaussian, etc.</p></li> +<li><p><a class="reference external" href="loss.html">Loss</a> and its subclasses defines the training objective loss functions. Both functions of computing the loss values and computing the gradient of the prediction w.r.t the -objective loss are implemented. Example loss functions include squared error and cross entropy.</li> -<li><a class="reference external" href="metric.html">Metric</a> and its subclasses provide the function to measure the -performance of the model, e.g., the accuracy.</li> -<li><a class="reference external" href="optimizer.html">Optimizer</a> and its subclasses implement the methods for updating -model parameter values using parameter gradients, including SGD, AdaGrad, RMSProp etc.</li> +objective loss are implemented. Example loss functions include squared error and cross entropy.</p></li> +<li><p><a class="reference external" href="metric.html">Metric</a> and its subclasses provide the function to measure the +performance of the model, e.g., the accuracy.</p></li> +<li><p><a class="reference external" href="optimizer.html">Optimizer</a> and its subclasses implement the methods for updating +model parameter values using parameter gradients, including SGD, AdaGrad, RMSProp etc.</p></li> </ul> </div> <div class="section" id="io"> -<span id="io"></span><h2>IO<a class="headerlink" href="#io" title="Permalink to this headline">¶</a></h2> +<h2>IO<a class="headerlink" href="#io" title="Permalink to this headline">¶</a></h2> <p>The IO module consists of classes for data loading, data preprocessing and message passing.</p> <ul class="simple"> -<li>Reader and its subclasses load string records from disk files</li> -<li>Writer and its subclasses write string records to disk files</li> -<li>Encoder and its subclasses encode Tensor instances into string records</li> -<li>Decoder and its subclasses decodes string records into Tensor instances</li> -<li>Endpoint represents a communication endpoint which provides functions for passing messages to each other.</li> -<li>Message represents communication messages between Endpoint instances. It carries both meta data and payload.</li> +<li><p>Reader and its subclasses load string records from disk files</p></li> +<li><p>Writer and its subclasses write string records to disk files</p></li> +<li><p>Encoder and its subclasses encode Tensor instances into string records</p></li> +<li><p>Decoder and its subclasses decodes string records into Tensor instances</p></li> +<li><p>Endpoint represents a communication endpoint which provides functions for passing messages to each other.</p></li> +<li><p>Message represents communication messages between Endpoint instances. It carries both meta data and payload.</p></li> </ul> </div> </div> @@ -326,7 +325,7 @@ model parameter values using parameter g <a href="device.html" class="btn btn-neutral float-right" title="Device" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="installation.html" class="btn btn-neutral" title="Installation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="installation.html" class="btn btn-neutral float-left" title="Installation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> @@ -335,7 +334,7 @@ model parameter values using parameter g <div role="contentinfo"> <p> - © Copyright 2019 The Apache Software Foundation. All rights reserved. Apache SINGA, Apache, the Apache feather logo, and the Apache SINGA project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.. + © Copyright 2019 The Apache Software Foundation. All rights reserved. Apache SINGA, Apache, the Apache feather logo, and the Apache SINGA project logos are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners. </p> </div> @@ -352,36 +351,17 @@ model parameter values using parameter g - - - <script type="text/javascript"> - var DOCUMENTATION_OPTIONS = { - URL_ROOT:'../', - VERSION:'1.1.0', - LANGUAGE:'None', - 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="../_static/js/theme.js"></script> - - <script type="text/javascript"> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> + + + + + <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> <span class="rst-current-version" data-toggle="rst-current-version"> <span class="fa fa-book"> incubator-singa </span>
