| <!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::FactorScheduler 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_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 alt="Inheritance graph" border="0" src="classmxnet_1_1cpp_1_1FactorScheduler__inherit__graph.png" usemap="#mxnet_1_1cpp_1_1FactorScheduler_inherit__map"/></div> |
| <map id="mxnet_1_1cpp_1_1FactorScheduler_inherit__map" name="mxnet_1_1cpp_1_1FactorScheduler_inherit__map"> |
| <area alt="" coords="17,5,199,127" href="classmxnet_1_1cpp_1_1LRScheduler.html" id="node2" shape="rect" title="lr scheduler interface "/> |
| </map> |
| </div> |
| <div class="dynheader"> |
| Collaboration diagram for mxnet::cpp::FactorScheduler:</div> |
| <div class="dyncontent"> |
| <div class="center"><img alt="Collaboration graph" border="0" src="classmxnet_1_1cpp_1_1FactorScheduler__coll__graph.png" usemap="#mxnet_1_1cpp_1_1FactorScheduler_coll__map"/></div> |
| <map id="mxnet_1_1cpp_1_1FactorScheduler_coll__map" name="mxnet_1_1cpp_1_1FactorScheduler_coll__map"> |
| <area alt="" coords="17,5,199,127" href="classmxnet_1_1cpp_1_1LRScheduler.html" id="node2" shape="rect" title="lr scheduler 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:abaabb6c44a38ac9ee5025c312eead44e"><td align="right" class="memItemLeft" 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 align="right" class="memItemLeft" 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 alt="-" src="closed.png"/> 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 align="right" class="memItemLeft" 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="#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 align="right" class="memItemLeft" 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="#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 align="right" class="memItemLeft" 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="#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 alt="-" src="closed.png"/> 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 align="right" class="memItemLeft" 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 class="anchor" id="abaabb6c44a38ac9ee5025c312eead44e"></a> |
| <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 class="anchor" id="ad8a87343b246727c623f7729d4e9ed6d"></a> |
| <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>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 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> |
