143 lines
38 KiB
HTML
143 lines
38 KiB
HTML
<!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.11"/>
|
|
<title>mlpack: src/mlpack/core/optimizers/adam/adam.hpp 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>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="extra-stylesheet.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">mlpack
|
|
 <span id="projectnumber">master</span>
|
|
</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 id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>File Members</span></a></li>
|
|
</ul>
|
|
</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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_44a936ef30fc126706c6284a2fc0c990.html">mlpack</a></li><li class="navelem"><a class="el" href="dir_f7ac9cdfd28b2e882eb44d163e3b98b4.html">core</a></li><li class="navelem"><a class="el" href="dir_c92267e6eea9957c44bb2efde721ca22.html">optimizers</a></li><li class="navelem"><a class="el" href="dir_3e726917654401abf235b4ebf3621f0a.html">adam</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">adam.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="adam_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#ifndef __MLPACK_CORE_OPTIMIZERS_ADAM_ADAM_HPP</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#define __MLPACK_CORE_OPTIMIZERS_ADAM_ADAM_HPP</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <<a class="code" href="prereqs_8hpp.html">mlpack/prereqs.hpp</a>></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">namespace </span><a class="code" href="namespacemlpack.html">mlpack</a> {</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">namespace </span>optimization {</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keyword">template</span><<span class="keyword">typename</span> DecomposableFunctionType></div><div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1Adam.html"> 65</a></span> <span class="keyword">class </span><a class="code" href="classmlpack_1_1optimization_1_1Adam.html">Adam</a></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> {</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#a505d3a8f04c5f59677b456a29f5921c9">Adam</a>(DecomposableFunctionType& <span class="keyword">function</span>,</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">const</span> <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#a78eb21d8bb4f31a559635f881b88c3af">stepSize</a> = 0.001,</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keyword">const</span> <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#afa2dd9b21d0942283d5243ce1d319b70">beta1</a> = 0.9,</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keyword">const</span> <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#adef01fba112e464a7d1d8e92a81aaadb">beta2</a> = 0.999,</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">const</span> <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#a034aa918d9a0b60c392ceecaea2f7ef8">eps</a> = 1e-8,</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#aa787186bf9e208864c265f771b142450">maxIterations</a> = 100000,</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keyword">const</span> <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#a5e2bb73d504950407ecdc5780cdaff0d">tolerance</a> = 1e-5,</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">const</span> <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#a10d379c675624ea5fcfed3990469f227">shuffle</a> = <span class="keyword">true</span>,</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keyword">const</span> <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#affc1110c741360c3be99cf150058fb6d">adaMax</a> = <span class="keyword">false</span>);</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#a7c378485d3abc4570a4ff99071c03bbd">Optimize</a>(arma::mat& iterate);</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00111"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1Adam.html#a27a671448a1a2ed681ca31746686c3c8"> 111</a></span>  <span class="keyword">const</span> DecomposableFunctionType& <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#a27a671448a1a2ed681ca31746686c3c8">Function</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">function</span>; }</div><div class="line"><a name="l00113"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1Adam.html#a0d72d275a978a23cb4c9a5f556ce7a8e"> 113</a></span>  DecomposableFunctionType& <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#a0d72d275a978a23cb4c9a5f556ce7a8e">Function</a>() { <span class="keywordflow">return</span> <span class="keyword">function</span>; }</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div><div class="line"><a name="l00116"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1Adam.html#a4f3945c5c625d4979a7cf1f31561867b"> 116</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#a4f3945c5c625d4979a7cf1f31561867b">StepSize</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#a78eb21d8bb4f31a559635f881b88c3af">stepSize</a>; }</div><div class="line"><a name="l00118"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1Adam.html#aede55fc25b025637bc414dc679b1a576"> 118</a></span>  <span class="keywordtype">double</span>& <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#aede55fc25b025637bc414dc679b1a576">StepSize</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#a78eb21d8bb4f31a559635f881b88c3af">stepSize</a>; }</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div><div class="line"><a name="l00121"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1Adam.html#ad538e121215045522d3e502832e0e073"> 121</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#ad538e121215045522d3e502832e0e073">Beta1</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#afa2dd9b21d0942283d5243ce1d319b70">beta1</a>; }</div><div class="line"><a name="l00123"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1Adam.html#ad20f27515ccd3de39787edb97c05f165"> 123</a></span>  <span class="keywordtype">double</span>& <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#ad20f27515ccd3de39787edb97c05f165">Beta1</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#afa2dd9b21d0942283d5243ce1d319b70">beta1</a>; }</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00126"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1Adam.html#a369459b40c453cd8f9f1162361e9d70c"> 126</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#a369459b40c453cd8f9f1162361e9d70c">Beta2</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#adef01fba112e464a7d1d8e92a81aaadb">beta2</a>; }</div><div class="line"><a name="l00128"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1Adam.html#abeaaf93a97f99eb8c7e73f24764e74cc"> 128</a></span>  <span class="keywordtype">double</span>& <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#abeaaf93a97f99eb8c7e73f24764e74cc">Beta2</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#adef01fba112e464a7d1d8e92a81aaadb">beta2</a>; }</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div><div class="line"><a name="l00131"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1Adam.html#a71178e9a83c6a2bfebd29037cf9a377b"> 131</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#a71178e9a83c6a2bfebd29037cf9a377b">Epsilon</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#a034aa918d9a0b60c392ceecaea2f7ef8">eps</a>; }</div><div class="line"><a name="l00133"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1Adam.html#a5383ad9795720cf9fe216c109055e835"> 133</a></span>  <span class="keywordtype">double</span>& <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#a5383ad9795720cf9fe216c109055e835">Epsilon</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#a034aa918d9a0b60c392ceecaea2f7ef8">eps</a>; }</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div><div class="line"><a name="l00136"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1Adam.html#a2c6089a426b12a338dfd1578db148b86"> 136</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#a2c6089a426b12a338dfd1578db148b86">MaxIterations</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#aa787186bf9e208864c265f771b142450">maxIterations</a>; }</div><div class="line"><a name="l00138"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1Adam.html#af65e3e290bbf7ee1c3b95b119e2f9bea"> 138</a></span>  <span class="keywordtype">size_t</span>& <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#af65e3e290bbf7ee1c3b95b119e2f9bea">MaxIterations</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#aa787186bf9e208864c265f771b142450">maxIterations</a>; }</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div><div class="line"><a name="l00141"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1Adam.html#a8eda9c96d536058a2e64831e9ff91e72"> 141</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#a8eda9c96d536058a2e64831e9ff91e72">Tolerance</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#a5e2bb73d504950407ecdc5780cdaff0d">tolerance</a>; }</div><div class="line"><a name="l00143"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1Adam.html#a87ec9ebf00a64f81c2f4a2fe76e17648"> 143</a></span>  <span class="keywordtype">double</span>& <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#a87ec9ebf00a64f81c2f4a2fe76e17648">Tolerance</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#a5e2bb73d504950407ecdc5780cdaff0d">tolerance</a>; }</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div><div class="line"><a name="l00146"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1Adam.html#aa31296e322e6041a8b3496f783734c79"> 146</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#aa31296e322e6041a8b3496f783734c79">Shuffle</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#a10d379c675624ea5fcfed3990469f227">shuffle</a>; }</div><div class="line"><a name="l00148"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1Adam.html#aacf9ce0ffd3c4176daba05e7819864ea"> 148</a></span>  <span class="keywordtype">bool</span>& <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#aacf9ce0ffd3c4176daba05e7819864ea">Shuffle</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#a10d379c675624ea5fcfed3990469f227">shuffle</a>; }</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div><div class="line"><a name="l00151"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1Adam.html#a997272dbb67581475e614e6bd9b8da61"> 151</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#a997272dbb67581475e614e6bd9b8da61">AdaMax</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#affc1110c741360c3be99cf150058fb6d">adaMax</a>; }</div><div class="line"><a name="l00153"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1Adam.html#ab88d5a769f447ac07bc298b30586179a"> 153</a></span>  <span class="keywordtype">bool</span>& <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#ab88d5a769f447ac07bc298b30586179a">AdaMax</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#affc1110c741360c3be99cf150058fb6d">adaMax</a>; }</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> </div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00157"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1Adam.html#af308f2c8a08bdfe130d0c6fd6a1f7b67"> 157</a></span>  DecomposableFunctionType& <span class="keyword">function</span>;</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> </div><div class="line"><a name="l00160"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1Adam.html#a78eb21d8bb4f31a559635f881b88c3af"> 160</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#a78eb21d8bb4f31a559635f881b88c3af">stepSize</a>;</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> </div><div class="line"><a name="l00163"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1Adam.html#afa2dd9b21d0942283d5243ce1d319b70"> 163</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#afa2dd9b21d0942283d5243ce1d319b70">beta1</a>;</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> </div><div class="line"><a name="l00166"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1Adam.html#adef01fba112e464a7d1d8e92a81aaadb"> 166</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#adef01fba112e464a7d1d8e92a81aaadb">beta2</a>;</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> </div><div class="line"><a name="l00169"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1Adam.html#a034aa918d9a0b60c392ceecaea2f7ef8"> 169</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#a034aa918d9a0b60c392ceecaea2f7ef8">eps</a>;</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> </div><div class="line"><a name="l00172"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1Adam.html#aa787186bf9e208864c265f771b142450"> 172</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#aa787186bf9e208864c265f771b142450">maxIterations</a>;</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> </div><div class="line"><a name="l00175"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1Adam.html#a5e2bb73d504950407ecdc5780cdaff0d"> 175</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#a5e2bb73d504950407ecdc5780cdaff0d">tolerance</a>;</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> </div><div class="line"><a name="l00179"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1Adam.html#a10d379c675624ea5fcfed3990469f227"> 179</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#a10d379c675624ea5fcfed3990469f227">shuffle</a>;</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> </div><div class="line"><a name="l00182"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1Adam.html#affc1110c741360c3be99cf150058fb6d"> 182</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1optimization_1_1Adam.html#affc1110c741360c3be99cf150058fb6d">adaMax</a>;</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> };</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> </div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> } <span class="comment">// namespace optimization</span></div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> } <span class="comment">// namespace mlpack</span></div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> </div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment">// Include implementation.</span></div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="preprocessor">#include "adam_impl.hpp"</span></div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> </div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classmlpack_1_1optimization_1_1Adam_html_a369459b40c453cd8f9f1162361e9d70c"><div class="ttname"><a href="classmlpack_1_1optimization_1_1Adam.html#a369459b40c453cd8f9f1162361e9d70c">mlpack::optimization::Adam::Beta2</a></div><div class="ttdeci">double Beta2() const </div><div class="ttdoc">Get the second moment coefficient. </div><div class="ttdef"><b>Definition:</b> <a href="adam_8hpp_source.html#l00126">adam.hpp:126</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1Adam_html_a27a671448a1a2ed681ca31746686c3c8"><div class="ttname"><a href="classmlpack_1_1optimization_1_1Adam.html#a27a671448a1a2ed681ca31746686c3c8">mlpack::optimization::Adam::Function</a></div><div class="ttdeci">const DecomposableFunctionType & Function() const </div><div class="ttdoc">Get the instantiated function to be optimized. </div><div class="ttdef"><b>Definition:</b> <a href="adam_8hpp_source.html#l00111">adam.hpp:111</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1Adam_html_a0d72d275a978a23cb4c9a5f556ce7a8e"><div class="ttname"><a href="classmlpack_1_1optimization_1_1Adam.html#a0d72d275a978a23cb4c9a5f556ce7a8e">mlpack::optimization::Adam::Function</a></div><div class="ttdeci">DecomposableFunctionType & Function()</div><div class="ttdoc">Modify the instantiated function. </div><div class="ttdef"><b>Definition:</b> <a href="adam_8hpp_source.html#l00113">adam.hpp:113</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1Adam_html_a034aa918d9a0b60c392ceecaea2f7ef8"><div class="ttname"><a href="classmlpack_1_1optimization_1_1Adam.html#a034aa918d9a0b60c392ceecaea2f7ef8">mlpack::optimization::Adam::eps</a></div><div class="ttdeci">double eps</div><div class="ttdoc">The value used to initialise the mean squared gradient parameter. </div><div class="ttdef"><b>Definition:</b> <a href="adam_8hpp_source.html#l00169">adam.hpp:169</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1Adam_html_aa787186bf9e208864c265f771b142450"><div class="ttname"><a href="classmlpack_1_1optimization_1_1Adam.html#aa787186bf9e208864c265f771b142450">mlpack::optimization::Adam::maxIterations</a></div><div class="ttdeci">size_t maxIterations</div><div class="ttdoc">The maximum number of allowed iterations. </div><div class="ttdef"><b>Definition:</b> <a href="adam_8hpp_source.html#l00172">adam.hpp:172</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1Adam_html_a10d379c675624ea5fcfed3990469f227"><div class="ttname"><a href="classmlpack_1_1optimization_1_1Adam.html#a10d379c675624ea5fcfed3990469f227">mlpack::optimization::Adam::shuffle</a></div><div class="ttdeci">bool shuffle</div><div class="ttdoc">Controls whether or not the individual functions are shuffled when iterating. </div><div class="ttdef"><b>Definition:</b> <a href="adam_8hpp_source.html#l00179">adam.hpp:179</a></div></div>
|
|
<div class="ttc" id="namespacemlpack_html"><div class="ttname"><a href="namespacemlpack.html">mlpack</a></div><div class="ttdoc">Linear algebra utility functions, generally performed on matrices or vectors. </div><div class="ttdef"><b>Definition:</b> <a href="binarize_8hpp_source.html#l00018">binarize.hpp:18</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1Adam_html_a2c6089a426b12a338dfd1578db148b86"><div class="ttname"><a href="classmlpack_1_1optimization_1_1Adam.html#a2c6089a426b12a338dfd1578db148b86">mlpack::optimization::Adam::MaxIterations</a></div><div class="ttdeci">size_t MaxIterations() const </div><div class="ttdoc">Get the maximum number of iterations (0 indicates no limit). </div><div class="ttdef"><b>Definition:</b> <a href="adam_8hpp_source.html#l00136">adam.hpp:136</a></div></div>
|
|
<div class="ttc" id="prereqs_8hpp_html"><div class="ttname"><a href="prereqs_8hpp.html">prereqs.hpp</a></div><div class="ttdoc">The core includes that mlpack expects; standard C++ includes and Armadillo. </div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1Adam_html_abeaaf93a97f99eb8c7e73f24764e74cc"><div class="ttname"><a href="classmlpack_1_1optimization_1_1Adam.html#abeaaf93a97f99eb8c7e73f24764e74cc">mlpack::optimization::Adam::Beta2</a></div><div class="ttdeci">double & Beta2()</div><div class="ttdoc">Modify the second moment coefficient. </div><div class="ttdef"><b>Definition:</b> <a href="adam_8hpp_source.html#l00128">adam.hpp:128</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1Adam_html_affc1110c741360c3be99cf150058fb6d"><div class="ttname"><a href="classmlpack_1_1optimization_1_1Adam.html#affc1110c741360c3be99cf150058fb6d">mlpack::optimization::Adam::adaMax</a></div><div class="ttdeci">bool adaMax</div><div class="ttdoc">Specifies whether or not the AdaMax optimizer is to be used. </div><div class="ttdef"><b>Definition:</b> <a href="adam_8hpp_source.html#l00182">adam.hpp:182</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1Adam_html_af65e3e290bbf7ee1c3b95b119e2f9bea"><div class="ttname"><a href="classmlpack_1_1optimization_1_1Adam.html#af65e3e290bbf7ee1c3b95b119e2f9bea">mlpack::optimization::Adam::MaxIterations</a></div><div class="ttdeci">size_t & MaxIterations()</div><div class="ttdoc">Modify the maximum number of iterations (0 indicates no limit). </div><div class="ttdef"><b>Definition:</b> <a href="adam_8hpp_source.html#l00138">adam.hpp:138</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1Adam_html_a78eb21d8bb4f31a559635f881b88c3af"><div class="ttname"><a href="classmlpack_1_1optimization_1_1Adam.html#a78eb21d8bb4f31a559635f881b88c3af">mlpack::optimization::Adam::stepSize</a></div><div class="ttdeci">double stepSize</div><div class="ttdoc">The step size for each example. </div><div class="ttdef"><b>Definition:</b> <a href="adam_8hpp_source.html#l00160">adam.hpp:160</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1Adam_html_a71178e9a83c6a2bfebd29037cf9a377b"><div class="ttname"><a href="classmlpack_1_1optimization_1_1Adam.html#a71178e9a83c6a2bfebd29037cf9a377b">mlpack::optimization::Adam::Epsilon</a></div><div class="ttdeci">double Epsilon() const </div><div class="ttdoc">Get the value used to initialise the mean squared gradient parameter. </div><div class="ttdef"><b>Definition:</b> <a href="adam_8hpp_source.html#l00131">adam.hpp:131</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1Adam_html_a5e2bb73d504950407ecdc5780cdaff0d"><div class="ttname"><a href="classmlpack_1_1optimization_1_1Adam.html#a5e2bb73d504950407ecdc5780cdaff0d">mlpack::optimization::Adam::tolerance</a></div><div class="ttdeci">double tolerance</div><div class="ttdoc">The tolerance for termination. </div><div class="ttdef"><b>Definition:</b> <a href="adam_8hpp_source.html#l00175">adam.hpp:175</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1Adam_html_aa31296e322e6041a8b3496f783734c79"><div class="ttname"><a href="classmlpack_1_1optimization_1_1Adam.html#aa31296e322e6041a8b3496f783734c79">mlpack::optimization::Adam::Shuffle</a></div><div class="ttdeci">bool Shuffle() const </div><div class="ttdoc">Get whether or not the individual functions are shuffled. </div><div class="ttdef"><b>Definition:</b> <a href="adam_8hpp_source.html#l00146">adam.hpp:146</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1Adam_html_ab88d5a769f447ac07bc298b30586179a"><div class="ttname"><a href="classmlpack_1_1optimization_1_1Adam.html#ab88d5a769f447ac07bc298b30586179a">mlpack::optimization::Adam::AdaMax</a></div><div class="ttdeci">bool & AdaMax()</div><div class="ttdoc">Modify wehther or not the AdaMax optimizer is to be used. </div><div class="ttdef"><b>Definition:</b> <a href="adam_8hpp_source.html#l00153">adam.hpp:153</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1Adam_html_ad538e121215045522d3e502832e0e073"><div class="ttname"><a href="classmlpack_1_1optimization_1_1Adam.html#ad538e121215045522d3e502832e0e073">mlpack::optimization::Adam::Beta1</a></div><div class="ttdeci">double Beta1() const </div><div class="ttdoc">Get the smoothing parameter. </div><div class="ttdef"><b>Definition:</b> <a href="adam_8hpp_source.html#l00121">adam.hpp:121</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1Adam_html_a87ec9ebf00a64f81c2f4a2fe76e17648"><div class="ttname"><a href="classmlpack_1_1optimization_1_1Adam.html#a87ec9ebf00a64f81c2f4a2fe76e17648">mlpack::optimization::Adam::Tolerance</a></div><div class="ttdeci">double & Tolerance()</div><div class="ttdoc">Modify the tolerance for termination. </div><div class="ttdef"><b>Definition:</b> <a href="adam_8hpp_source.html#l00143">adam.hpp:143</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1Adam_html_ad20f27515ccd3de39787edb97c05f165"><div class="ttname"><a href="classmlpack_1_1optimization_1_1Adam.html#ad20f27515ccd3de39787edb97c05f165">mlpack::optimization::Adam::Beta1</a></div><div class="ttdeci">double & Beta1()</div><div class="ttdoc">Modify the smoothing parameter. </div><div class="ttdef"><b>Definition:</b> <a href="adam_8hpp_source.html#l00123">adam.hpp:123</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1Adam_html_aacf9ce0ffd3c4176daba05e7819864ea"><div class="ttname"><a href="classmlpack_1_1optimization_1_1Adam.html#aacf9ce0ffd3c4176daba05e7819864ea">mlpack::optimization::Adam::Shuffle</a></div><div class="ttdeci">bool & Shuffle()</div><div class="ttdoc">Modify whether or not the individual functions are shuffled. </div><div class="ttdef"><b>Definition:</b> <a href="adam_8hpp_source.html#l00148">adam.hpp:148</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1Adam_html_a8eda9c96d536058a2e64831e9ff91e72"><div class="ttname"><a href="classmlpack_1_1optimization_1_1Adam.html#a8eda9c96d536058a2e64831e9ff91e72">mlpack::optimization::Adam::Tolerance</a></div><div class="ttdeci">double Tolerance() const </div><div class="ttdoc">Get the tolerance for termination. </div><div class="ttdef"><b>Definition:</b> <a href="adam_8hpp_source.html#l00141">adam.hpp:141</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1Adam_html_afa2dd9b21d0942283d5243ce1d319b70"><div class="ttname"><a href="classmlpack_1_1optimization_1_1Adam.html#afa2dd9b21d0942283d5243ce1d319b70">mlpack::optimization::Adam::beta1</a></div><div class="ttdeci">double beta1</div><div class="ttdoc">Exponential decay rate for the first moment estimates. </div><div class="ttdef"><b>Definition:</b> <a href="adam_8hpp_source.html#l00163">adam.hpp:163</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1Adam_html_a4f3945c5c625d4979a7cf1f31561867b"><div class="ttname"><a href="classmlpack_1_1optimization_1_1Adam.html#a4f3945c5c625d4979a7cf1f31561867b">mlpack::optimization::Adam::StepSize</a></div><div class="ttdeci">double StepSize() const </div><div class="ttdoc">Get the step size. </div><div class="ttdef"><b>Definition:</b> <a href="adam_8hpp_source.html#l00116">adam.hpp:116</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1Adam_html_a505d3a8f04c5f59677b456a29f5921c9"><div class="ttname"><a href="classmlpack_1_1optimization_1_1Adam.html#a505d3a8f04c5f59677b456a29f5921c9">mlpack::optimization::Adam::Adam</a></div><div class="ttdeci">Adam(DecomposableFunctionType &function, const double stepSize=0.001, const double beta1=0.9, const double beta2=0.999, const double eps=1e-8, const size_t maxIterations=100000, const double tolerance=1e-5, const bool shuffle=true, const bool adaMax=false)</div><div class="ttdoc">Construct the Adam optimizer with the given function and parameters. </div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1Adam_html_a5383ad9795720cf9fe216c109055e835"><div class="ttname"><a href="classmlpack_1_1optimization_1_1Adam.html#a5383ad9795720cf9fe216c109055e835">mlpack::optimization::Adam::Epsilon</a></div><div class="ttdeci">double & Epsilon()</div><div class="ttdoc">Modify the value used to initialise the mean squared gradient parameter. </div><div class="ttdef"><b>Definition:</b> <a href="adam_8hpp_source.html#l00133">adam.hpp:133</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1Adam_html_a7c378485d3abc4570a4ff99071c03bbd"><div class="ttname"><a href="classmlpack_1_1optimization_1_1Adam.html#a7c378485d3abc4570a4ff99071c03bbd">mlpack::optimization::Adam::Optimize</a></div><div class="ttdeci">double Optimize(arma::mat &iterate)</div><div class="ttdoc">Optimize the given function using Adam. </div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1Adam_html_aede55fc25b025637bc414dc679b1a576"><div class="ttname"><a href="classmlpack_1_1optimization_1_1Adam.html#aede55fc25b025637bc414dc679b1a576">mlpack::optimization::Adam::StepSize</a></div><div class="ttdeci">double & StepSize()</div><div class="ttdoc">Modify the step size. </div><div class="ttdef"><b>Definition:</b> <a href="adam_8hpp_source.html#l00118">adam.hpp:118</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1Adam_html"><div class="ttname"><a href="classmlpack_1_1optimization_1_1Adam.html">mlpack::optimization::Adam</a></div><div class="ttdoc">Adam is an optimizer that computes individual adaptive learning rates for different parameters from e...</div><div class="ttdef"><b>Definition:</b> <a href="adam_8hpp_source.html#l00065">adam.hpp:65</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1Adam_html_adef01fba112e464a7d1d8e92a81aaadb"><div class="ttname"><a href="classmlpack_1_1optimization_1_1Adam.html#adef01fba112e464a7d1d8e92a81aaadb">mlpack::optimization::Adam::beta2</a></div><div class="ttdeci">double beta2</div><div class="ttdoc">Exponential decay rate for the weighted infinity norm estimates. </div><div class="ttdef"><b>Definition:</b> <a href="adam_8hpp_source.html#l00166">adam.hpp:166</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1Adam_html_a997272dbb67581475e614e6bd9b8da61"><div class="ttname"><a href="classmlpack_1_1optimization_1_1Adam.html#a997272dbb67581475e614e6bd9b8da61">mlpack::optimization::Adam::AdaMax</a></div><div class="ttdeci">bool AdaMax() const </div><div class="ttdoc">Get whether or not the AdaMax optimizer is specified. </div><div class="ttdef"><b>Definition:</b> <a href="adam_8hpp_source.html#l00151">adam.hpp:151</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.11
|
|
</small></address>
|
|
</body>
|
|
<script type="text/javascript">
|
|
var x = document.getElementsByClassName("formulaDsp");
|
|
var i;
|
|
for (i = 0; i < x.length; i++)
|
|
{
|
|
x[i].width /= 4;
|
|
}
|
|
</script>
|
|
</html>
|