Google Git
Sign in
apache / mxnet-site / d5c5a235eef72f64ccaf224b834a20ef3287469b / . / versions / master / api / cpp / docs / api / classmxnet_1_1cpp_1_1LRScheduler.html
blob: 91f0e6215c65db584dbf68c804c6eb54450a0826 [file] [log] [blame]
<!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::LRScheduler 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&amp;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&amp;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_1LRScheduler.html">LRScheduler</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classmxnet_1_1cpp_1_1LRScheduler-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mxnet::cpp::LRScheduler Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>lr scheduler interface
<a href="classmxnet_1_1cpp_1_1LRScheduler.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="lr__scheduler_8h_source.html">lr_scheduler.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for mxnet::cpp::LRScheduler:</div>
<div class="dyncontent">
<div class="center"><img src="classmxnet_1_1cpp_1_1LRScheduler__inherit__graph.png" border="0" usemap="#mxnet_1_1cpp_1_1LRScheduler_inherit__map" alt="Inheritance graph"/></div>
<!-- MAP 0 -->
</div>
<div class="dynheader">
Collaboration diagram for mxnet::cpp::LRScheduler:</div>
<div class="dyncontent">
<div class="center"><img src="classmxnet_1_1cpp_1_1LRScheduler__coll__graph.png" border="0" usemap="#mxnet_1_1cpp_1_1LRScheduler_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:a18c635d1650fbeb99d85bc271b71e5a7"><td class="memItemLeft" align="right" valign="top">&#160;</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"><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor <a href="classmxnet_1_1cpp_1_1LRScheduler.html#a18c635d1650fbeb99d85bc271b71e5a7">More...</a><br /></td></tr>
<tr class="separator:a18c635d1650fbeb99d85bc271b71e5a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a575b09dd1c0968867043484704119e7d"><td class="memItemLeft" align="right" valign="top">void&#160;</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"><td class="mdescLeft">&#160;</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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07c2d900f81c46ec56cd1b8558414d38"><td class="memItemLeft" align="right" valign="top">virtual float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1LRScheduler.html#a07c2d900f81c46ec56cd1b8558414d38">GetLR</a> (unsigned num_update)=0</td></tr>
<tr class="memdesc:a07c2d900f81c46ec56cd1b8558414d38"><td class="mdescLeft">&#160;</td><td class="mdescRight">get a new learning rate <a href="classmxnet_1_1cpp_1_1LRScheduler.html#a07c2d900f81c46ec56cd1b8558414d38">More...</a><br /></td></tr>
<tr class="separator:a07c2d900f81c46ec56cd1b8558414d38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f269c0118f9d2c34ecd32a29f8e542f"><td class="memItemLeft" align="right" valign="top">virtual&#160;</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"><td class="mdescLeft">&#160;</td><td class="mdescRight">destructor <a href="classmxnet_1_1cpp_1_1LRScheduler.html#a6f269c0118f9d2c34ecd32a29f8e542f">More...</a><br /></td></tr>
<tr class="separator:a6f269c0118f9d2c34ecd32a29f8e542f"><td class="memSeparator" colspan="2">&#160;</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:a20c6a5521f4216124c1574e093736ac9"><td class="memItemLeft" align="right" valign="top">float&#160;</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"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>lr scheduler interface </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a18c635d1650fbeb99d85bc271b71e5a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18c635d1650fbeb99d85bc271b71e5a7">&#9670;&nbsp;</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">mxnet::cpp::LRScheduler::LRScheduler </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>base_lr</em> = <code>0.01</code></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">
<p>constructor </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">base_lr</td><td>the initial learning rate. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6f269c0118f9d2c34ecd32a29f8e542f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f269c0118f9d2c34ecd32a29f8e542f">&#9670;&nbsp;</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">virtual mxnet::cpp::LRScheduler::~LRScheduler </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><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="a07c2d900f81c46ec56cd1b8558414d38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07c2d900f81c46ec56cd1b8558414d38">&#9670;&nbsp;</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">virtual float mxnet::cpp::LRScheduler::GetLR </td>
<td>(</td>
<td class="paramtype">unsigned&#160;</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>get a new learning rate </p>
<p>Implemented in <a class="el" href="classmxnet_1_1cpp_1_1FactorScheduler.html#ad8a87343b246727c623f7729d4e9ed6d">mxnet::cpp::FactorScheduler</a>.</p>
</div>
</div>
<a id="a575b09dd1c0968867043484704119e7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a575b09dd1c0968867043484704119e7d">&#9670;&nbsp;</a></span>SetLR()</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::LRScheduler::SetLR </td>
<td>(</td>
<td class="paramtype">const float&#160;</td>
<td class="paramname"><em>lr</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>set base lr </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">lr</td><td>learning rate from optimizer </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a20c6a5521f4216124c1574e093736ac9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20c6a5521f4216124c1574e093736ac9">&#9670;&nbsp;</a></span>base_lr_</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::LRScheduler::base_lr_</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="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 Jan 5 2023 03:47:41 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>