| <!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 content="text/xhtml;charset=utf-8" http-equiv="Content-Type"/> |
| <meta content="IE=9" http-equiv="X-UA-Compatible"/> |
| <meta content="Doxygen 1.8.11" name="generator"/> |
| <title>mxnet: mxnet::cpp::SGDOptimizer Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script src="jquery.js" type="text/javascript"></script> |
| <script src="dynsections.js" type="text/javascript"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script src="search/searchdata.js" type="text/javascript"></script> |
| <script src="search/search.js" type="text/javascript"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { init_search(); }); |
| </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 cellpadding="0" cellspacing="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.11 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <div class="tabs" id="navrow1"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
| <li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
| <li><a href="files.html"><span>Files</span></a></li> |
| <li> |
| <div class="MSearchBoxInactive" id="MSearchBox"> |
| <span class="left"> |
| <img alt="" id="MSearchSelect" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()" src="search/mag_sel.png"/> |
| <input accesskey="S" id="MSearchField" onblur="searchBox.OnSearchFieldFocus(false)" onfocus="searchBox.OnSearchFieldFocus(true)" onkeyup="searchBox.OnSearchFieldChange(event)" type="text" value="Search"/> |
| </span><span class="right"> |
| <a href="javascript:searchBox.CloseResultsWindow()" id="MSearchClose"><img alt="" border="0" id="MSearchCloseImg" src="search/close.png"/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="tabs2" id="navrow2"> |
| <ul class="tablist"> |
| <li><a href="annotated.html"><span>Class List</span></a></li> |
| <li><a href="classes.html"><span>Class Index</span></a></li> |
| <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class Members</span></a></li> |
| </ul> |
| </div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" onkeydown="return searchBox.OnSearchSelectKey(event)" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()"> |
| </div> |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe frameborder="0" id="MSearchResults" name="MSearchResults" src="javascript:void(0)"> |
| </iframe> |
| </div> |
| <div class="navpath" id="nav-path"> |
| <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_1SGDOptimizer.html">SGDOptimizer</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_1SGDOptimizer-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">mxnet::cpp::SGDOptimizer 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::SGDOptimizer:</div> |
| <div class="dyncontent"> |
| <div class="center"><img alt="Inheritance graph" border="0" src="classmxnet_1_1cpp_1_1SGDOptimizer__inherit__graph.png" usemap="#mxnet_1_1cpp_1_1SGDOptimizer_inherit__map"/></div> |
| <map id="mxnet_1_1cpp_1_1SGDOptimizer_inherit__map" name="mxnet_1_1cpp_1_1SGDOptimizer_inherit__map"> |
| <area alt="" coords="19,5,185,332" href="classmxnet_1_1cpp_1_1Optimizer.html" id="node2" shape="rect" title="Optimizer interface. "/> |
| </map> |
| </div> |
| <div class="dynheader"> |
| Collaboration diagram for mxnet::cpp::SGDOptimizer:</div> |
| <div class="dyncontent"> |
| <div class="center"><img alt="Collaboration graph" border="0" src="classmxnet_1_1cpp_1_1SGDOptimizer__coll__graph.png" usemap="#mxnet_1_1cpp_1_1SGDOptimizer_coll__map"/></div> |
| <map id="mxnet_1_1cpp_1_1SGDOptimizer_coll__map" name="mxnet_1_1cpp_1_1SGDOptimizer_coll__map"> |
| <area alt="" coords="19,5,185,332" href="classmxnet_1_1cpp_1_1Optimizer.html" id="node2" shape="rect" title="Optimizer interface. "/> |
| </map> |
| </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:a9368e2ccc3048a76fe4e61bdad059017"><td align="right" class="memItemLeft" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1SGDOptimizer.html#a9368e2ccc3048a76fe4e61bdad059017">SGDOptimizer</a> (unsigned begin_num_update=0)</td></tr> |
| <tr class="separator:a9368e2ccc3048a76fe4e61bdad059017"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3d25c572963d3f99b2030126b01c0a12"><td align="right" class="memItemLeft" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1SGDOptimizer.html#a3d25c572963d3f99b2030126b01c0a12">GetType</a> () const override</td></tr> |
| <tr class="memdesc:a3d25c572963d3f99b2030126b01c0a12"><td class="mdescLeft"> </td><td class="mdescRight">get optimizer type <a href="#a3d25c572963d3f99b2030126b01c0a12">More...</a><br/></td></tr> |
| <tr class="separator:a3d25c572963d3f99b2030126b01c0a12"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a47f86c61877d129b8fb7561fb993e677"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1SGDOptimizer.html#a47f86c61877d129b8fb7561fb993e677">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:a47f86c61877d129b8fb7561fb993e677"><td class="mdescLeft"> </td><td class="mdescRight">Update a weight with gradient. <a href="#a47f86c61877d129b8fb7561fb993e677">More...</a><br/></td></tr> |
| <tr class="separator:a47f86c61877d129b8fb7561fb993e677"><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 alt="-" src="closed.png"/> 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 align="right" class="memItemLeft" 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="#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 align="right" class="memItemLeft" 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="#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 align="right" class="memTemplItemLeft" 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="#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 align="right" class="memItemLeft" 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:a683ac39ae1ca0e6caf60fc7c19c793a5 inherit pub_methods_classmxnet_1_1cpp_1_1Optimizer"><td align="right" class="memItemLeft" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html#a683ac39ae1ca0e6caf60fc7c19c793a5">Serialize</a> () const </td></tr> |
| <tr class="memdesc:a683ac39ae1ca0e6caf60fc7c19c793a5 inherit pub_methods_classmxnet_1_1cpp_1_1Optimizer"><td class="mdescLeft"> </td><td class="mdescRight">Serialize the optimizer parameters to a string. <a href="#a683ac39ae1ca0e6caf60fc7c19c793a5">More...</a><br/></td></tr> |
| <tr class="separator:a683ac39ae1ca0e6caf60fc7c19c793a5 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 alt="-" src="closed.png"/> Protected Member Functions inherited from <a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html">mxnet::cpp::Optimizer</a></td></tr> |
| <tr class="memitem:ae9530eaa064b8b5e75cd413f8b8d2a17 inherit pro_methods_classmxnet_1_1cpp_1_1Optimizer"><td align="right" class="memItemLeft" valign="top">const std::vector< const char * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html#ae9530eaa064b8b5e75cd413f8b8d2a17">GetParamKeys_</a> () const </td></tr> |
| <tr class="separator:ae9530eaa064b8b5e75cd413f8b8d2a17 inherit pro_methods_classmxnet_1_1cpp_1_1Optimizer"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a74656e689b598755a47aa651de71971d inherit pro_methods_classmxnet_1_1cpp_1_1Optimizer"><td align="right" class="memItemLeft" valign="top">const std::vector< const char * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Optimizer.html#a74656e689b598755a47aa651de71971d">GetParamValues_</a> () const </td></tr> |
| <tr class="separator:a74656e689b598755a47aa651de71971d 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 align="right" class="memItemLeft" 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 align="right" class="memItemLeft" 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 align="right" class="memItemLeft" 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 alt="-" src="closed.png"/> 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 align="right" class="memItemLeft" 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 alt="-" src="closed.png"/> 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 align="right" class="memItemLeft" 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 align="right" class="memItemLeft" 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 align="right" class="memItemLeft" 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 align="right" class="memItemLeft" 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 align="right" class="memItemLeft" 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 class="anchor" id="a9368e2ccc3048a76fe4e61bdad059017"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mxnet::cpp::SGDOptimizer::SGDOptimizer </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 class="anchor" id="a3d25c572963d3f99b2030126b01c0a12"></a> |
| <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::SGDOptimizer::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 class="anchor" id="a47f86c61877d129b8fb7561fb993e677"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mxnet::cpp::SGDOptimizer::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>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 Sep 19 2019 13:08:40 for mxnet by <a href="http://www.doxygen.org/index.html"> |
| <img alt="doxygen" class="footer" src="doxygen.png"/> |
| </a> 1.8.11 |
| </small></address> |
| </body> |
| </html> |
