| <!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: /work/mxnet/cpp-package/include/mxnet-cpp/lr_scheduler.h Source File</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="dir_c9bbcf2f7c4ed40b1b23631ec8abffa6.html">cpp-package</a></li><li class="navelem"><a class="el" href="dir_eb07344824255b98f70969533c25e736.html">include</a></li><li class="navelem"><a class="el" href="dir_0327d24fd86e9ce22567ad8f859e5290.html">mxnet-cpp</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">lr_scheduler.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="lr__scheduler_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * distributed with this work for additional information</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * software distributed under the License is distributed on an</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * specific language governing permissions and limitations</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * under the License.</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> */</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifndef MXNET_CPP_LR_SCHEDULER_H_</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#define MXNET_CPP_LR_SCHEDULER_H_</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "dmlc/logging.h"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">namespace </span><a class="code" href="namespacemxnet.html">mxnet</a> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span>cpp {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1LRScheduler.html"> 36</a></span> <span class="keyword">class </span><a class="code" href="classmxnet_1_1cpp_1_1LRScheduler.html">LRScheduler</a> {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1LRScheduler.html#a18c635d1650fbeb99d85bc271b71e5a7"> 42</a></span>  <span class="keyword">explicit</span> <a class="code" href="classmxnet_1_1cpp_1_1LRScheduler.html#a18c635d1650fbeb99d85bc271b71e5a7">LRScheduler</a>(<span class="keywordtype">float</span> base_lr = 0.01)</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  : <a class="code" href="classmxnet_1_1cpp_1_1LRScheduler.html#a20c6a5521f4216124c1574e093736ac9">base_lr_</a>(base_lr) {}</div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1LRScheduler.html#a575b09dd1c0968867043484704119e7d"> 48</a></span>  <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1cpp_1_1LRScheduler.html#a575b09dd1c0968867043484704119e7d">SetLR</a>(<span class="keyword">const</span> <span class="keywordtype">float</span> lr) { <a class="code" href="classmxnet_1_1cpp_1_1LRScheduler.html#a20c6a5521f4216124c1574e093736ac9">base_lr_</a> = lr; }</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="classmxnet_1_1cpp_1_1LRScheduler.html#a07c2d900f81c46ec56cd1b8558414d38">GetLR</a>(<span class="keywordtype">unsigned</span> num_update) = 0;</div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1LRScheduler.html#a6f269c0118f9d2c34ecd32a29f8e542f"> 56</a></span>  <span class="keyword">virtual</span> <a class="code" href="classmxnet_1_1cpp_1_1LRScheduler.html#a6f269c0118f9d2c34ecd32a29f8e542f">~LRScheduler</a>() {}</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1LRScheduler.html#a20c6a5521f4216124c1574e093736ac9"> 59</a></span>  <span class="keywordtype">float</span> <a class="code" href="classmxnet_1_1cpp_1_1LRScheduler.html#a20c6a5521f4216124c1574e093736ac9">base_lr_</a>;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> };</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1FactorScheduler.html"> 62</a></span> <span class="keyword">class </span><a class="code" href="classmxnet_1_1cpp_1_1FactorScheduler.html">FactorScheduler</a> : <span class="keyword">public</span> <a class="code" href="classmxnet_1_1cpp_1_1LRScheduler.html">LRScheduler</a> {</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1FactorScheduler.html#abaabb6c44a38ac9ee5025c312eead44e"> 64</a></span>  <span class="keyword">explicit</span> <a class="code" href="classmxnet_1_1cpp_1_1FactorScheduler.html#abaabb6c44a38ac9ee5025c312eead44e">FactorScheduler</a>(<span class="keywordtype">int</span> step, <span class="keywordtype">float</span> factor = 1, <span class="keywordtype">float</span> stop_factor_lr = 1e-8)</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  : <a class="code" href="classmxnet_1_1cpp_1_1LRScheduler.html">LRScheduler</a>() {</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  step_ = step;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  factor_ = factor;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  stop_factor_lr_ = stop_factor_lr;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  }</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1FactorScheduler.html#ad8a87343b246727c623f7729d4e9ed6d"> 71</a></span>  <span class="keywordtype">float</span> <a class="code" href="classmxnet_1_1cpp_1_1FactorScheduler.html#ad8a87343b246727c623f7729d4e9ed6d">GetLR</a>(<span class="keywordtype">unsigned</span> num_update)<span class="keyword"> override </span>{</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordflow">while</span> (num_update > <span class="keywordtype">unsigned</span>(count_ + step_)) {</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  count_ += step_;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <a class="code" href="classmxnet_1_1cpp_1_1LRScheduler.html#a20c6a5521f4216124c1574e093736ac9">base_lr_</a> *= factor_;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordflow">if</span> (<a class="code" href="classmxnet_1_1cpp_1_1LRScheduler.html#a20c6a5521f4216124c1574e093736ac9">base_lr_</a> < stop_factor_lr_) {</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <a class="code" href="classmxnet_1_1cpp_1_1LRScheduler.html#a20c6a5521f4216124c1574e093736ac9">base_lr_</a> = stop_factor_lr_;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  LG << <span class="stringliteral">"Update["</span> << num_update << <span class="stringliteral">"]: now learning rate arrived at "</span> \</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  << <a class="code" href="classmxnet_1_1cpp_1_1LRScheduler.html#a20c6a5521f4216124c1574e093736ac9">base_lr_</a> << <span class="stringliteral">", will not change in the future"</span>;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  LG << <span class="stringliteral">"Update["</span> << num_update << <span class="stringliteral">"]: Change learning rate to "</span> << <a class="code" href="classmxnet_1_1cpp_1_1LRScheduler.html#a20c6a5521f4216124c1574e093736ac9">base_lr_</a>;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  }</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  }</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordflow">return</span> <a class="code" href="classmxnet_1_1cpp_1_1LRScheduler.html#a20c6a5521f4216124c1574e093736ac9">base_lr_</a>;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  }</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">int</span> count_ = 0;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">int</span> step_;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">float</span> factor_;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordtype">float</span> stop_factor_lr_;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> };</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> } <span class="comment">// namespace cpp</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> } <span class="comment">// namespace mxnet</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="preprocessor">#endif // MXNET_CPP_LR_SCHEDULER_H_</span></div><div class="ttc" id="classmxnet_1_1cpp_1_1LRScheduler_html_a07c2d900f81c46ec56cd1b8558414d38"><div class="ttname"><a href="classmxnet_1_1cpp_1_1LRScheduler.html#a07c2d900f81c46ec56cd1b8558414d38">mxnet::cpp::LRScheduler::GetLR</a></div><div class="ttdeci">virtual float GetLR(unsigned num_update)=0</div><div class="ttdoc">get a new learning rate </div></div> |
| <div class="ttc" id="namespacemxnet_html"><div class="ttname"><a href="namespacemxnet.html">mxnet</a></div><div class="ttdoc">namespace of mxnet </div><div class="ttdef"><b>Definition:</b> api_registry.h:33</div></div> |
| <div class="ttc" id="classmxnet_1_1cpp_1_1LRScheduler_html"><div class="ttname"><a href="classmxnet_1_1cpp_1_1LRScheduler.html">mxnet::cpp::LRScheduler</a></div><div class="ttdoc">lr scheduler interface </div><div class="ttdef"><b>Definition:</b> lr_scheduler.h:36</div></div> |
| <div class="ttc" id="classmxnet_1_1cpp_1_1FactorScheduler_html_abaabb6c44a38ac9ee5025c312eead44e"><div class="ttname"><a href="classmxnet_1_1cpp_1_1FactorScheduler.html#abaabb6c44a38ac9ee5025c312eead44e">mxnet::cpp::FactorScheduler::FactorScheduler</a></div><div class="ttdeci">FactorScheduler(int step, float factor=1, float stop_factor_lr=1e-8)</div><div class="ttdef"><b>Definition:</b> lr_scheduler.h:64</div></div> |
| <div class="ttc" id="classmxnet_1_1cpp_1_1LRScheduler_html_a18c635d1650fbeb99d85bc271b71e5a7"><div class="ttname"><a href="classmxnet_1_1cpp_1_1LRScheduler.html#a18c635d1650fbeb99d85bc271b71e5a7">mxnet::cpp::LRScheduler::LRScheduler</a></div><div class="ttdeci">LRScheduler(float base_lr=0.01)</div><div class="ttdoc">constructor </div><div class="ttdef"><b>Definition:</b> lr_scheduler.h:42</div></div> |
| <div class="ttc" id="classmxnet_1_1cpp_1_1FactorScheduler_html_ad8a87343b246727c623f7729d4e9ed6d"><div class="ttname"><a href="classmxnet_1_1cpp_1_1FactorScheduler.html#ad8a87343b246727c623f7729d4e9ed6d">mxnet::cpp::FactorScheduler::GetLR</a></div><div class="ttdeci">float GetLR(unsigned num_update) override</div><div class="ttdoc">get a new learning rate </div><div class="ttdef"><b>Definition:</b> lr_scheduler.h:71</div></div> |
| <div class="ttc" id="classmxnet_1_1cpp_1_1LRScheduler_html_a20c6a5521f4216124c1574e093736ac9"><div class="ttname"><a href="classmxnet_1_1cpp_1_1LRScheduler.html#a20c6a5521f4216124c1574e093736ac9">mxnet::cpp::LRScheduler::base_lr_</a></div><div class="ttdeci">float base_lr_</div><div class="ttdef"><b>Definition:</b> lr_scheduler.h:59</div></div> |
| <div class="ttc" id="classmxnet_1_1cpp_1_1LRScheduler_html_a575b09dd1c0968867043484704119e7d"><div class="ttname"><a href="classmxnet_1_1cpp_1_1LRScheduler.html#a575b09dd1c0968867043484704119e7d">mxnet::cpp::LRScheduler::SetLR</a></div><div class="ttdeci">void SetLR(const float lr)</div><div class="ttdoc">set base lr </div><div class="ttdef"><b>Definition:</b> lr_scheduler.h:48</div></div> |
| <div class="ttc" id="classmxnet_1_1cpp_1_1FactorScheduler_html"><div class="ttname"><a href="classmxnet_1_1cpp_1_1FactorScheduler.html">mxnet::cpp::FactorScheduler</a></div><div class="ttdef"><b>Definition:</b> lr_scheduler.h:62</div></div> |
| <div class="ttc" id="classmxnet_1_1cpp_1_1LRScheduler_html_a6f269c0118f9d2c34ecd32a29f8e542f"><div class="ttname"><a href="classmxnet_1_1cpp_1_1LRScheduler.html#a6f269c0118f9d2c34ecd32a29f8e542f">mxnet::cpp::LRScheduler::~LRScheduler</a></div><div class="ttdeci">virtual ~LRScheduler()</div><div class="ttdoc">destructor </div><div class="ttdef"><b>Definition:</b> lr_scheduler.h:56</div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 5 2023 00:58:42 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> |
