| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>mxnet: mxnet::cpp::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">mxnet |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.17 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</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="namespacemxnet.html">mxnet</a></li><li class="navelem"><a class="el" href="namespacemxnet_1_1cpp.html">cpp</a></li><li class="navelem"><a class="el" href="classmxnet_1_1cpp_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-methods">Protected Member Functions</a> | |
| <a href="#pro-static-methods">Static Protected Member Functions</a> | |
| <a href="#pro-attribs">Protected Attributes</a> | |
| <a href="classmxnet_1_1cpp_1_1Optimizer-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">mxnet::cpp::Optimizer Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html" title="Optimizer interface.">Optimizer</a> interface. |
| <a href="classmxnet_1_1cpp_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 mxnet::cpp::Optimizer:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classmxnet_1_1cpp_1_1Optimizer__inherit__graph.png" border="0" usemap="#mxnet_1_1cpp_1_1Optimizer_inherit__map" alt="Inheritance graph"/></div> |
| <!-- MAP 0 --> |
| </div> |
| <div class="dynheader"> |
| Collaboration diagram for mxnet::cpp::Optimizer:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classmxnet_1_1cpp_1_1Optimizer__coll__graph.png" border="0" usemap="#mxnet_1_1cpp_1_1Optimizer_coll__map" alt="Collaboration graph"/></div> |
| <!-- MAP 1 --> |
| </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:a0f9555beda838a27b235ab5a3e4c13c4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html#a0f9555beda838a27b235ab5a3e4c13c4">Optimizer</a> (unsigned begin_num_update)</td></tr> |
| <tr class="memdesc:a0f9555beda838a27b235ab5a3e4c13c4"><td class="mdescLeft"> </td><td class="mdescRight">constructor <a href="classmxnet_1_1cpp_1_1Optimizer.html#a0f9555beda838a27b235ab5a3e4c13c4">More...</a><br /></td></tr> |
| <tr class="separator:a0f9555beda838a27b235ab5a3e4c13c4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac59b1ed1083ca4640cd92ca9206e148d"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html#ac59b1ed1083ca4640cd92ca9206e148d">GetType</a> () const =0</td></tr> |
| <tr class="memdesc:ac59b1ed1083ca4640cd92ca9206e148d"><td class="mdescLeft"> </td><td class="mdescRight">get optimizer type <a href="classmxnet_1_1cpp_1_1Optimizer.html#ac59b1ed1083ca4640cd92ca9206e148d">More...</a><br /></td></tr> |
| <tr class="separator:ac59b1ed1083ca4640cd92ca9206e148d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afbf49dabe167d93b686985604f7db510"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html#afbf49dabe167d93b686985604f7db510">~Optimizer</a> ()</td></tr> |
| <tr class="memdesc:afbf49dabe167d93b686985604f7db510"><td class="mdescLeft"> </td><td class="mdescRight">destructor <a href="classmxnet_1_1cpp_1_1Optimizer.html#afbf49dabe167d93b686985604f7db510">More...</a><br /></td></tr> |
| <tr class="separator:afbf49dabe167d93b686985604f7db510"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4206a3949c453ffe570f3eb58ad9f41e"><td class="memTemplParams" colspan="2">template<typename T > </td></tr> |
| <tr class="memitem:a4206a3949c453ffe570f3eb58ad9f41e"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html">Optimizer</a> * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html#a4206a3949c453ffe570f3eb58ad9f41e">SetParam</a> (const std::string &name, const T &value)</td></tr> |
| <tr class="memdesc:a4206a3949c453ffe570f3eb58ad9f41e"><td class="mdescLeft"> </td><td class="mdescRight">set config parameters <a href="classmxnet_1_1cpp_1_1Optimizer.html#a4206a3949c453ffe570f3eb58ad9f41e">More...</a><br /></td></tr> |
| <tr class="separator:a4206a3949c453ffe570f3eb58ad9f41e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad59fa81da353fa992709fe95f64327c6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html">Optimizer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html#ad59fa81da353fa992709fe95f64327c6">SetLRScheduler</a> (std::unique_ptr< <a class="el" href="classmxnet_1_1cpp_1_1LRScheduler.html">LRScheduler</a> > lrScheduler)</td></tr> |
| <tr class="separator:ad59fa81da353fa992709fe95f64327c6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aaff919054071b6b77e0f2b222d3b6ebe"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html#aaff919054071b6b77e0f2b222d3b6ebe">Update</a> (int index, <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> weight, <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> grad)=0</td></tr> |
| <tr class="memdesc:aaff919054071b6b77e0f2b222d3b6ebe"><td class="mdescLeft"> </td><td class="mdescRight">Update a weight with gradient. <a href="classmxnet_1_1cpp_1_1Optimizer.html#aaff919054071b6b77e0f2b222d3b6ebe">More...</a><br /></td></tr> |
| <tr class="separator:aaff919054071b6b77e0f2b222d3b6ebe"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3392e5d1250fa89e676bce862a14d62e"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html#a3392e5d1250fa89e676bce862a14d62e">Serialize</a> () const</td></tr> |
| <tr class="memdesc:a3392e5d1250fa89e676bce862a14d62e"><td class="mdescLeft"> </td><td class="mdescRight">Serialize the optimizer parameters to a string. <a href="classmxnet_1_1cpp_1_1Optimizer.html#a3392e5d1250fa89e676bce862a14d62e">More...</a><br /></td></tr> |
| <tr class="separator:a3392e5d1250fa89e676bce862a14d62e"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> |
| Protected Member Functions</h2></td></tr> |
| <tr class="memitem:a2a6af92b6c41ef532cd86076f25e6151"><td class="memItemLeft" align="right" valign="top">const std::vector< const char * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html#a2a6af92b6c41ef532cd86076f25e6151">GetParamKeys_</a> () const</td></tr> |
| <tr class="separator:a2a6af92b6c41ef532cd86076f25e6151"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a795d498eafe40faf19722c8a1ed58670"><td class="memItemLeft" align="right" valign="top">const std::vector< const char * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html#a795d498eafe40faf19722c8a1ed58670">GetParamValues_</a> () const</td></tr> |
| <tr class="separator:a795d498eafe40faf19722c8a1ed58670"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a299346e9e9eacaec1009f1d73a2a3fe8"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html#a299346e9e9eacaec1009f1d73a2a3fe8">UpdateCount_</a> (int index)</td></tr> |
| <tr class="separator:a299346e9e9eacaec1009f1d73a2a3fe8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a37513a5bd944855133a97c2aa17d6f27"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html#a37513a5bd944855133a97c2aa17d6f27">GetLR_</a> (int index)</td></tr> |
| <tr class="separator:a37513a5bd944855133a97c2aa17d6f27"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a10e1a3206436b942eec0f02d96384e39"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html#a10e1a3206436b942eec0f02d96384e39">GetWD_</a> (int index)</td></tr> |
| <tr class="separator:a10e1a3206436b942eec0f02d96384e39"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a31606655261991fa067ee7198999151f"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html#a31606655261991fa067ee7198999151f">CreateState_</a> (int index, <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> weight)</td></tr> |
| <tr class="separator:a31606655261991fa067ee7198999151f"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-methods"></a> |
| Static Protected Member Functions</h2></td></tr> |
| <tr class="memitem:abfc49efe03b65b06ae351f347dddc058"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classmxnet_1_1cpp_1_1OpMap.html">OpMap</a> *& </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html#abfc49efe03b65b06ae351f347dddc058">op_map</a> ()</td></tr> |
| <tr class="separator:abfc49efe03b65b06ae351f347dddc058"><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:ae6f4b597b1a285eb0a4d5fee4fedc2f9"><td class="memItemLeft" align="right" valign="top">std::map< std::string, std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html#ae6f4b597b1a285eb0a4d5fee4fedc2f9">params_</a></td></tr> |
| <tr class="separator:ae6f4b597b1a285eb0a4d5fee4fedc2f9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9b50b92bbac6f55311e3f68f0edcc656"><td class="memItemLeft" align="right" valign="top">std::map< int, unsigned > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html#a9b50b92bbac6f55311e3f68f0edcc656">count_</a></td></tr> |
| <tr class="separator:a9b50b92bbac6f55311e3f68f0edcc656"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac2ed52bd79811cddbe61bdb3387fcb7a"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html#ac2ed52bd79811cddbe61bdb3387fcb7a">begin_num_update_</a></td></tr> |
| <tr class="separator:ac2ed52bd79811cddbe61bdb3387fcb7a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1d681d2c3fe689bf9014efdd5216abf3"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html#a1d681d2c3fe689bf9014efdd5216abf3">num_update_</a></td></tr> |
| <tr class="separator:a1d681d2c3fe689bf9014efdd5216abf3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad03f167498541f5bbbbffcdecb875445"><td class="memItemLeft" align="right" valign="top">std::unique_ptr< <a class="el" href="classmxnet_1_1cpp_1_1LRScheduler.html">LRScheduler</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html#ad03f167498541f5bbbbffcdecb875445">lrScheduler_</a> = nullptr</td></tr> |
| <tr class="separator:ad03f167498541f5bbbbffcdecb875445"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html" title="Optimizer interface.">Optimizer</a> interface. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a0f9555beda838a27b235ab5a3e4c13c4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0f9555beda838a27b235ab5a3e4c13c4">◆ </a></span>Optimizer()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mxnet::cpp::Optimizer::Optimizer </td> |
| <td>(</td> |
| <td class="paramtype">unsigned </td> |
| <td class="paramname"><em>begin_num_update</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">explicit</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>constructor </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">beign_num_update</td><td>The initial number of updates </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="afbf49dabe167d93b686985604f7db510"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afbf49dabe167d93b686985604f7db510">◆ </a></span>~Optimizer()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual mxnet::cpp::Optimizer::~Optimizer </td> |
| <td>(</td> |
| <td class="paramname"></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>destructor </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a31606655261991fa067ee7198999151f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a31606655261991fa067ee7198999151f">◆ </a></span>CreateState_()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void mxnet::cpp::Optimizer::CreateState_ </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>index</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> </td> |
| <td class="paramname"><em>weight</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">protected</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a37513a5bd944855133a97c2aa17d6f27"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a37513a5bd944855133a97c2aa17d6f27">◆ </a></span>GetLR_()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">float mxnet::cpp::Optimizer::GetLR_ </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>index</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a2a6af92b6c41ef532cd86076f25e6151"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2a6af92b6c41ef532cd86076f25e6151">◆ </a></span>GetParamKeys_()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::vector<const char*> mxnet::cpp::Optimizer::GetParamKeys_ </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a795d498eafe40faf19722c8a1ed58670"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a795d498eafe40faf19722c8a1ed58670">◆ </a></span>GetParamValues_()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::vector<const char*> mxnet::cpp::Optimizer::GetParamValues_ </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="ac59b1ed1083ca4640cd92ca9206e148d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac59b1ed1083ca4640cd92ca9206e148d">◆ </a></span>GetType()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual std::string mxnet::cpp::Optimizer::GetType </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</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>get optimizer type </p> |
| <dl class="section return"><dt>Returns</dt><dd>string of optimizer type </dd></dl> |
| |
| <p>Implemented in <a class="el" href="classmxnet_1_1cpp_1_1AdaDeltaOptimizer.html#acadc4feadb3ffc9cb0aeb30fe3e851d3">mxnet::cpp::AdaDeltaOptimizer</a>, <a class="el" href="classmxnet_1_1cpp_1_1AdaGradOptimizer.html#a77255ea497fbee3f785b742a876b8b0e">mxnet::cpp::AdaGradOptimizer</a>, <a class="el" href="classmxnet_1_1cpp_1_1AdamOptimizer.html#abdb90f93c61a2724c3ea777e4d296961">mxnet::cpp::AdamOptimizer</a>, <a class="el" href="classmxnet_1_1cpp_1_1RMSPropOptimizer.html#a44632be3295bec0b2402db3484673763">mxnet::cpp::RMSPropOptimizer</a>, <a class="el" href="classmxnet_1_1cpp_1_1SignumOptimizer.html#ab821e3135000be3f12a60e52b56cefc3">mxnet::cpp::SignumOptimizer</a>, and <a class="el" href="classmxnet_1_1cpp_1_1SGDOptimizer.html#a3d25c572963d3f99b2030126b01c0a12">mxnet::cpp::SGDOptimizer</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a10e1a3206436b942eec0f02d96384e39"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a10e1a3206436b942eec0f02d96384e39">◆ </a></span>GetWD_()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">float mxnet::cpp::Optimizer::GetWD_ </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>index</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="abfc49efe03b65b06ae351f347dddc058"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abfc49efe03b65b06ae351f347dddc058">◆ </a></span>op_map()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="classmxnet_1_1cpp_1_1OpMap.html">OpMap</a>*& mxnet::cpp::Optimizer::op_map </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a3392e5d1250fa89e676bce862a14d62e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3392e5d1250fa89e676bce862a14d62e">◆ </a></span>Serialize()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string mxnet::cpp::Optimizer::Serialize </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Serialize the optimizer parameters to a string. </p> |
| <dl class="section return"><dt>Returns</dt><dd>serialization </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ad59fa81da353fa992709fe95f64327c6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad59fa81da353fa992709fe95f64327c6">◆ </a></span>SetLRScheduler()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html">Optimizer</a>* mxnet::cpp::Optimizer::SetLRScheduler </td> |
| <td>(</td> |
| <td class="paramtype">std::unique_ptr< <a class="el" href="classmxnet_1_1cpp_1_1LRScheduler.html">LRScheduler</a> > </td> |
| <td class="paramname"><em>lrScheduler</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>\bried set the lr scheduler </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">lrScheduler</td><td>lr scheduler used for this optimizer </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>reference if self </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a4206a3949c453ffe570f3eb58ad9f41e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4206a3949c453ffe570f3eb58ad9f41e">◆ </a></span>SetParam()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html">Optimizer</a>* mxnet::cpp::Optimizer::SetParam </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const T & </td> |
| <td class="paramname"><em>value</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">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>set config parameters </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>name of the config parameter </td></tr> |
| <tr><td class="paramname">value</td><td>value of the config parameter </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>reference of self </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aaff919054071b6b77e0f2b222d3b6ebe"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aaff919054071b6b77e0f2b222d3b6ebe">◆ </a></span>Update()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void mxnet::cpp::Optimizer::Update </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>index</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> </td> |
| <td class="paramname"><em>weight</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> </td> |
| <td class="paramname"><em>grad</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">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Update a weight with gradient. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">index</td><td>the unique index for the weight. </td></tr> |
| <tr><td class="paramname">weight</td><td>the weight to update. </td></tr> |
| <tr><td class="paramname">grad</td><td>gradient for the weight. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implemented in <a class="el" href="classmxnet_1_1cpp_1_1AdaDeltaOptimizer.html#a2817ee59529362bab4526910d01995fc">mxnet::cpp::AdaDeltaOptimizer</a>, <a class="el" href="classmxnet_1_1cpp_1_1AdaGradOptimizer.html#adf399e55e3a6996a4eb33bba9fa803ee">mxnet::cpp::AdaGradOptimizer</a>, <a class="el" href="classmxnet_1_1cpp_1_1AdamOptimizer.html#ae91a4dce6d3b43e6774404facc031ca8">mxnet::cpp::AdamOptimizer</a>, <a class="el" href="classmxnet_1_1cpp_1_1RMSPropOptimizer.html#a5927f68612abfb0967c8ad9f056ac8e0">mxnet::cpp::RMSPropOptimizer</a>, <a class="el" href="classmxnet_1_1cpp_1_1SignumOptimizer.html#aa35d23e6b4cba71969c4afcb70f5d976">mxnet::cpp::SignumOptimizer</a>, and <a class="el" href="classmxnet_1_1cpp_1_1SGDOptimizer.html#a47f86c61877d129b8fb7561fb993e677">mxnet::cpp::SGDOptimizer</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a299346e9e9eacaec1009f1d73a2a3fe8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a299346e9e9eacaec1009f1d73a2a3fe8">◆ </a></span>UpdateCount_()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">unsigned mxnet::cpp::Optimizer::UpdateCount_ </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>index</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a id="ac2ed52bd79811cddbe61bdb3387fcb7a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac2ed52bd79811cddbe61bdb3387fcb7a">◆ </a></span>begin_num_update_</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">unsigned mxnet::cpp::Optimizer::begin_num_update_</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a9b50b92bbac6f55311e3f68f0edcc656"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9b50b92bbac6f55311e3f68f0edcc656">◆ </a></span>count_</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::map<int, unsigned> mxnet::cpp::Optimizer::count_</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="ad03f167498541f5bbbbffcdecb875445"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad03f167498541f5bbbbffcdecb875445">◆ </a></span>lrScheduler_</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::unique_ptr<<a class="el" href="classmxnet_1_1cpp_1_1LRScheduler.html">LRScheduler</a>> mxnet::cpp::Optimizer::lrScheduler_ = nullptr</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a1d681d2c3fe689bf9014efdd5216abf3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1d681d2c3fe689bf9014efdd5216abf3">◆ </a></span>num_update_</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">unsigned mxnet::cpp::Optimizer::num_update_</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="ae6f4b597b1a285eb0a4d5fee4fedc2f9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae6f4b597b1a285eb0a4d5fee4fedc2f9">◆ </a></span>params_</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::map<std::string, std::string> mxnet::cpp::Optimizer::params_</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/work/mxnet/cpp-package/include/mxnet-cpp/<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 Thu Jan 5 2023 03:47:41 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.17 |
| </small></address> |
| </body> |
| </html> |