| <!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::AdamOptimizer 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_1AdamOptimizer.html">AdamOptimizer</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classmxnet_1_1cpp_1_1AdamOptimizer-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">mxnet::cpp::AdamOptimizer Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><code>#include <<a class="el" href="optimizer_8h_source.html">optimizer.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for mxnet::cpp::AdamOptimizer:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classmxnet_1_1cpp_1_1AdamOptimizer__inherit__graph.png" border="0" usemap="#mxnet_1_1cpp_1_1AdamOptimizer_inherit__map" alt="Inheritance graph"/></div> |
| <!-- MAP 0 --> |
| </div> |
| <div class="dynheader"> |
| Collaboration diagram for mxnet::cpp::AdamOptimizer:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classmxnet_1_1cpp_1_1AdamOptimizer__coll__graph.png" border="0" usemap="#mxnet_1_1cpp_1_1AdamOptimizer_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:a0fb53ca329020c58f7dd7c11914e2eba"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1AdamOptimizer.html#a0fb53ca329020c58f7dd7c11914e2eba">AdamOptimizer</a> (unsigned begin_num_update=0)</td></tr> |
| <tr class="separator:a0fb53ca329020c58f7dd7c11914e2eba"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abdb90f93c61a2724c3ea777e4d296961"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1AdamOptimizer.html#abdb90f93c61a2724c3ea777e4d296961">GetType</a> () const override</td></tr> |
| <tr class="memdesc:abdb90f93c61a2724c3ea777e4d296961"><td class="mdescLeft"> </td><td class="mdescRight">get optimizer type <a href="classmxnet_1_1cpp_1_1AdamOptimizer.html#abdb90f93c61a2724c3ea777e4d296961">More...</a><br /></td></tr> |
| <tr class="separator:abdb90f93c61a2724c3ea777e4d296961"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae91a4dce6d3b43e6774404facc031ca8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1AdamOptimizer.html#ae91a4dce6d3b43e6774404facc031ca8">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) override</td></tr> |
| <tr class="memdesc:ae91a4dce6d3b43e6774404facc031ca8"><td class="mdescLeft"> </td><td class="mdescRight">Update a weight with gradient. <a href="classmxnet_1_1cpp_1_1AdamOptimizer.html#ae91a4dce6d3b43e6774404facc031ca8">More...</a><br /></td></tr> |
| <tr class="separator:ae91a4dce6d3b43e6774404facc031ca8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classmxnet_1_1cpp_1_1Optimizer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classmxnet_1_1cpp_1_1Optimizer')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html">mxnet::cpp::Optimizer</a></td></tr> |
| <tr class="memitem:a0f9555beda838a27b235ab5a3e4c13c4 inherit pub_methods_classmxnet_1_1cpp_1_1Optimizer"><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 inherit pub_methods_classmxnet_1_1cpp_1_1Optimizer"><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 inherit pub_methods_classmxnet_1_1cpp_1_1Optimizer"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afbf49dabe167d93b686985604f7db510 inherit pub_methods_classmxnet_1_1cpp_1_1Optimizer"><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 inherit pub_methods_classmxnet_1_1cpp_1_1Optimizer"><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 inherit pub_methods_classmxnet_1_1cpp_1_1Optimizer"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4206a3949c453ffe570f3eb58ad9f41e inherit pub_methods_classmxnet_1_1cpp_1_1Optimizer"><td class="memTemplParams" colspan="2">template<typename T > </td></tr> |
| <tr class="memitem:a4206a3949c453ffe570f3eb58ad9f41e inherit pub_methods_classmxnet_1_1cpp_1_1Optimizer"><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 inherit pub_methods_classmxnet_1_1cpp_1_1Optimizer"><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 inherit pub_methods_classmxnet_1_1cpp_1_1Optimizer"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad59fa81da353fa992709fe95f64327c6 inherit pub_methods_classmxnet_1_1cpp_1_1Optimizer"><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 inherit pub_methods_classmxnet_1_1cpp_1_1Optimizer"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3392e5d1250fa89e676bce862a14d62e inherit pub_methods_classmxnet_1_1cpp_1_1Optimizer"><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 inherit pub_methods_classmxnet_1_1cpp_1_1Optimizer"><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 inherit pub_methods_classmxnet_1_1cpp_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_methods_classmxnet_1_1cpp_1_1Optimizer"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classmxnet_1_1cpp_1_1Optimizer')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html">mxnet::cpp::Optimizer</a></td></tr> |
| <tr class="memitem:a2a6af92b6c41ef532cd86076f25e6151 inherit pro_methods_classmxnet_1_1cpp_1_1Optimizer"><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 inherit pro_methods_classmxnet_1_1cpp_1_1Optimizer"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a795d498eafe40faf19722c8a1ed58670 inherit pro_methods_classmxnet_1_1cpp_1_1Optimizer"><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 inherit pro_methods_classmxnet_1_1cpp_1_1Optimizer"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a299346e9e9eacaec1009f1d73a2a3fe8 inherit pro_methods_classmxnet_1_1cpp_1_1Optimizer"><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 inherit pro_methods_classmxnet_1_1cpp_1_1Optimizer"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a37513a5bd944855133a97c2aa17d6f27 inherit pro_methods_classmxnet_1_1cpp_1_1Optimizer"><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 inherit pro_methods_classmxnet_1_1cpp_1_1Optimizer"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a10e1a3206436b942eec0f02d96384e39 inherit pro_methods_classmxnet_1_1cpp_1_1Optimizer"><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 inherit pro_methods_classmxnet_1_1cpp_1_1Optimizer"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pro_static_methods_classmxnet_1_1cpp_1_1Optimizer"><td colspan="2" onclick="javascript:toggleInherit('pro_static_methods_classmxnet_1_1cpp_1_1Optimizer')"><img src="closed.png" alt="-"/> Static Protected Member Functions inherited from <a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html">mxnet::cpp::Optimizer</a></td></tr> |
| <tr class="memitem:abfc49efe03b65b06ae351f347dddc058 inherit pro_static_methods_classmxnet_1_1cpp_1_1Optimizer"><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 inherit pro_static_methods_classmxnet_1_1cpp_1_1Optimizer"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pro_attribs_classmxnet_1_1cpp_1_1Optimizer"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classmxnet_1_1cpp_1_1Optimizer')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html">mxnet::cpp::Optimizer</a></td></tr> |
| <tr class="memitem:ae6f4b597b1a285eb0a4d5fee4fedc2f9 inherit pro_attribs_classmxnet_1_1cpp_1_1Optimizer"><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 inherit pro_attribs_classmxnet_1_1cpp_1_1Optimizer"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9b50b92bbac6f55311e3f68f0edcc656 inherit pro_attribs_classmxnet_1_1cpp_1_1Optimizer"><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 inherit pro_attribs_classmxnet_1_1cpp_1_1Optimizer"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac2ed52bd79811cddbe61bdb3387fcb7a inherit pro_attribs_classmxnet_1_1cpp_1_1Optimizer"><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 inherit pro_attribs_classmxnet_1_1cpp_1_1Optimizer"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1d681d2c3fe689bf9014efdd5216abf3 inherit pro_attribs_classmxnet_1_1cpp_1_1Optimizer"><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 inherit pro_attribs_classmxnet_1_1cpp_1_1Optimizer"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad03f167498541f5bbbbffcdecb875445 inherit pro_attribs_classmxnet_1_1cpp_1_1Optimizer"><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 inherit pro_attribs_classmxnet_1_1cpp_1_1Optimizer"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a0fb53ca329020c58f7dd7c11914e2eba"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0fb53ca329020c58f7dd7c11914e2eba">◆ </a></span>AdamOptimizer()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mxnet::cpp::AdamOptimizer::AdamOptimizer </td> |
| <td>(</td> |
| <td class="paramtype">unsigned </td> |
| <td class="paramname"><em>begin_num_update</em> = <code>0</code></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"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="abdb90f93c61a2724c3ea777e4d296961"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abdb90f93c61a2724c3ea777e4d296961">◆ </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">std::string mxnet::cpp::AdamOptimizer::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">override</span><span class="mlabel">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>Implements <a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html#ac59b1ed1083ca4640cd92ca9206e148d">mxnet::cpp::Optimizer</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ae91a4dce6d3b43e6774404facc031ca8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae91a4dce6d3b43e6774404facc031ca8">◆ </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">void mxnet::cpp::AdamOptimizer::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">override</span><span class="mlabel">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>Implements <a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html#aaff919054071b6b77e0f2b222d3b6ebe">mxnet::cpp::Optimizer</a>.</p> |
| |
| </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 Sat Nov 5 2022 01:16:58 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> |