Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1Nesterov.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1Nesterov.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1Nesterov.html (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1Nesterov.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,184 @@ +<!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/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Apache Singa: singa::Nesterov Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Apache Singa + </div> + <div id="projectbrief">A General Distributed Deep Learning Library</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="namespacesinga.html">singa</a></li><li class="navelem"><a class="el" href="classsinga_1_1Nesterov.html">Nesterov</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="classsinga_1_1Nesterov-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">singa::Nesterov Class Reference</div> </div> +</div><!--header--> +<div class="contents"> +<div class="dynheader"> +Inheritance diagram for singa::Nesterov:</div> +<div class="dyncontent"> +<div class="center"><img src="classsinga_1_1Nesterov__inherit__graph.png" border="0" usemap="#singa_1_1Nesterov_inherit__map" alt="Inheritance graph"/></div> +<!-- MAP 0 --> +<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> +<div class="dynheader"> +Collaboration diagram for singa::Nesterov:</div> +<div class="dyncontent"> +<div class="center"><img src="classsinga_1_1Nesterov__coll__graph.png" border="0" usemap="#singa_1_1Nesterov_coll__map" alt="Collaboration graph"/></div> +<!-- MAP 1 --> +<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:a117377bc4294f46759e7d87834c6772d"><td class="memItemLeft" align="right" valign="top"><a id="a117377bc4294f46759e7d87834c6772d"></a> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Nesterov.html#a117377bc4294f46759e7d87834c6772d">Setup</a> (const OptimizerConf &conf)</td></tr> +<tr class="memdesc:a117377bc4294f46759e7d87834c6772d"><td class="mdescLeft"> </td><td class="mdescRight">Setup the meta fields of the optimizer. <br /></td></tr> +<tr class="separator:a117377bc4294f46759e7d87834c6772d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6551a089c8073dd13b27d59b06ccf2eb"><td class="memItemLeft" align="right" valign="top"><a id="a6551a089c8073dd13b27d59b06ccf2eb"></a> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Nesterov.html#a6551a089c8073dd13b27d59b06ccf2eb">Apply</a> (int epoch, float lr, const string &name, <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &grad, <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &value, int step=-1) override</td></tr> +<tr class="memdesc:a6551a089c8073dd13b27d59b06ccf2eb"><td class="mdescLeft"> </td><td class="mdescRight">Apply the updating algorithm. <br /></td></tr> +<tr class="separator:a6551a089c8073dd13b27d59b06ccf2eb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2ffcfb0b5c20aeaa7af40254bcf85396"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Nesterov.html#a2ffcfb0b5c20aeaa7af40254bcf85396">SetMomentumGenerator</a> (std::function< float(int)> func)</td></tr> +<tr class="memdesc:a2ffcfb0b5c20aeaa7af40254bcf85396"><td class="mdescLeft"> </td><td class="mdescRight">The argument function returns the momentum value given the current running step (i.e., iterations/mini-batches). <a href="#a2ffcfb0b5c20aeaa7af40254bcf85396">More...</a><br /></td></tr> +<tr class="separator:a2ffcfb0b5c20aeaa7af40254bcf85396"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pub_methods_classsinga_1_1Optimizer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classsinga_1_1Optimizer')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td></tr> +<tr class="memitem:ad0940567e5f2ac6ec99132f2c013c94a inherit pub_methods_classsinga_1_1Optimizer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Optimizer.html#ad0940567e5f2ac6ec99132f2c013c94a">Setup</a> (const string &str)</td></tr> +<tr class="memdesc:ad0940567e5f2ac6ec99132f2c013c94a inherit pub_methods_classsinga_1_1Optimizer"><td class="mdescLeft"> </td><td class="mdescRight">Setup the optimzier using configurations from serialized string (for binding languages). <a href="classsinga_1_1Optimizer.html#ad0940567e5f2ac6ec99132f2c013c94a">More...</a><br /></td></tr> +<tr class="separator:ad0940567e5f2ac6ec99132f2c013c94a inherit pub_methods_classsinga_1_1Optimizer"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6385d176ba3b2bf744221f8801291f3e inherit pub_methods_classsinga_1_1Optimizer"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Optimizer.html#a6385d176ba3b2bf744221f8801291f3e">Register</a> (const string &name, const ParamSpec &specs)</td></tr> +<tr class="memdesc:a6385d176ba3b2bf744221f8801291f3e inherit pub_methods_classsinga_1_1Optimizer"><td class="mdescLeft"> </td><td class="mdescRight">Register the parameter, e.g., create <a class="el" href="classsinga_1_1Constraint.html" title="Apply constraints for parameters (gradient). ">Constraint</a> and Regularizers. <a href="classsinga_1_1Optimizer.html#a6385d176ba3b2bf744221f8801291f3e">More...</a><br /></td></tr> +<tr class="separator:a6385d176ba3b2bf744221f8801291f3e inherit pub_methods_classsinga_1_1Optimizer"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a497c98c50be398534651afb9c47ad896 inherit pub_methods_classsinga_1_1Optimizer"><td class="memItemLeft" align="right" valign="top"><a id="a497c98c50be398534651afb9c47ad896"></a> +virtual void </td><td class="memItemRight" valign="bottom"><b>ApplyRegularizerConstraint</b> (int epoch, const string &name, const <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &value, <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &grad, int step=-1)</td></tr> +<tr class="separator:a497c98c50be398534651afb9c47ad896 inherit pub_methods_classsinga_1_1Optimizer"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a23eb982f713174589788369a0316e81d inherit pub_methods_classsinga_1_1Optimizer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Optimizer.html#a23eb982f713174589788369a0316e81d">Apply</a> (int epoch, const string &name, <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &grad, <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &value, int step=-1)</td></tr> +<tr class="memdesc:a23eb982f713174589788369a0316e81d inherit pub_methods_classsinga_1_1Optimizer"><td class="mdescLeft"> </td><td class="mdescRight">Apply the updating algorithm if the gradient is not empty. <a href="classsinga_1_1Optimizer.html#a23eb982f713174589788369a0316e81d">More...</a><br /></td></tr> +<tr class="separator:a23eb982f713174589788369a0316e81d inherit pub_methods_classsinga_1_1Optimizer"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2f3ba1fe776cdf373565b0cf208bf540 inherit pub_methods_classsinga_1_1Optimizer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Optimizer.html#a2f3ba1fe776cdf373565b0cf208bf540">SetLearningRateGenerator</a> (function< float(int)> func)</td></tr> +<tr class="memdesc:a2f3ba1fe776cdf373565b0cf208bf540 inherit pub_methods_classsinga_1_1Optimizer"><td class="mdescLeft"> </td><td class="mdescRight">The argument is a function that returns the learning rate given the current step (i.e., curren running iteration). <a href="classsinga_1_1Optimizer.html#a2f3ba1fe776cdf373565b0cf208bf540">More...</a><br /></td></tr> +<tr class="separator:a2f3ba1fe776cdf373565b0cf208bf540 inherit pub_methods_classsinga_1_1Optimizer"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4fddc84ed373777a3bff864793312895 inherit pub_methods_classsinga_1_1Optimizer"><td class="memItemLeft" align="right" valign="top"><a id="a4fddc84ed373777a3bff864793312895"></a> +float </td><td class="memItemRight" valign="bottom"><b>GetLearningRate</b> (int step)</td></tr> +<tr class="separator:a4fddc84ed373777a3bff864793312895 inherit pub_methods_classsinga_1_1Optimizer"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> +Additional Inherited Members</h2></td></tr> +<tr class="inherit_header pro_attribs_classsinga_1_1Optimizer"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classsinga_1_1Optimizer')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td></tr> +<tr class="memitem:a08ff43c3cf2dd1a84d2dbcab2b9825eb inherit pro_attribs_classsinga_1_1Optimizer"><td class="memItemLeft" align="right" valign="top"><a id="a08ff43c3cf2dd1a84d2dbcab2b9825eb"></a> +function< float(int)> </td><td class="memItemRight" valign="bottom"><b>learning_rate_generator_</b></td></tr> +<tr class="separator:a08ff43c3cf2dd1a84d2dbcab2b9825eb inherit pro_attribs_classsinga_1_1Optimizer"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a303ef1680d83a7dba74a8de5e412eba7 inherit pro_attribs_classsinga_1_1Optimizer"><td class="memItemLeft" align="right" valign="top"><a id="a303ef1680d83a7dba74a8de5e412eba7"></a> +std::unordered_map< std::string, float > </td><td class="memItemRight" valign="bottom"><b>learning_rate_multplier_</b></td></tr> +<tr class="separator:a303ef1680d83a7dba74a8de5e412eba7 inherit pro_attribs_classsinga_1_1Optimizer"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a398deb004c050bd6aed1c41f66554e0a inherit pro_attribs_classsinga_1_1Optimizer"><td class="memItemLeft" align="right" valign="top"><a id="a398deb004c050bd6aed1c41f66554e0a"></a> +std::unordered_map< std::string, <a class="el" href="classsinga_1_1Constraint.html">Constraint</a> * > </td><td class="memItemRight" valign="bottom"><b>constraints_</b></td></tr> +<tr class="separator:a398deb004c050bd6aed1c41f66554e0a inherit pro_attribs_classsinga_1_1Optimizer"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac55e2668b8ddd0fe2d3b98d363836484 inherit pro_attribs_classsinga_1_1Optimizer"><td class="memItemLeft" align="right" valign="top"><a id="ac55e2668b8ddd0fe2d3b98d363836484"></a> +std::unordered_map< std::string, <a class="el" href="classsinga_1_1Regularizer.html">Regularizer</a> * > </td><td class="memItemRight" valign="bottom"><b>regularizers_</b></td></tr> +<tr class="separator:ac55e2668b8ddd0fe2d3b98d363836484 inherit pro_attribs_classsinga_1_1Optimizer"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a91a5e476ac69c0da15cfbfce6351fec4 inherit pro_attribs_classsinga_1_1Optimizer"><td class="memItemLeft" align="right" valign="top"><a id="a91a5e476ac69c0da15cfbfce6351fec4"></a> +<a class="el" href="classsinga_1_1Constraint.html">Constraint</a> * </td><td class="memItemRight" valign="bottom"><b>constraint_</b> = nullptr</td></tr> +<tr class="separator:a91a5e476ac69c0da15cfbfce6351fec4 inherit pro_attribs_classsinga_1_1Optimizer"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:accec73a0f0dafbe4617106f6151bcccf inherit pro_attribs_classsinga_1_1Optimizer"><td class="memItemLeft" align="right" valign="top"><a id="accec73a0f0dafbe4617106f6151bcccf"></a> +<a class="el" href="classsinga_1_1Regularizer.html">Regularizer</a> * </td><td class="memItemRight" valign="bottom"><b>regularizer_</b> = nullptr</td></tr> +<tr class="separator:accec73a0f0dafbe4617106f6151bcccf inherit pro_attribs_classsinga_1_1Optimizer"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a71b4defd74f44648cbfd523311258f41 inherit pro_attribs_classsinga_1_1Optimizer"><td class="memItemLeft" align="right" valign="top"><a id="a71b4defd74f44648cbfd523311258f41"></a> +OptimizerConf </td><td class="memItemRight" valign="bottom"><b>conf_</b></td></tr> +<tr class="separator:a71b4defd74f44648cbfd523311258f41 inherit pro_attribs_classsinga_1_1Optimizer"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a2ffcfb0b5c20aeaa7af40254bcf85396"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2ffcfb0b5c20aeaa7af40254bcf85396">◆ </a></span>SetMomentumGenerator()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void singa::Nesterov::SetMomentumGenerator </td> + <td>(</td> + <td class="paramtype">std::function< float(int)> </td> + <td class="paramname"><em>func</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>The argument function returns the momentum value given the current running step (i.e., iterations/mini-batches). </p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>/home/moaz/incubator-singa/include/singa/model/<a class="el" href="optimizer_8h_source.html">optimizer.h</a></li> +</ul> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated on Mon Apr 22 2019 12:27:05 for Apache Singa by  <a href="http://www.doxygen.org/index.html";> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.13 +</small></address> +</body> +</html>
Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1Nesterov__coll__graph.dot URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1Nesterov__coll__graph.dot?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1Nesterov__coll__graph.dot (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1Nesterov__coll__graph.dot Mon Apr 22 10:37:18 2019 @@ -0,0 +1,14 @@ +digraph "singa::Nesterov" +{ + edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; + node [fontname="Helvetica",fontsize="10",shape=record]; + Node2 [label="singa::Nesterov",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black"]; + Node3 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; + Node3 [label="singa::Optimizer",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classsinga_1_1Optimizer.html",tooltip="The base class for gradient descent algorithms used to update the model parameters in order to optimi..."]; + Node4 -> Node3 [dir="back",color="darkorchid3",fontsize="10",style="dashed",label=" constraint_" ,fontname="Helvetica"]; + Node4 [label="singa::Constraint",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classsinga_1_1Constraint.html",tooltip="Apply constraints for parameters (gradient). "]; + Node5 -> Node3 [dir="back",color="darkorchid3",fontsize="10",style="dashed",label=" learning_rate_generator_" ,fontname="Helvetica"]; + Node5 [label="function\< float(int)\>",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled"]; + Node6 -> Node3 [dir="back",color="darkorchid3",fontsize="10",style="dashed",label=" regularizer_" ,fontname="Helvetica"]; + Node6 [label="singa::Regularizer",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classsinga_1_1Regularizer.html",tooltip="Apply regularization for parameters (gradient), e.g., L1 norm and L2 norm. "]; +} Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1Nesterov__coll__graph.md5 URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1Nesterov__coll__graph.md5?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1Nesterov__coll__graph.md5 (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1Nesterov__coll__graph.md5 Mon Apr 22 10:37:18 2019 @@ -0,0 +1 @@ +a317f644891e95a22baf9a4f85e3d0a3 \ No newline at end of file Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1Nesterov__inherit__graph.dot URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1Nesterov__inherit__graph.dot?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1Nesterov__inherit__graph.dot (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1Nesterov__inherit__graph.dot Mon Apr 22 10:37:18 2019 @@ -0,0 +1,8 @@ +digraph "singa::Nesterov" +{ + edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; + node [fontname="Helvetica",fontsize="10",shape=record]; + Node0 [label="singa::Nesterov",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black"]; + Node1 -> Node0 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; + Node1 [label="singa::Optimizer",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classsinga_1_1Optimizer.html",tooltip="The base class for gradient descent algorithms used to update the model parameters in order to optimi..."]; +} Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1Nesterov__inherit__graph.md5 URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1Nesterov__inherit__graph.md5?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1Nesterov__inherit__graph.md5 (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1Nesterov__inherit__graph.md5 Mon Apr 22 10:37:18 2019 @@ -0,0 +1 @@ +8fb1d3d3ba239a6f984fe99c6ca6555a \ No newline at end of file Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1Optimizer-members.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1Optimizer-members.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1Optimizer-members.html (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1Optimizer-members.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,98 @@ +<!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/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Apache Singa: Member List</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Apache Singa + </div> + <div id="projectbrief">A General Distributed Deep Learning Library</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="namespacesinga.html">singa</a></li><li class="navelem"><a class="el" href="classsinga_1_1Optimizer.html">Optimizer</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">singa::Optimizer Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>, including all inherited members.</p> +<table class="directory"> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html#a98c129ff433c9faff924f17618126539">Apply</a>(int epoch, float lr, const string &name, Tensor &grad, Tensor &value, int step=-1)=0</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html#a23eb982f713174589788369a0316e81d">Apply</a>(int epoch, const string &name, Tensor &grad, Tensor &value, int step=-1)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>ApplyRegularizerConstraint</b>(int epoch, const string &name, const Tensor &value, Tensor &grad, int step=-1) (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>conf_</b> (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>constraint_</b> (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>constraints_</b> (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>GetLearningRate</b>(int step) (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>learning_rate_generator_</b> (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>learning_rate_multplier_</b> (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>Optimizer</b>()=default (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html#a6385d176ba3b2bf744221f8801291f3e">Register</a>(const string &name, const ParamSpec &specs)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>regularizer_</b> (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>regularizers_</b> (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html#a2f3ba1fe776cdf373565b0cf208bf540">SetLearningRateGenerator</a>(function< float(int)> func)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html#ad0940567e5f2ac6ec99132f2c013c94a">Setup</a>(const string &str)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html#aa51db156a64d285d04f575398bb79d1c">Setup</a>(const OptimizerConf &conf)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>~Optimizer</b>() (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> +</table></div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated on Mon Apr 22 2019 12:27:05 for Apache Singa by  <a href="http://www.doxygen.org/index.html";> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.13 +</small></address> +</body> +</html> Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1Optimizer.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1Optimizer.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1Optimizer.html (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1Optimizer.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,368 @@ +<!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/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Apache Singa: singa::Optimizer Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Apache Singa + </div> + <div id="projectbrief">A General Distributed Deep Learning Library</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="namespacesinga.html">singa</a></li><li class="navelem"><a class="el" href="classsinga_1_1Optimizer.html">Optimizer</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pro-attribs">Protected Attributes</a> | +<a href="classsinga_1_1Optimizer-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">singa::Optimizer Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> +</div><!--header--> +<div class="contents"> + +<p>The base class for gradient descent algorithms used to update the model parameters in order to optimize the objective (loss) function. + <a href="classsinga_1_1Optimizer.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="optimizer_8h_source.html">optimizer.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for singa::Optimizer:</div> +<div class="dyncontent"> +<div class="center"><img src="classsinga_1_1Optimizer__inherit__graph.png" border="0" usemap="#singa_1_1Optimizer_inherit__map" alt="Inheritance graph"/></div> +<!-- MAP 0 --> +<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> +<div class="dynheader"> +Collaboration diagram for singa::Optimizer:</div> +<div class="dyncontent"> +<div class="center"><img src="classsinga_1_1Optimizer__coll__graph.png" border="0" usemap="#singa_1_1Optimizer_coll__map" alt="Collaboration graph"/></div> +<!-- MAP 1 --> +<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:ad0940567e5f2ac6ec99132f2c013c94a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Optimizer.html#ad0940567e5f2ac6ec99132f2c013c94a">Setup</a> (const string &str)</td></tr> +<tr class="memdesc:ad0940567e5f2ac6ec99132f2c013c94a"><td class="mdescLeft"> </td><td class="mdescRight">Setup the optimzier using configurations from serialized string (for binding languages). <a href="#ad0940567e5f2ac6ec99132f2c013c94a">More...</a><br /></td></tr> +<tr class="separator:ad0940567e5f2ac6ec99132f2c013c94a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa51db156a64d285d04f575398bb79d1c"><td class="memItemLeft" align="right" valign="top"><a id="aa51db156a64d285d04f575398bb79d1c"></a> +virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Optimizer.html#aa51db156a64d285d04f575398bb79d1c">Setup</a> (const OptimizerConf &conf)</td></tr> +<tr class="memdesc:aa51db156a64d285d04f575398bb79d1c"><td class="mdescLeft"> </td><td class="mdescRight">Setup the meta fields of the optimizer. <br /></td></tr> +<tr class="separator:aa51db156a64d285d04f575398bb79d1c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6385d176ba3b2bf744221f8801291f3e"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Optimizer.html#a6385d176ba3b2bf744221f8801291f3e">Register</a> (const string &name, const ParamSpec &specs)</td></tr> +<tr class="memdesc:a6385d176ba3b2bf744221f8801291f3e"><td class="mdescLeft"> </td><td class="mdescRight">Register the parameter, e.g., create <a class="el" href="classsinga_1_1Constraint.html" title="Apply constraints for parameters (gradient). ">Constraint</a> and Regularizers. <a href="#a6385d176ba3b2bf744221f8801291f3e">More...</a><br /></td></tr> +<tr class="separator:a6385d176ba3b2bf744221f8801291f3e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a497c98c50be398534651afb9c47ad896"><td class="memItemLeft" align="right" valign="top"><a id="a497c98c50be398534651afb9c47ad896"></a> +virtual void </td><td class="memItemRight" valign="bottom"><b>ApplyRegularizerConstraint</b> (int epoch, const string &name, const <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &value, <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &grad, int step=-1)</td></tr> +<tr class="separator:a497c98c50be398534651afb9c47ad896"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a98c129ff433c9faff924f17618126539"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Optimizer.html#a98c129ff433c9faff924f17618126539">Apply</a> (int epoch, float lr, const string &name, <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &grad, <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &value, int step=-1)=0</td></tr> +<tr class="memdesc:a98c129ff433c9faff924f17618126539"><td class="mdescLeft"> </td><td class="mdescRight">Apply the updating algorithm if the gradient is not empty. <a href="#a98c129ff433c9faff924f17618126539">More...</a><br /></td></tr> +<tr class="separator:a98c129ff433c9faff924f17618126539"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a23eb982f713174589788369a0316e81d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Optimizer.html#a23eb982f713174589788369a0316e81d">Apply</a> (int epoch, const string &name, <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &grad, <a class="el" href="classsinga_1_1Tensor.html">Tensor</a> &value, int step=-1)</td></tr> +<tr class="memdesc:a23eb982f713174589788369a0316e81d"><td class="mdescLeft"> </td><td class="mdescRight">Apply the updating algorithm if the gradient is not empty. <a href="#a23eb982f713174589788369a0316e81d">More...</a><br /></td></tr> +<tr class="separator:a23eb982f713174589788369a0316e81d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2f3ba1fe776cdf373565b0cf208bf540"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Optimizer.html#a2f3ba1fe776cdf373565b0cf208bf540">SetLearningRateGenerator</a> (function< float(int)> func)</td></tr> +<tr class="memdesc:a2f3ba1fe776cdf373565b0cf208bf540"><td class="mdescLeft"> </td><td class="mdescRight">The argument is a function that returns the learning rate given the current step (i.e., curren running iteration). <a href="#a2f3ba1fe776cdf373565b0cf208bf540">More...</a><br /></td></tr> +<tr class="separator:a2f3ba1fe776cdf373565b0cf208bf540"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4fddc84ed373777a3bff864793312895"><td class="memItemLeft" align="right" valign="top"><a id="a4fddc84ed373777a3bff864793312895"></a> +float </td><td class="memItemRight" valign="bottom"><b>GetLearningRate</b> (int step)</td></tr> +<tr class="separator:a4fddc84ed373777a3bff864793312895"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> +Protected Attributes</h2></td></tr> +<tr class="memitem:a08ff43c3cf2dd1a84d2dbcab2b9825eb"><td class="memItemLeft" align="right" valign="top"><a id="a08ff43c3cf2dd1a84d2dbcab2b9825eb"></a> +function< float(int)> </td><td class="memItemRight" valign="bottom"><b>learning_rate_generator_</b></td></tr> +<tr class="separator:a08ff43c3cf2dd1a84d2dbcab2b9825eb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a303ef1680d83a7dba74a8de5e412eba7"><td class="memItemLeft" align="right" valign="top"><a id="a303ef1680d83a7dba74a8de5e412eba7"></a> +std::unordered_map< std::string, float > </td><td class="memItemRight" valign="bottom"><b>learning_rate_multplier_</b></td></tr> +<tr class="separator:a303ef1680d83a7dba74a8de5e412eba7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a398deb004c050bd6aed1c41f66554e0a"><td class="memItemLeft" align="right" valign="top"><a id="a398deb004c050bd6aed1c41f66554e0a"></a> +std::unordered_map< std::string, <a class="el" href="classsinga_1_1Constraint.html">Constraint</a> * > </td><td class="memItemRight" valign="bottom"><b>constraints_</b></td></tr> +<tr class="separator:a398deb004c050bd6aed1c41f66554e0a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac55e2668b8ddd0fe2d3b98d363836484"><td class="memItemLeft" align="right" valign="top"><a id="ac55e2668b8ddd0fe2d3b98d363836484"></a> +std::unordered_map< std::string, <a class="el" href="classsinga_1_1Regularizer.html">Regularizer</a> * > </td><td class="memItemRight" valign="bottom"><b>regularizers_</b></td></tr> +<tr class="separator:ac55e2668b8ddd0fe2d3b98d363836484"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a91a5e476ac69c0da15cfbfce6351fec4"><td class="memItemLeft" align="right" valign="top"><a id="a91a5e476ac69c0da15cfbfce6351fec4"></a> +<a class="el" href="classsinga_1_1Constraint.html">Constraint</a> * </td><td class="memItemRight" valign="bottom"><b>constraint_</b> = nullptr</td></tr> +<tr class="separator:a91a5e476ac69c0da15cfbfce6351fec4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:accec73a0f0dafbe4617106f6151bcccf"><td class="memItemLeft" align="right" valign="top"><a id="accec73a0f0dafbe4617106f6151bcccf"></a> +<a class="el" href="classsinga_1_1Regularizer.html">Regularizer</a> * </td><td class="memItemRight" valign="bottom"><b>regularizer_</b> = nullptr</td></tr> +<tr class="separator:accec73a0f0dafbe4617106f6151bcccf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a71b4defd74f44648cbfd523311258f41"><td class="memItemLeft" align="right" valign="top"><a id="a71b4defd74f44648cbfd523311258f41"></a> +OptimizerConf </td><td class="memItemRight" valign="bottom"><b>conf_</b></td></tr> +<tr class="separator:a71b4defd74f44648cbfd523311258f41"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>The base class for gradient descent algorithms used to update the model parameters in order to optimize the objective (loss) function. </p> +<p>It updates parameters based on the gradients of the loss w.r.t each parameter. Most sub-classes uses first order gradients. An overview of gradient descent algorithms, <a href="http://sebastianruder.com/optimizing-gradient-descent/";>http://sebastianruder.com/optimizing-gradient-descent/</a> </p> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a id="a98c129ff433c9faff924f17618126539"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a98c129ff433c9faff924f17618126539">◆ </a></span>Apply() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void singa::Optimizer::Apply </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"><em>epoch</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"><em>lr</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const string & </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classsinga_1_1Tensor.html">Tensor</a> & </td> + <td class="paramname"><em>grad</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classsinga_1_1Tensor.html">Tensor</a> & </td> + <td class="paramname"><em>value</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>step</em> = <code>-1</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Apply the updating algorithm if the gradient is not empty. </p> +<p>No learning rate scaling, gradient constraints/regularization will be conducted. It assumes all these operations are done either by users or by Apply(int, const string&, Tensor*, Tensor*). All sub-classes should override this function. </p> + +<p>Implemented in <a class="el" href="classsinga_1_1RMSProp.html#a2b83ee5006967e91eed435c6adcf782d">singa::RMSProp</a>, <a class="el" href="classsinga_1_1AdaGrad.html#ac9b378fe7ae88f88e45b817f89871f69">singa::AdaGrad</a>, <a class="el" href="classsinga_1_1Nesterov.html#a6551a089c8073dd13b27d59b06ccf2eb">singa::Nesterov</a>, and <a class="el" href="classsinga_1_1SGD.html#ac73356906d1ca127d7d13c376b5edafe">singa::SGD</a>.</p> + +</div> +</div> +<a id="a23eb982f713174589788369a0316e81d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a23eb982f713174589788369a0316e81d">◆ </a></span>Apply() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void singa::Optimizer::Apply </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"><em>epoch</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const string & </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classsinga_1_1Tensor.html">Tensor</a> & </td> + <td class="paramname"><em>grad</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classsinga_1_1Tensor.html">Tensor</a> & </td> + <td class="paramname"><em>value</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>step</em> = <code>-1</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Apply the updating algorithm if the gradient is not empty. </p> +<p>It will apply regularization and constraint to the parameters if configured during <a class="el" href="classsinga_1_1Optimizer.html#a6385d176ba3b2bf744221f8801291f3e" title="Register the parameter, e.g., create Constraint and Regularizers. ">Register()</a>. If will also scale the learning rate if configured in ParamSpecs (see Register). </p> + +</div> +</div> +<a id="a6385d176ba3b2bf744221f8801291f3e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6385d176ba3b2bf744221f8801291f3e">◆ </a></span>Register()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void singa::Optimizer::Register </td> + <td>(</td> + <td class="paramtype">const string & </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const ParamSpec & </td> + <td class="paramname"><em>specs</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Register the parameter, e.g., create <a class="el" href="classsinga_1_1Constraint.html" title="Apply constraints for parameters (gradient). ">Constraint</a> and Regularizers. </p> +<p>If there is no constraint or regularizer, then no need to register the parameter. </p> + +</div> +</div> +<a id="a2f3ba1fe776cdf373565b0cf208bf540"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2f3ba1fe776cdf373565b0cf208bf540">◆ </a></span>SetLearningRateGenerator()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void singa::Optimizer::SetLearningRateGenerator </td> + <td>(</td> + <td class="paramtype">function< float(int)> </td> + <td class="paramname"><em>func</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>The argument is a function that returns the learning rate given the current step (i.e., curren running iteration). </p> + +</div> +</div> +<a id="ad0940567e5f2ac6ec99132f2c013c94a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad0940567e5f2ac6ec99132f2c013c94a">◆ </a></span>Setup()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void singa::Optimizer::Setup </td> + <td>(</td> + <td class="paramtype">const string & </td> + <td class="paramname"><em>str</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Setup the optimzier using configurations from serialized string (for binding languages). </p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>/home/moaz/incubator-singa/include/singa/model/<a class="el" href="optimizer_8h_source.html">optimizer.h</a></li> +</ul> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated on Mon Apr 22 2019 12:27:05 for Apache Singa by  <a href="http://www.doxygen.org/index.html";> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.13 +</small></address> +</body> +</html> Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1Optimizer__coll__graph.dot URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1Optimizer__coll__graph.dot?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1Optimizer__coll__graph.dot (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1Optimizer__coll__graph.dot Mon Apr 22 10:37:18 2019 @@ -0,0 +1,12 @@ +digraph "singa::Optimizer" +{ + edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; + node [fontname="Helvetica",fontsize="10",shape=record]; + Node5 [label="singa::Optimizer",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black"]; + Node6 -> Node5 [dir="back",color="darkorchid3",fontsize="10",style="dashed",label=" constraint_" ,fontname="Helvetica"]; + Node6 [label="singa::Constraint",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classsinga_1_1Constraint.html",tooltip="Apply constraints for parameters (gradient). "]; + Node7 -> Node5 [dir="back",color="darkorchid3",fontsize="10",style="dashed",label=" learning_rate_generator_" ,fontname="Helvetica"]; + Node7 [label="function\< float(int)\>",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled"]; + Node8 -> Node5 [dir="back",color="darkorchid3",fontsize="10",style="dashed",label=" regularizer_" ,fontname="Helvetica"]; + Node8 [label="singa::Regularizer",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classsinga_1_1Regularizer.html",tooltip="Apply regularization for parameters (gradient), e.g., L1 norm and L2 norm. "]; +} Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1Optimizer__coll__graph.md5 URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1Optimizer__coll__graph.md5?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1Optimizer__coll__graph.md5 (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1Optimizer__coll__graph.md5 Mon Apr 22 10:37:18 2019 @@ -0,0 +1 @@ +70cb5701b898bfb0b986f18f90153ec2 \ No newline at end of file Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1Optimizer__inherit__graph.dot URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1Optimizer__inherit__graph.dot?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1Optimizer__inherit__graph.dot (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1Optimizer__inherit__graph.dot Mon Apr 22 10:37:18 2019 @@ -0,0 +1,14 @@ +digraph "singa::Optimizer" +{ + edge [fontname="Helvetica",fontsize="10",labelfontname="Helvetica",labelfontsize="10"]; + node [fontname="Helvetica",fontsize="10",shape=record]; + Node0 [label="singa::Optimizer",height=0.2,width=0.4,color="black", fillcolor="grey75", style="filled", fontcolor="black"]; + Node0 -> Node1 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; + Node1 [label="singa::AdaGrad",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classsinga_1_1AdaGrad.html"]; + Node0 -> Node2 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; + Node2 [label="singa::Nesterov",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classsinga_1_1Nesterov.html"]; + Node0 -> Node3 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; + Node3 [label="singa::RMSProp",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classsinga_1_1RMSProp.html"]; + Node0 -> Node4 [dir="back",color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"]; + Node4 [label="singa::SGD",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$classsinga_1_1SGD.html"]; +} Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1Optimizer__inherit__graph.md5 URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1Optimizer__inherit__graph.md5?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1Optimizer__inherit__graph.md5 (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1Optimizer__inherit__graph.md5 Mon Apr 22 10:37:18 2019 @@ -0,0 +1 @@ +ccf6297accefb658faa6e67896ccd965 \ No newline at end of file Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1Platform-members.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1Platform-members.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1Platform-members.html (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1Platform-members.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,82 @@ +<!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/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Apache Singa: Member List</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Apache Singa + </div> + <div id="projectbrief">A General Distributed Deep Learning Library</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="namespacesinga.html">singa</a></li><li class="navelem"><a class="el" href="classsinga_1_1Platform.html">Platform</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">singa::Platform Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classsinga_1_1Platform.html">singa::Platform</a>, including all inherited members.</p> +<table class="directory"> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1Platform.html#a316ed276df691fd5d9482243254082ed">GetDefaultDevice</a>()</td><td class="entry"><a class="el" href="classsinga_1_1Platform.html">singa::Platform</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr> +</table></div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated on Mon Apr 22 2019 12:27:05 for Apache Singa by  <a href="http://www.doxygen.org/index.html";> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.13 +</small></address> +</body> +</html> Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1Platform.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1Platform.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1Platform.html (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1Platform.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,100 @@ +<!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/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Apache Singa: singa::Platform Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Apache Singa + </div> + <div id="projectbrief">A General Distributed Deep Learning Library</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="namespacesinga.html">singa</a></li><li class="navelem"><a class="el" href="classsinga_1_1Platform.html">Platform</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-static-methods">Static Public Member Functions</a> | +<a href="classsinga_1_1Platform-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">singa::Platform Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This class queries all available calculating devices on a given machine grouped according to manufacturer or device drivers. + <a href="classsinga_1_1Platform.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="device_8h_source.html">device.h</a>></code></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> +Static Public Member Functions</h2></td></tr> +<tr class="memitem:a316ed276df691fd5d9482243254082ed"><td class="memItemLeft" align="right" valign="top"><a id="a316ed276df691fd5d9482243254082ed"></a> +static std::shared_ptr< <a class="el" href="classsinga_1_1Device.html">Device</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Platform.html#a316ed276df691fd5d9482243254082ed">GetDefaultDevice</a> ()</td></tr> +<tr class="memdesc:a316ed276df691fd5d9482243254082ed"><td class="mdescLeft"> </td><td class="mdescRight">Return the default host device. <br /></td></tr> +<tr class="separator:a316ed276df691fd5d9482243254082ed"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>This class queries all available calculating devices on a given machine grouped according to manufacturer or device drivers. </p> +<p>All methods should be static. If CUDA or OPENCL are not enabled, then the respective related methods should return something that indicates their absence (for example, 0 devices); however they should always be available regardless of compile-time switches. </p> +</div><hr/>The documentation for this class was generated from the following file:<ul> +<li>/home/moaz/incubator-singa/include/singa/core/<a class="el" href="device_8h_source.html">device.h</a></li> +</ul> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated on Mon Apr 22 2019 12:27:05 for Apache Singa by  <a href="http://www.doxygen.org/index.html";> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.13 +</small></address> +</body> +</html> Added: incubator/singa/site/trunk/doxygen/html/classsinga_1_1RMSProp-members.html URL: http://svn.apache.org/viewvc/incubator/singa/site/trunk/doxygen/html/classsinga_1_1RMSProp-members.html?rev=1857944&view=auto ============================================================================== --- incubator/singa/site/trunk/doxygen/html/classsinga_1_1RMSProp-members.html (added) +++ incubator/singa/site/trunk/doxygen/html/classsinga_1_1RMSProp-members.html Mon Apr 22 10:37:18 2019 @@ -0,0 +1,99 @@ +<!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/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Apache Singa: Member List</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Apache Singa + </div> + <div id="projectbrief">A General Distributed Deep Learning Library</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="namespacesinga.html">singa</a></li><li class="navelem"><a class="el" href="classsinga_1_1RMSProp.html">RMSProp</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">singa::RMSProp Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classsinga_1_1RMSProp.html">singa::RMSProp</a>, including all inherited members.</p> +<table class="directory"> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1RMSProp.html#a2b83ee5006967e91eed435c6adcf782d">Apply</a>(int epoch, float lr, const string &name, Tensor &grad, Tensor &value, int step=-1) override</td><td class="entry"><a class="el" href="classsinga_1_1RMSProp.html">singa::RMSProp</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html#a23eb982f713174589788369a0316e81d">singa::Optimizer::Apply</a>(int epoch, const string &name, Tensor &grad, Tensor &value, int step=-1)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>ApplyRegularizerConstraint</b>(int epoch, const string &name, const Tensor &value, Tensor &grad, int step=-1) (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>conf_</b> (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>constraint_</b> (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>constraints_</b> (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>GetLearningRate</b>(int step) (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>learning_rate_generator_</b> (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>learning_rate_multplier_</b> (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>Optimizer</b>()=default (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html#a6385d176ba3b2bf744221f8801291f3e">Register</a>(const string &name, const ParamSpec &specs)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>regularizer_</b> (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>regularizers_</b> (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html#a2f3ba1fe776cdf373565b0cf208bf540">SetLearningRateGenerator</a>(function< float(int)> func)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classsinga_1_1RMSProp.html#a8e2e088416dd043d0902aeba51e08537">Setup</a>(const OptimizerConf &conf)</td><td class="entry"><a class="el" href="classsinga_1_1RMSProp.html">singa::RMSProp</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html#ad0940567e5f2ac6ec99132f2c013c94a">singa::Optimizer::Setup</a>(const string &str)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>~Optimizer</b>() (defined in <a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a>)</td><td class="entry"><a class="el" href="classsinga_1_1Optimizer.html">singa::Optimizer</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>~RMSProp</b>()=default (defined in <a class="el" href="classsinga_1_1RMSProp.html">singa::RMSProp</a>)</td><td class="entry"><a class="el" href="classsinga_1_1RMSProp.html">singa::RMSProp</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> +</table></div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated on Mon Apr 22 2019 12:27:05 for Apache Singa by  <a href="http://www.doxygen.org/index.html";> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.13 +</small></address> +</body> +</html>
