| <!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::Updater 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_1Updater.html">Updater</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_1Updater-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">singa::Updater Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Basic <a class="el" href="classsinga_1_1Updater.html" title="Basic Updater class just forward all the method function call to the wrapped Optimizer. ">Updater</a> class just forward all the method function call to the wrapped <a class="el" href="classsinga_1_1Optimizer.html" title="The base class for gradient descent algorithms used to update the model parameters in order to optimi...">Optimizer</a>. |
| <a href="classsinga_1_1Updater.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="updater_8h_source.html">updater.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for singa::Updater:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classsinga_1_1Updater__inherit__graph.png" border="0" usemap="#singa_1_1Updater_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::Updater:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classsinga_1_1Updater__coll__graph.png" border="0" usemap="#singa_1_1Updater_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:a076f5d544dc73d7d8ea629c683810f4f"><td class="memItemLeft" align="right" valign="top"><a id="a076f5d544dc73d7d8ea629c683810f4f"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>Updater</b> (<a class="el" href="classsinga_1_1Optimizer.html">Optimizer</a> *opt)</td></tr> |
| <tr class="separator:a076f5d544dc73d7d8ea629c683810f4f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6cc4fdac0b011f0500c0d7bf9ad78e1a"><td class="memItemLeft" align="right" valign="top"><a id="a6cc4fdac0b011f0500c0d7bf9ad78e1a"></a> |
| virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Updater.html#a6cc4fdac0b011f0500c0d7bf9ad78e1a">Setup</a> (const OptimizerConf &conf)</td></tr> |
| <tr class="memdesc:a6cc4fdac0b011f0500c0d7bf9ad78e1a"><td class="mdescLeft"> </td><td class="mdescRight">Forward <a class="el" href="classsinga_1_1Updater.html#a6cc4fdac0b011f0500c0d7bf9ad78e1a" title="Forward Setup() to Optimizer. ">Setup()</a> to <a class="el" href="classsinga_1_1Optimizer.html" title="The base class for gradient descent algorithms used to update the model parameters in order to optimi...">Optimizer</a>. <br /></td></tr> |
| <tr class="separator:a6cc4fdac0b011f0500c0d7bf9ad78e1a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a279ada6bda1f42a420245f5258bba221"><td class="memItemLeft" align="right" valign="top"><a id="a279ada6bda1f42a420245f5258bba221"></a> |
| virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Updater.html#a279ada6bda1f42a420245f5258bba221">Register</a> (const string &name, const ParamSpec &specs)</td></tr> |
| <tr class="memdesc:a279ada6bda1f42a420245f5258bba221"><td class="mdescLeft"> </td><td class="mdescRight">Forward <a class="el" href="classsinga_1_1Updater.html#a279ada6bda1f42a420245f5258bba221" title="Forward Register() to Optimizer. ">Register()</a> to <a class="el" href="classsinga_1_1Optimizer.html" title="The base class for gradient descent algorithms used to update the model parameters in order to optimi...">Optimizer</a>. <br /></td></tr> |
| <tr class="separator:a279ada6bda1f42a420245f5258bba221"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac07c0e7cd69b631244b7c2c4bb90c0ec"><td class="memItemLeft" align="right" valign="top"><a id="ac07c0e7cd69b631244b7c2c4bb90c0ec"></a> |
| virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Updater.html#ac07c0e7cd69b631244b7c2c4bb90c0ec">Apply</a> (int step, 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)</td></tr> |
| <tr class="memdesc:ac07c0e7cd69b631244b7c2c4bb90c0ec"><td class="mdescLeft"> </td><td class="mdescRight">Forward <a class="el" href="classsinga_1_1Updater.html#ac07c0e7cd69b631244b7c2c4bb90c0ec" title="Forward Apply() to Optimizer. ">Apply()</a> to <a class="el" href="classsinga_1_1Optimizer.html" title="The base class for gradient descent algorithms used to update the model parameters in order to optimi...">Optimizer</a>. <br /></td></tr> |
| <tr class="separator:ac07c0e7cd69b631244b7c2c4bb90c0ec"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa0d7577d8025726e3274829aeafca7c1"><td class="memItemLeft" align="right" valign="top"><a id="aa0d7577d8025726e3274829aeafca7c1"></a> |
| <a class="el" href="classsinga_1_1Optimizer.html">Optimizer</a> * </td><td class="memItemRight" valign="bottom"><b>GetOptimizer</b> ()</td></tr> |
| <tr class="separator:aa0d7577d8025726e3274829aeafca7c1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a56efaf6e6432f78ad214565088c9d546"><td class="memItemLeft" align="right" valign="top"><a id="a56efaf6e6432f78ad214565088c9d546"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>Updater</b> (const <a class="el" href="classsinga_1_1Updater.html">Updater</a> &)=delete</td></tr> |
| <tr class="separator:a56efaf6e6432f78ad214565088c9d546"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9242e97e0aba87d58226f60e1ed54099"><td class="memItemLeft" align="right" valign="top"><a id="a9242e97e0aba87d58226f60e1ed54099"></a> |
| void </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classsinga_1_1Updater.html">Updater</a> &)=delete</td></tr> |
| <tr class="separator:a9242e97e0aba87d58226f60e1ed54099"><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:a5ddbf085ad8a0828a0ef1e8633e8a3e4"><td class="memItemLeft" align="right" valign="top"><a id="a5ddbf085ad8a0828a0ef1e8633e8a3e4"></a> |
| <a class="el" href="classsinga_1_1Optimizer.html">Optimizer</a> * </td><td class="memItemRight" valign="bottom"><b>opt_</b></td></tr> |
| <tr class="separator:a5ddbf085ad8a0828a0ef1e8633e8a3e4"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Basic <a class="el" href="classsinga_1_1Updater.html" title="Basic Updater class just forward all the method function call to the wrapped Optimizer. ">Updater</a> class just forward all the method function call to the wrapped <a class="el" href="classsinga_1_1Optimizer.html" title="The base class for gradient descent algorithms used to update the model parameters in order to optimi...">Optimizer</a>. </p> |
| </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="updater_8h_source.html">updater.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> |
