| <!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>mxnet: mxnet::cpp::FactorScheduler 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.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="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_1FactorScheduler.html">FactorScheduler</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_1FactorScheduler-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">mxnet::cpp::FactorScheduler Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><code>#include <<a class="el" href="lr__scheduler_8h_source.html">lr_scheduler.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for mxnet::cpp::FactorScheduler:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classmxnet_1_1cpp_1_1FactorScheduler__inherit__graph.png" border="0" usemap="#mxnet_1_1cpp_1_1FactorScheduler_inherit__map" alt="Inheritance graph"/></div> |
| <map name="mxnet_1_1cpp_1_1FactorScheduler_inherit__map" id="mxnet_1_1cpp_1_1FactorScheduler_inherit__map"> |
| <area shape="rect" id="node2" href="classmxnet_1_1cpp_1_1LRScheduler.html" title="lr scheduler interface " alt="" coords="17,5,200,127"/> |
| </map> |
| </div> |
| <div class="dynheader"> |
| Collaboration diagram for mxnet::cpp::FactorScheduler:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classmxnet_1_1cpp_1_1FactorScheduler__coll__graph.png" border="0" usemap="#mxnet_1_1cpp_1_1FactorScheduler_coll__map" alt="Collaboration graph"/></div> |
| <map name="mxnet_1_1cpp_1_1FactorScheduler_coll__map" id="mxnet_1_1cpp_1_1FactorScheduler_coll__map"> |
| <area shape="rect" id="node2" href="classmxnet_1_1cpp_1_1LRScheduler.html" title="lr scheduler interface " alt="" coords="17,5,200,127"/> |
| </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:abaabb6c44a38ac9ee5025c312eead44e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1FactorScheduler.html#abaabb6c44a38ac9ee5025c312eead44e">FactorScheduler</a> (int step, float factor=1, float stop_factor_lr=1e-8)</td></tr> |
| <tr class="separator:abaabb6c44a38ac9ee5025c312eead44e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad8a87343b246727c623f7729d4e9ed6d"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1FactorScheduler.html#ad8a87343b246727c623f7729d4e9ed6d">GetLR</a> (unsigned num_update) override</td></tr> |
| <tr class="memdesc:ad8a87343b246727c623f7729d4e9ed6d"><td class="mdescLeft"> </td><td class="mdescRight">get a new learning rate <a href="#ad8a87343b246727c623f7729d4e9ed6d">More...</a><br /></td></tr> |
| <tr class="separator:ad8a87343b246727c623f7729d4e9ed6d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classmxnet_1_1cpp_1_1LRScheduler"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classmxnet_1_1cpp_1_1LRScheduler')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classmxnet_1_1cpp_1_1LRScheduler.html">mxnet::cpp::LRScheduler</a></td></tr> |
| <tr class="memitem:a18c635d1650fbeb99d85bc271b71e5a7 inherit pub_methods_classmxnet_1_1cpp_1_1LRScheduler"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1LRScheduler.html#a18c635d1650fbeb99d85bc271b71e5a7">LRScheduler</a> (float base_lr=0.01)</td></tr> |
| <tr class="memdesc:a18c635d1650fbeb99d85bc271b71e5a7 inherit pub_methods_classmxnet_1_1cpp_1_1LRScheduler"><td class="mdescLeft"> </td><td class="mdescRight">constructor <a href="classmxnet_1_1cpp_1_1LRScheduler.html#a18c635d1650fbeb99d85bc271b71e5a7">More...</a><br /></td></tr> |
| <tr class="separator:a18c635d1650fbeb99d85bc271b71e5a7 inherit pub_methods_classmxnet_1_1cpp_1_1LRScheduler"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a575b09dd1c0968867043484704119e7d inherit pub_methods_classmxnet_1_1cpp_1_1LRScheduler"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1LRScheduler.html#a575b09dd1c0968867043484704119e7d">SetLR</a> (const float lr)</td></tr> |
| <tr class="memdesc:a575b09dd1c0968867043484704119e7d inherit pub_methods_classmxnet_1_1cpp_1_1LRScheduler"><td class="mdescLeft"> </td><td class="mdescRight">set base lr <a href="classmxnet_1_1cpp_1_1LRScheduler.html#a575b09dd1c0968867043484704119e7d">More...</a><br /></td></tr> |
| <tr class="separator:a575b09dd1c0968867043484704119e7d inherit pub_methods_classmxnet_1_1cpp_1_1LRScheduler"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6f269c0118f9d2c34ecd32a29f8e542f inherit pub_methods_classmxnet_1_1cpp_1_1LRScheduler"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1LRScheduler.html#a6f269c0118f9d2c34ecd32a29f8e542f">~LRScheduler</a> ()</td></tr> |
| <tr class="memdesc:a6f269c0118f9d2c34ecd32a29f8e542f inherit pub_methods_classmxnet_1_1cpp_1_1LRScheduler"><td class="mdescLeft"> </td><td class="mdescRight">destructor <a href="classmxnet_1_1cpp_1_1LRScheduler.html#a6f269c0118f9d2c34ecd32a29f8e542f">More...</a><br /></td></tr> |
| <tr class="separator:a6f269c0118f9d2c34ecd32a29f8e542f inherit pub_methods_classmxnet_1_1cpp_1_1LRScheduler"><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_classmxnet_1_1cpp_1_1LRScheduler"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classmxnet_1_1cpp_1_1LRScheduler')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classmxnet_1_1cpp_1_1LRScheduler.html">mxnet::cpp::LRScheduler</a></td></tr> |
| <tr class="memitem:a20c6a5521f4216124c1574e093736ac9 inherit pro_attribs_classmxnet_1_1cpp_1_1LRScheduler"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1LRScheduler.html#a20c6a5521f4216124c1574e093736ac9">base_lr_</a></td></tr> |
| <tr class="separator:a20c6a5521f4216124c1574e093736ac9 inherit pro_attribs_classmxnet_1_1cpp_1_1LRScheduler"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="abaabb6c44a38ac9ee5025c312eead44e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abaabb6c44a38ac9ee5025c312eead44e">◆ </a></span>FactorScheduler()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mxnet::cpp::FactorScheduler::FactorScheduler </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>step</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">float </td> |
| <td class="paramname"><em>factor</em> = <code>1</code>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">float </td> |
| <td class="paramname"><em>stop_factor_lr</em> = <code>1e-8</code> </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 class="mlabel">explicit</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ad8a87343b246727c623f7729d4e9ed6d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad8a87343b246727c623f7729d4e9ed6d">◆ </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::FactorScheduler::GetLR </td> |
| <td>(</td> |
| <td class="paramtype">unsigned </td> |
| <td class="paramname"><em>num_update</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>get a new learning rate </p> |
| |
| <p>Implements <a class="el" href="classmxnet_1_1cpp_1_1LRScheduler.html#a07c2d900f81c46ec56cd1b8558414d38">mxnet::cpp::LRScheduler</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="lr__scheduler_8h_source.html">lr_scheduler.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Wed Jun 8 2022 23:30:31 for mxnet 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> |