Google Git
Sign in
apache / singa-site / be983bc44db8673b80f36c133d1ceb12926645fd / . / content / doxygen / html / optimizer_8h_source.html
blob: 2736e185b33837ced1e90dce9217a70ad4804769 [file] [log] [blame]
<!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>Apache Singa: /home/moaz/incubator-singa/include/singa/model/optimizer.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">Apache Singa
</div>
<div id="projectbrief">A General Distributed Deep Learning Library</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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_14a988756d30161f7e1f48b05d03905d.html">singa</a></li><li class="navelem"><a class="el" href="dir_1ed15e94f94d348ba7de93ac6315cc91.html">model</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">optimizer.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#ifndef SINGA_MODEL_OPTIMIZER_H_</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#define SINGA_MODEL_OPTIMIZER_H_</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;unordered_map&gt;</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &quot;singa/core/tensor.h&quot;</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &quot;singa/proto/model.pb.h&quot;</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">using</span> std::string;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">using</span> std::vector;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="keyword">using</span> std::unordered_map;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacesinga.html">singa</a> {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="keyword">class </span>Constraint;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="keyword">class </span>Regularizer;</div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classsinga_1_1Optimizer.html"> 41</a></span>&#160;<span class="keyword">class </span><a class="code" href="classsinga_1_1Optimizer.html">Optimizer</a> {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <a class="code" href="classsinga_1_1Optimizer.html">Optimizer</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="classsinga_1_1Optimizer.html">Optimizer</a>();</div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classsinga_1_1Optimizer.html#ad0940567e5f2ac6ec99132f2c013c94a"> 47</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Optimizer.html#ad0940567e5f2ac6ec99132f2c013c94a">Setup</a>(<span class="keyword">const</span> <span class="keywordtype">string</span>&amp; str) {</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; OptimizerConf conf;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; conf.ParseFromString(str);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; this-&gt;<a class="code" href="classsinga_1_1Optimizer.html#ad0940567e5f2ac6ec99132f2c013c94a">Setup</a>(conf);</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; }</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Optimizer.html#ad0940567e5f2ac6ec99132f2c013c94a">Setup</a>(<span class="keyword">const</span> OptimizerConf&amp; conf);</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Optimizer.html#a6385d176ba3b2bf744221f8801291f3e">Register</a>(<span class="keyword">const</span> <span class="keywordtype">string</span>&amp; name, <span class="keyword">const</span> ParamSpec&amp; specs);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> ApplyRegularizerConstraint(<span class="keywordtype">int</span> epoch, <span class="keyword">const</span> <span class="keywordtype">string</span>&amp; name,</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keyword">const</span> <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>&amp; value, <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>&amp; grad, <span class="keywordtype">int</span> step = -1);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Optimizer.html#a98c129ff433c9faff924f17618126539">Apply</a>(<span class="keywordtype">int</span> epoch, <span class="keywordtype">float</span> lr, <span class="keyword">const</span> <span class="keywordtype">string</span>&amp; name,</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>&amp; grad, <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>&amp; value, <span class="keywordtype">int</span> step = -1) = 0;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Optimizer.html#a98c129ff433c9faff924f17618126539">Apply</a>(<span class="keywordtype">int</span> epoch, <span class="keyword">const</span> <span class="keywordtype">string</span>&amp; name, <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>&amp; grad, <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>&amp; value,</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keywordtype">int</span> step = -1);</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;</div><div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="classsinga_1_1Optimizer.html#a2f3ba1fe776cdf373565b0cf208bf540"> 81</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Optimizer.html#a2f3ba1fe776cdf373565b0cf208bf540">SetLearningRateGenerator</a>(<span class="keyword">function</span>&lt;<span class="keywordtype">float</span>(<span class="keywordtype">int</span>)&gt; func) {</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; learning_rate_generator_ = func;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; }</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="keywordtype">float</span> GetLearningRate(<span class="keywordtype">int</span> step) {</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keywordflow">if</span> (learning_rate_generator_)</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keywordflow">return</span> learning_rate_generator_(step);</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keywordflow">else</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordflow">return</span> 0;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; }</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keyword">protected</span>:</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; function&lt;float(int)&gt; learning_rate_generator_;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; std::unordered_map&lt;std::string, float&gt; learning_rate_multplier_;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; std::unordered_map&lt;std::string, Constraint*&gt; constraints_;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; std::unordered_map&lt;std::string, Regularizer*&gt; regularizers_;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <a class="code" href="classsinga_1_1Constraint.html">Constraint</a>* constraint_ = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <a class="code" href="classsinga_1_1Regularizer.html">Regularizer</a>* regularizer_ = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; OptimizerConf conf_;</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;};</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;</div><div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="classsinga_1_1Constraint.html"> 106</a></span>&#160;<span class="keyword">class </span><a class="code" href="classsinga_1_1Constraint.html">Constraint</a> {</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <a class="code" href="classsinga_1_1Constraint.html">Constraint</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classsinga_1_1Constraint.html">Constraint</a>(<span class="keyword">const</span> ConstraintConf&amp; conf) { <a class="code" href="classsinga_1_1Optimizer.html#ad0940567e5f2ac6ec99132f2c013c94a">Setup</a>(conf); }</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <a class="code" href="classsinga_1_1Constraint.html">Constraint</a>(<span class="keyword">const</span> <span class="keywordtype">string</span>&amp; type, <span class="keywordtype">float</span> threshold)</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; : type_(type), threshold_(threshold) {}</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Optimizer.html#ad0940567e5f2ac6ec99132f2c013c94a">Setup</a>(<span class="keyword">const</span> ConstraintConf&amp; conf);</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Optimizer.html#ad0940567e5f2ac6ec99132f2c013c94a">Setup</a>(<span class="keyword">const</span> <span class="keywordtype">string</span>&amp; conf_str) {</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; ConstraintConf conf;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; conf.ParseFromString(conf_str);</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; <a class="code" href="classsinga_1_1Optimizer.html#ad0940567e5f2ac6ec99132f2c013c94a">Setup</a>(conf);</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; }</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Optimizer.html#a98c129ff433c9faff924f17618126539">Apply</a>(<span class="keywordtype">int</span> epoch, <span class="keyword">const</span> <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>&amp; value, <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>&amp; grad, <span class="keywordtype">int</span> step = -1);</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Optimizer.html#a98c129ff433c9faff924f17618126539">Apply</a>(<span class="keywordtype">int</span> epoch, <span class="keyword">const</span> vector&lt;Tensor&gt;&amp; values,</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; <span class="keyword">const</span> vector&lt;Tensor&gt;&amp; grads, <span class="keywordtype">int</span> step = -1);</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; <span class="keywordtype">string</span> type_ = <span class="stringliteral">&quot;Unknown&quot;</span>;</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; <span class="keywordtype">float</span> threshold_;</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;};</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;<span class="keyword">inline</span> std::shared_ptr&lt;Constraint&gt; CreateConstraint(std::string type) {</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; <span class="keywordflow">return</span> std::make_shared&lt;Constraint&gt;();</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;}</div><div class="line"><a name="l00142"></a><span class="lineno"><a class="line" href="classsinga_1_1Regularizer.html"> 142</a></span>&#160;<span class="keyword">class </span><a class="code" href="classsinga_1_1Regularizer.html">Regularizer</a> {</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; <a class="code" href="classsinga_1_1Regularizer.html">Regularizer</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classsinga_1_1Regularizer.html">Regularizer</a>(<span class="keyword">const</span> RegularizerConf&amp; conf) { <a class="code" href="classsinga_1_1Optimizer.html#ad0940567e5f2ac6ec99132f2c013c94a">Setup</a>(conf); }</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; <a class="code" href="classsinga_1_1Regularizer.html">Regularizer</a>(<span class="keyword">const</span> <span class="keywordtype">string</span>&amp; type, <span class="keywordtype">float</span> coefficient)</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; : type_(type), coefficient_(coefficient) {}</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Optimizer.html#ad0940567e5f2ac6ec99132f2c013c94a">Setup</a>(<span class="keyword">const</span> RegularizerConf&amp; conf);</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Optimizer.html#ad0940567e5f2ac6ec99132f2c013c94a">Setup</a>(<span class="keyword">const</span> <span class="keywordtype">string</span>&amp; conf_str) {</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; RegularizerConf conf;</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; conf.ParseFromString(conf_str);</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; <a class="code" href="classsinga_1_1Optimizer.html#ad0940567e5f2ac6ec99132f2c013c94a">Setup</a>(conf);</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; }</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160;</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Optimizer.html#a98c129ff433c9faff924f17618126539">Apply</a>(<span class="keywordtype">int</span> epoch, <span class="keyword">const</span> <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>&amp; value, <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>&amp; grad, <span class="keywordtype">int</span> step = -1);</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Optimizer.html#a98c129ff433c9faff924f17618126539">Apply</a>(<span class="keywordtype">int</span> epoch, <span class="keyword">const</span> vector&lt;Tensor&gt;&amp; values,</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; <span class="keyword">const</span> vector&lt;Tensor&gt;&amp; grads, <span class="keywordtype">int</span> step = -1);</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160;</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; <span class="keywordtype">string</span> type_ = <span class="stringliteral">&quot;NotSet&quot;</span>;</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; <span class="keywordtype">float</span> coefficient_;</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160;};</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160;<span class="keyword">inline</span> std::shared_ptr&lt;Regularizer&gt; CreateRegularizer(std::string type) {</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160; <span class="keywordflow">return</span> std::make_shared&lt;Regularizer&gt;();</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160;}</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160;</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160;</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160;</div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160;<span class="comment">// =============Vallina SGD with Momentum=====================================</span></div><div class="line"><a name="l00178"></a><span class="lineno"><a class="line" href="classsinga_1_1SGD.html"> 178</a></span>&#160;<span class="keyword">class </span><a class="code" href="classsinga_1_1SGD.html">SGD</a> : <span class="keyword">public</span> <a class="code" href="classsinga_1_1Optimizer.html">Optimizer</a> {</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Optimizer.html#ad0940567e5f2ac6ec99132f2c013c94a">Setup</a>(<span class="keyword">const</span> OptimizerConf&amp; conf);</div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Optimizer.html#a98c129ff433c9faff924f17618126539">Apply</a>(<span class="keywordtype">int</span> epoch, <span class="keywordtype">float</span> lr, <span class="keyword">const</span> <span class="keywordtype">string</span>&amp; name, <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>&amp; grad,</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160; <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>&amp; value, <span class="keywordtype">int</span> step = -1) <span class="keyword">override</span>;</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160;</div><div class="line"><a name="l00187"></a><span class="lineno"><a class="line" href="classsinga_1_1SGD.html#a70d7de98ba845ff4deb46f0e1301a34c"> 187</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1SGD.html#a70d7de98ba845ff4deb46f0e1301a34c">SetMomentumGenerator</a>(std::function&lt;<span class="keywordtype">float</span>(<span class="keywordtype">int</span>)&gt; func) {</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; momentum_generator_ = func;</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160; }</div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160;</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160; std::unordered_map&lt;string, Tensor&gt; history_gradient_;</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160; std::function&lt;float(int)&gt; momentum_generator_;</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160;};</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160;</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160;<span class="comment">// =============Nesterov======================================================</span></div><div class="line"><a name="l00197"></a><span class="lineno"><a class="line" href="classsinga_1_1Nesterov.html"> 197</a></span>&#160;<span class="keyword">class </span><a class="code" href="classsinga_1_1Nesterov.html">Nesterov</a> : <span class="keyword">public</span> <a class="code" href="classsinga_1_1Optimizer.html">Optimizer</a> {</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Optimizer.html#ad0940567e5f2ac6ec99132f2c013c94a">Setup</a>(<span class="keyword">const</span> OptimizerConf&amp; conf);</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Optimizer.html#a98c129ff433c9faff924f17618126539">Apply</a>(<span class="keywordtype">int</span> epoch, <span class="keywordtype">float</span> lr, <span class="keyword">const</span> <span class="keywordtype">string</span>&amp; name, <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>&amp; grad,</div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160; <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>&amp; value, <span class="keywordtype">int</span> step = -1) <span class="keyword">override</span>;</div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160;</div><div class="line"><a name="l00206"></a><span class="lineno"><a class="line" href="classsinga_1_1Nesterov.html#a2ffcfb0b5c20aeaa7af40254bcf85396"> 206</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Nesterov.html#a2ffcfb0b5c20aeaa7af40254bcf85396">SetMomentumGenerator</a>(std::function&lt;<span class="keywordtype">float</span>(<span class="keywordtype">int</span>)&gt; func) {</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160; momentum_generator_ = func;</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160; }</div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span>&#160;</div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span>&#160; std::unordered_map&lt;string, Tensor&gt; history_gradient_;</div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span>&#160; std::function&lt;float(int)&gt; momentum_generator_;</div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span>&#160;};</div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span>&#160;</div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160;<span class="comment">// =============Adagrad=======================================================</span></div><div class="line"><a name="l00216"></a><span class="lineno"><a class="line" href="classsinga_1_1AdaGrad.html"> 216</a></span>&#160;<span class="keyword">class </span><a class="code" href="classsinga_1_1AdaGrad.html">AdaGrad</a> : <span class="keyword">public</span> <a class="code" href="classsinga_1_1Optimizer.html">Optimizer</a> {</div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Optimizer.html#ad0940567e5f2ac6ec99132f2c013c94a">Setup</a>(<span class="keyword">const</span> OptimizerConf&amp; conf);</div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Optimizer.html#a98c129ff433c9faff924f17618126539">Apply</a>(<span class="keywordtype">int</span> epoch, <span class="keywordtype">float</span> lr, <span class="keyword">const</span> <span class="keywordtype">string</span>&amp; name, <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>&amp; grad,</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span>&#160; <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>&amp; value, <span class="keywordtype">int</span> step = -1) <span class="keyword">override</span>;</div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span>&#160;</div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span>&#160; std::unordered_map&lt;string, Tensor&gt; history_gradient_;</div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160; <span class="keywordtype">float</span> delta_;</div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160;};</div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span>&#160;<span class="comment">// =============RMSProp=======================================================</span></div><div class="line"><a name="l00228"></a><span class="lineno"><a class="line" href="classsinga_1_1RMSProp.html"> 228</a></span>&#160;<span class="keyword">class </span><a class="code" href="classsinga_1_1RMSProp.html">RMSProp</a> : <span class="keyword">public</span> <a class="code" href="classsinga_1_1Optimizer.html">Optimizer</a> {</div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Optimizer.html#ad0940567e5f2ac6ec99132f2c013c94a">Setup</a>(<span class="keyword">const</span> OptimizerConf&amp; conf);</div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classsinga_1_1Optimizer.html#a98c129ff433c9faff924f17618126539">Apply</a>(<span class="keywordtype">int</span> epoch, <span class="keywordtype">float</span> lr, <span class="keyword">const</span> <span class="keywordtype">string</span>&amp; name, <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>&amp; grad,</div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span>&#160; <a class="code" href="classsinga_1_1Tensor.html">Tensor</a>&amp; value, <span class="keywordtype">int</span> step = -1) <span class="keyword">override</span>;</div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="classsinga_1_1RMSProp.html">RMSProp</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span>&#160;</div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span>&#160; std::unordered_map&lt;string, Tensor&gt; history_gradient_;</div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span>&#160; <span class="keywordtype">float</span> delta_, rho_;</div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span>&#160;};</div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span>&#160;</div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span>&#160;</div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span>&#160;<span class="keyword">inline</span> std::shared_ptr&lt;Optimizer&gt; CreateOptimizer(<span class="keyword">const</span> <span class="keywordtype">string</span>&amp; type) {</div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span>&#160; std::shared_ptr&lt;Optimizer&gt; opt;</div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span>&#160; <span class="keywordflow">if</span> (type == <span class="stringliteral">&quot;SGD&quot;</span>)</div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span>&#160; opt = std::shared_ptr&lt;Optimizer&gt;(<span class="keyword">new</span> <a class="code" href="classsinga_1_1SGD.html">SGD</a>());</div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span>&#160; <span class="keywordflow">else</span> <span class="keywordflow">if</span> (type == <span class="stringliteral">&quot;RMSProp&quot;</span>)</div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span>&#160; opt = std::shared_ptr&lt;Optimizer&gt;(<span class="keyword">new</span> <a class="code" href="classsinga_1_1RMSProp.html">RMSProp</a>());</div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span>&#160; <span class="keywordflow">else</span> <span class="keywordflow">if</span> (type == <span class="stringliteral">&quot;AdaGrad&quot;</span>)</div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span>&#160; opt = std::shared_ptr&lt;Optimizer&gt;(<span class="keyword">new</span> <a class="code" href="classsinga_1_1AdaGrad.html">AdaGrad</a>());</div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span>&#160; <span class="keywordflow">else</span> <span class="keywordflow">if</span> (type == <span class="stringliteral">&quot;Nesterov&quot;</span>)</div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span>&#160; opt = std::shared_ptr&lt;Optimizer&gt;(<span class="keyword">new</span> <a class="code" href="classsinga_1_1Nesterov.html">Nesterov</a>());</div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span>&#160; <span class="keywordflow">else</span></div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span>&#160; LOG(FATAL) &lt;&lt; <span class="stringliteral">&quot;Unknown optimizer type : &quot;</span> &lt;&lt; type;</div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span>&#160; <span class="keywordflow">return</span> opt;</div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span>&#160;}</div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span>&#160;<span class="comment">// ============LocalAllReduce for single node multiple workers ==============</span></div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span>&#160;<span class="comment"></span><span class="comment">/*</span></div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span>&#160;<span class="comment">class LocalAllReduce : public Optimizer{</span></div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span>&#160;<span class="comment"> pulbic:</span></div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span>&#160;<span class="comment"> LocalAllReduce(Optimizer* opt);</span></div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span>&#160;<span class="comment"> void Setup(const string&amp; str) {</span></div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span>&#160;<span class="comment"> AllReduce conf;</span></div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span>&#160;<span class="comment"> conf.ParseFromString(str);</span></div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span>&#160;<span class="comment"> this-&gt;Setup(conf);</span></div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span>&#160;<span class="comment"> }</span></div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span>&#160;<span class="comment"> void Setup(const AllReduce&amp; conf) {}</span></div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span>&#160;<span class="comment">register the specs</span></div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span>&#160;<span class="comment"> void Register(const vector&lt;string&gt;&amp; names,</span></div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span>&#160;<span class="comment"> const vector&lt;Tensor&gt;&amp; values,</span></div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span>&#160;<span class="comment"> const vector&lt;ParamSpecs&gt;&amp; specs) override;</span></div><div class="line"><a name="l00287"></a><span class="lineno"> 287</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span>&#160;<span class="comment"> void Update(int step, float lr, const string&amp; name, const Tensor&amp; grad,</span></div><div class="line"><a name="l00294"></a><span class="lineno"> 294</span>&#160;<span class="comment"> Tensor* param) override;</span></div><div class="line"><a name="l00295"></a><span class="lineno"> 295</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00300"></a><span class="lineno"> 300</span>&#160;<span class="comment"> boo UpdateNow();</span></div><div class="line"><a name="l00301"></a><span class="lineno"> 301</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00302"></a><span class="lineno"> 302</span>&#160;<span class="comment"> private:</span></div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span>&#160;<span class="comment"> int nb_workers_;</span></div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span>&#160;<span class="comment"> vector&lt;Tensor&gt; aggregated_gradients_;</span></div><div class="line"><a name="l00305"></a><span class="lineno"> 305</span>&#160;<span class="comment">};</span></div><div class="line"><a name="l00306"></a><span class="lineno"> 306</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span>&#160;}</div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span>&#160;<span class="preprocessor">#endif // SINGA_MODEL_OPTIMIZER_H_</span></div><div class="ttc" id="classsinga_1_1Optimizer_html_a98c129ff433c9faff924f17618126539"><div class="ttname"><a href="classsinga_1_1Optimizer.html#a98c129ff433c9faff924f17618126539">singa::Optimizer::Apply</a></div><div class="ttdeci">virtual void Apply(int epoch, float lr, const string &amp;name, Tensor &amp;grad, Tensor &amp;value, int step=-1)=0</div><div class="ttdoc">Apply the updating algorithm if the gradient is not empty. </div></div>
<div class="ttc" id="classsinga_1_1Tensor_html"><div class="ttname"><a href="classsinga_1_1Tensor.html">singa::Tensor</a></div><div class="ttdoc">A Tensor instance is a multi-dimensional array resident on a Device (default device is the host CPU)...</div><div class="ttdef"><b>Definition:</b> tensor.h:56</div></div>
<div class="ttc" id="classsinga_1_1Constraint_html"><div class="ttname"><a href="classsinga_1_1Constraint.html">singa::Constraint</a></div><div class="ttdoc">Apply constraints for parameters (gradient). </div><div class="ttdef"><b>Definition:</b> optimizer.h:106</div></div>
<div class="ttc" id="classsinga_1_1Regularizer_html"><div class="ttname"><a href="classsinga_1_1Regularizer.html">singa::Regularizer</a></div><div class="ttdoc">Apply regularization for parameters (gradient), e.g., L1 norm and L2 norm. </div><div class="ttdef"><b>Definition:</b> optimizer.h:142</div></div>
<div class="ttc" id="classsinga_1_1Nesterov_html"><div class="ttname"><a href="classsinga_1_1Nesterov.html">singa::Nesterov</a></div><div class="ttdef"><b>Definition:</b> optimizer.h:197</div></div>
<div class="ttc" id="classsinga_1_1Nesterov_html_a2ffcfb0b5c20aeaa7af40254bcf85396"><div class="ttname"><a href="classsinga_1_1Nesterov.html#a2ffcfb0b5c20aeaa7af40254bcf85396">singa::Nesterov::SetMomentumGenerator</a></div><div class="ttdeci">void SetMomentumGenerator(std::function&lt; float(int)&gt; func)</div><div class="ttdoc">The argument function returns the momentum value given the current running step (i.e., iterations/mini-batches). </div><div class="ttdef"><b>Definition:</b> optimizer.h:206</div></div>
<div class="ttc" id="classsinga_1_1Optimizer_html_a6385d176ba3b2bf744221f8801291f3e"><div class="ttname"><a href="classsinga_1_1Optimizer.html#a6385d176ba3b2bf744221f8801291f3e">singa::Optimizer::Register</a></div><div class="ttdeci">virtual void Register(const string &amp;name, const ParamSpec &amp;specs)</div><div class="ttdoc">Register the parameter, e.g., create Constraint and Regularizers. </div></div>
<div class="ttc" id="classsinga_1_1RMSProp_html"><div class="ttname"><a href="classsinga_1_1RMSProp.html">singa::RMSProp</a></div><div class="ttdef"><b>Definition:</b> optimizer.h:228</div></div>
<div class="ttc" id="classsinga_1_1Optimizer_html_a2f3ba1fe776cdf373565b0cf208bf540"><div class="ttname"><a href="classsinga_1_1Optimizer.html#a2f3ba1fe776cdf373565b0cf208bf540">singa::Optimizer::SetLearningRateGenerator</a></div><div class="ttdeci">void SetLearningRateGenerator(function&lt; float(int)&gt; func)</div><div class="ttdoc">The argument is a function that returns the learning rate given the current step (i.e., curren running iteration). </div><div class="ttdef"><b>Definition:</b> optimizer.h:81</div></div>
<div class="ttc" id="classsinga_1_1SGD_html_a70d7de98ba845ff4deb46f0e1301a34c"><div class="ttname"><a href="classsinga_1_1SGD.html#a70d7de98ba845ff4deb46f0e1301a34c">singa::SGD::SetMomentumGenerator</a></div><div class="ttdeci">void SetMomentumGenerator(std::function&lt; float(int)&gt; func)</div><div class="ttdoc">The argument function returns the momentum value given the current running step (i.e., iterations/mini-batches). </div><div class="ttdef"><b>Definition:</b> optimizer.h:187</div></div>
<div class="ttc" id="classsinga_1_1Optimizer_html_ad0940567e5f2ac6ec99132f2c013c94a"><div class="ttname"><a href="classsinga_1_1Optimizer.html#ad0940567e5f2ac6ec99132f2c013c94a">singa::Optimizer::Setup</a></div><div class="ttdeci">void Setup(const string &amp;str)</div><div class="ttdoc">Setup the optimzier using configurations from serialized string (for binding languages). </div><div class="ttdef"><b>Definition:</b> optimizer.h:47</div></div>
<div class="ttc" id="namespacesinga_html"><div class="ttname"><a href="namespacesinga.html">singa</a></div><div class="ttdoc">Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements...</div><div class="ttdef"><b>Definition:</b> common.h:48</div></div>
<div class="ttc" id="classsinga_1_1SGD_html"><div class="ttname"><a href="classsinga_1_1SGD.html">singa::SGD</a></div><div class="ttdef"><b>Definition:</b> optimizer.h:178</div></div>
<div class="ttc" id="classsinga_1_1Optimizer_html"><div class="ttname"><a href="classsinga_1_1Optimizer.html">singa::Optimizer</a></div><div class="ttdoc">The base class for gradient descent algorithms used to update the model parameters in order to optimi...</div><div class="ttdef"><b>Definition:</b> optimizer.h:41</div></div>
<div class="ttc" id="classsinga_1_1AdaGrad_html"><div class="ttname"><a href="classsinga_1_1AdaGrad.html">singa::AdaGrad</a></div><div class="ttdef"><b>Definition:</b> optimizer.h:216</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Apr 22 2019 12:27:05 for Apache Singa by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>