| <!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> |
