137 lines
32 KiB
HTML
137 lines
32 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/rmsprop/rmsprop.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_e81b6b380a93e771ede77bbcce0ca7b6.html">rmsprop</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">rmsprop.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="rmsprop_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="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#ifndef MLPACK_CORE_OPTIMIZERS_RMSPROP_RMSPROP_HPP</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#define MLPACK_CORE_OPTIMIZERS_RMSPROP_RMSPROP_HPP</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <<a class="code" href="prereqs_8hpp.html">mlpack/prereqs.hpp</a>></span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">namespace </span><a class="code" href="namespacemlpack.html">mlpack</a> {</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">namespace </span>optimization {</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="keyword">template</span><<span class="keyword">typename</span> DecomposableFunctionType></div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1RMSprop.html"> 64</a></span> <span class="keyword">class </span><a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html">RMSprop</a></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> {</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#a1110f2523d607689fad218983c0aa8e9">RMSprop</a>(DecomposableFunctionType& <span class="keyword">function</span>,</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">const</span> <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#a8a5014f4413b22e0f7cf12ead293af28">stepSize</a> = 0.01,</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">const</span> <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#a623e330e50691fb9722d57a40aa6f523">alpha</a> = 0.99,</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keyword">const</span> <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#a42fafe0c44af79c10285b330e2bc6013">eps</a> = 1e-8,</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#a2d00dfa1fc0e2381fd9a99977af4d625">maxIterations</a> = 100000,</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_1RMSprop.html#ac3d21cb62472656e43433fef4742916f">tolerance</a> = 1e-5,</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keyword">const</span> <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#a290478a834e8d514a2519c8ffbf05a34">shuffle</a> = <span class="keyword">true</span>);</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#a40f0e117fe7a63478e3662202f042f07">Optimize</a>(arma::mat& iterate);</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div><div class="line"><a name="l00105"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1RMSprop.html#ad1145b70977db57ff330c0579c775360"> 105</a></span>  <span class="keyword">const</span> DecomposableFunctionType& <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#ad1145b70977db57ff330c0579c775360">Function</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">function</span>; }</div><div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1RMSprop.html#af0fef5e1d19a3d7d4268b605e97a8e1a"> 107</a></span>  DecomposableFunctionType& <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#af0fef5e1d19a3d7d4268b605e97a8e1a">Function</a>() { <span class="keywordflow">return</span> <span class="keyword">function</span>; }</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div><div class="line"><a name="l00110"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1RMSprop.html#a6f64d113a125a192ed5acf0a21c0840f"> 110</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#a6f64d113a125a192ed5acf0a21c0840f">StepSize</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#a8a5014f4413b22e0f7cf12ead293af28">stepSize</a>; }</div><div class="line"><a name="l00112"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1RMSprop.html#a14cd8af80f5740156eb620cd682e7389"> 112</a></span>  <span class="keywordtype">double</span>& <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#a14cd8af80f5740156eb620cd682e7389">StepSize</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#a8a5014f4413b22e0f7cf12ead293af28">stepSize</a>; }</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div><div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1RMSprop.html#acf33c9f22db98ff5391146d468d242d8"> 115</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#acf33c9f22db98ff5391146d468d242d8">Alpha</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#a623e330e50691fb9722d57a40aa6f523">alpha</a>; }</div><div class="line"><a name="l00117"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1RMSprop.html#aff2fe057e9e9440d82e12fe7305a070d"> 117</a></span>  <span class="keywordtype">double</span>& <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#aff2fe057e9e9440d82e12fe7305a070d">Alpha</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#a623e330e50691fb9722d57a40aa6f523">alpha</a>; }</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div><div class="line"><a name="l00120"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1RMSprop.html#aff6492e03f309f398cec4ac01636b9c4"> 120</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#aff6492e03f309f398cec4ac01636b9c4">Epsilon</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#a42fafe0c44af79c10285b330e2bc6013">eps</a>; }</div><div class="line"><a name="l00122"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1RMSprop.html#a0d930137d33d777988bdae7237396f12"> 122</a></span>  <span class="keywordtype">double</span>& <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#a0d930137d33d777988bdae7237396f12">Epsilon</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#a42fafe0c44af79c10285b330e2bc6013">eps</a>; }</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div><div class="line"><a name="l00125"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1RMSprop.html#abc153184d6096c00f391130844b8893f"> 125</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#abc153184d6096c00f391130844b8893f">MaxIterations</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#a2d00dfa1fc0e2381fd9a99977af4d625">maxIterations</a>; }</div><div class="line"><a name="l00127"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1RMSprop.html#ae8ae3d0ce74caa7c4de6190c7133af30"> 127</a></span>  <span class="keywordtype">size_t</span>& <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#ae8ae3d0ce74caa7c4de6190c7133af30">MaxIterations</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#a2d00dfa1fc0e2381fd9a99977af4d625">maxIterations</a>; }</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> </div><div class="line"><a name="l00130"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1RMSprop.html#ada68640244436f65bf3c9ba529062ce3"> 130</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#ada68640244436f65bf3c9ba529062ce3">Tolerance</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#ac3d21cb62472656e43433fef4742916f">tolerance</a>; }</div><div class="line"><a name="l00132"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1RMSprop.html#aba4d3a30918743b6f16c05e96668b8ab"> 132</a></span>  <span class="keywordtype">double</span>& <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#aba4d3a30918743b6f16c05e96668b8ab">Tolerance</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#ac3d21cb62472656e43433fef4742916f">tolerance</a>; }</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div><div class="line"><a name="l00135"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1RMSprop.html#ad6eb4bf5132798a01eaafda9ebe61eb8"> 135</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#ad6eb4bf5132798a01eaafda9ebe61eb8">Shuffle</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#a290478a834e8d514a2519c8ffbf05a34">shuffle</a>; }</div><div class="line"><a name="l00137"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1RMSprop.html#a330a158be914f6f90334431b586f359e"> 137</a></span>  <span class="keywordtype">bool</span>& <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#a330a158be914f6f90334431b586f359e">Shuffle</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#a290478a834e8d514a2519c8ffbf05a34">shuffle</a>; }</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00141"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1RMSprop.html#a0f94dacbc6fe3e5cbfc091a9efabdbed"> 141</a></span>  DecomposableFunctionType& <span class="keyword">function</span>;</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> </div><div class="line"><a name="l00144"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1RMSprop.html#a8a5014f4413b22e0f7cf12ead293af28"> 144</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#a8a5014f4413b22e0f7cf12ead293af28">stepSize</a>;</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div><div class="line"><a name="l00147"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1RMSprop.html#a623e330e50691fb9722d57a40aa6f523"> 147</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#a623e330e50691fb9722d57a40aa6f523">alpha</a>;</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> </div><div class="line"><a name="l00150"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1RMSprop.html#a42fafe0c44af79c10285b330e2bc6013"> 150</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#a42fafe0c44af79c10285b330e2bc6013">eps</a>;</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div><div class="line"><a name="l00153"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1RMSprop.html#a2d00dfa1fc0e2381fd9a99977af4d625"> 153</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#a2d00dfa1fc0e2381fd9a99977af4d625">maxIterations</a>;</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> </div><div class="line"><a name="l00156"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1RMSprop.html#ac3d21cb62472656e43433fef4742916f"> 156</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#ac3d21cb62472656e43433fef4742916f">tolerance</a>;</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div><div class="line"><a name="l00160"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1RMSprop.html#a290478a834e8d514a2519c8ffbf05a34"> 160</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1optimization_1_1RMSprop.html#a290478a834e8d514a2519c8ffbf05a34">shuffle</a>;</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> };</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> } <span class="comment">// namespace optimization</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> } <span class="comment">// namespace mlpack</span></div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> </div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment">// Include implementation.</span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="preprocessor">#include "rmsprop_impl.hpp"</span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> </div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classmlpack_1_1optimization_1_1RMSprop_html_aff2fe057e9e9440d82e12fe7305a070d"><div class="ttname"><a href="classmlpack_1_1optimization_1_1RMSprop.html#aff2fe057e9e9440d82e12fe7305a070d">mlpack::optimization::RMSprop::Alpha</a></div><div class="ttdeci">double & Alpha()</div><div class="ttdoc">Modify the smoothing parameter. </div><div class="ttdef"><b>Definition:</b> <a href="rmsprop_8hpp_source.html#l00117">rmsprop.hpp:117</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1RMSprop_html_acf33c9f22db98ff5391146d468d242d8"><div class="ttname"><a href="classmlpack_1_1optimization_1_1RMSprop.html#acf33c9f22db98ff5391146d468d242d8">mlpack::optimization::RMSprop::Alpha</a></div><div class="ttdeci">double Alpha() const </div><div class="ttdoc">Get the smoothing parameter. </div><div class="ttdef"><b>Definition:</b> <a href="rmsprop_8hpp_source.html#l00115">rmsprop.hpp:115</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1RMSprop_html_a1110f2523d607689fad218983c0aa8e9"><div class="ttname"><a href="classmlpack_1_1optimization_1_1RMSprop.html#a1110f2523d607689fad218983c0aa8e9">mlpack::optimization::RMSprop::RMSprop</a></div><div class="ttdeci">RMSprop(DecomposableFunctionType &function, const double stepSize=0.01, const double alpha=0.99, const double eps=1e-8, const size_t maxIterations=100000, const double tolerance=1e-5, const bool shuffle=true)</div><div class="ttdoc">Construct the RMSprop optimizer with the given function and parameters. </div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1RMSprop_html_a330a158be914f6f90334431b586f359e"><div class="ttname"><a href="classmlpack_1_1optimization_1_1RMSprop.html#a330a158be914f6f90334431b586f359e">mlpack::optimization::RMSprop::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="rmsprop_8hpp_source.html#l00137">rmsprop.hpp:137</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_1RMSprop_html_a2d00dfa1fc0e2381fd9a99977af4d625"><div class="ttname"><a href="classmlpack_1_1optimization_1_1RMSprop.html#a2d00dfa1fc0e2381fd9a99977af4d625">mlpack::optimization::RMSprop::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="rmsprop_8hpp_source.html#l00153">rmsprop.hpp:153</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_1RMSprop_html_a42fafe0c44af79c10285b330e2bc6013"><div class="ttname"><a href="classmlpack_1_1optimization_1_1RMSprop.html#a42fafe0c44af79c10285b330e2bc6013">mlpack::optimization::RMSprop::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="rmsprop_8hpp_source.html#l00150">rmsprop.hpp:150</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1RMSprop_html_ac3d21cb62472656e43433fef4742916f"><div class="ttname"><a href="classmlpack_1_1optimization_1_1RMSprop.html#ac3d21cb62472656e43433fef4742916f">mlpack::optimization::RMSprop::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="rmsprop_8hpp_source.html#l00156">rmsprop.hpp:156</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1RMSprop_html_a6f64d113a125a192ed5acf0a21c0840f"><div class="ttname"><a href="classmlpack_1_1optimization_1_1RMSprop.html#a6f64d113a125a192ed5acf0a21c0840f">mlpack::optimization::RMSprop::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="rmsprop_8hpp_source.html#l00110">rmsprop.hpp:110</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1RMSprop_html_a290478a834e8d514a2519c8ffbf05a34"><div class="ttname"><a href="classmlpack_1_1optimization_1_1RMSprop.html#a290478a834e8d514a2519c8ffbf05a34">mlpack::optimization::RMSprop::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="rmsprop_8hpp_source.html#l00160">rmsprop.hpp:160</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1RMSprop_html_a623e330e50691fb9722d57a40aa6f523"><div class="ttname"><a href="classmlpack_1_1optimization_1_1RMSprop.html#a623e330e50691fb9722d57a40aa6f523">mlpack::optimization::RMSprop::alpha</a></div><div class="ttdeci">double alpha</div><div class="ttdoc">The smoothing parameter. </div><div class="ttdef"><b>Definition:</b> <a href="rmsprop_8hpp_source.html#l00147">rmsprop.hpp:147</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1RMSprop_html_ae8ae3d0ce74caa7c4de6190c7133af30"><div class="ttname"><a href="classmlpack_1_1optimization_1_1RMSprop.html#ae8ae3d0ce74caa7c4de6190c7133af30">mlpack::optimization::RMSprop::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="rmsprop_8hpp_source.html#l00127">rmsprop.hpp:127</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1RMSprop_html_ad1145b70977db57ff330c0579c775360"><div class="ttname"><a href="classmlpack_1_1optimization_1_1RMSprop.html#ad1145b70977db57ff330c0579c775360">mlpack::optimization::RMSprop::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="rmsprop_8hpp_source.html#l00105">rmsprop.hpp:105</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1RMSprop_html_a8a5014f4413b22e0f7cf12ead293af28"><div class="ttname"><a href="classmlpack_1_1optimization_1_1RMSprop.html#a8a5014f4413b22e0f7cf12ead293af28">mlpack::optimization::RMSprop::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="rmsprop_8hpp_source.html#l00144">rmsprop.hpp:144</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1RMSprop_html_af0fef5e1d19a3d7d4268b605e97a8e1a"><div class="ttname"><a href="classmlpack_1_1optimization_1_1RMSprop.html#af0fef5e1d19a3d7d4268b605e97a8e1a">mlpack::optimization::RMSprop::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="rmsprop_8hpp_source.html#l00107">rmsprop.hpp:107</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1RMSprop_html_aba4d3a30918743b6f16c05e96668b8ab"><div class="ttname"><a href="classmlpack_1_1optimization_1_1RMSprop.html#aba4d3a30918743b6f16c05e96668b8ab">mlpack::optimization::RMSprop::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="rmsprop_8hpp_source.html#l00132">rmsprop.hpp:132</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1RMSprop_html_aff6492e03f309f398cec4ac01636b9c4"><div class="ttname"><a href="classmlpack_1_1optimization_1_1RMSprop.html#aff6492e03f309f398cec4ac01636b9c4">mlpack::optimization::RMSprop::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="rmsprop_8hpp_source.html#l00120">rmsprop.hpp:120</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1RMSprop_html_a40f0e117fe7a63478e3662202f042f07"><div class="ttname"><a href="classmlpack_1_1optimization_1_1RMSprop.html#a40f0e117fe7a63478e3662202f042f07">mlpack::optimization::RMSprop::Optimize</a></div><div class="ttdeci">double Optimize(arma::mat &iterate)</div><div class="ttdoc">Optimize the given function using RMSprop. </div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1RMSprop_html_a0d930137d33d777988bdae7237396f12"><div class="ttname"><a href="classmlpack_1_1optimization_1_1RMSprop.html#a0d930137d33d777988bdae7237396f12">mlpack::optimization::RMSprop::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="rmsprop_8hpp_source.html#l00122">rmsprop.hpp:122</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1RMSprop_html_ad6eb4bf5132798a01eaafda9ebe61eb8"><div class="ttname"><a href="classmlpack_1_1optimization_1_1RMSprop.html#ad6eb4bf5132798a01eaafda9ebe61eb8">mlpack::optimization::RMSprop::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="rmsprop_8hpp_source.html#l00135">rmsprop.hpp:135</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1RMSprop_html"><div class="ttname"><a href="classmlpack_1_1optimization_1_1RMSprop.html">mlpack::optimization::RMSprop</a></div><div class="ttdoc">RMSprop is an optimizer that utilizes the magnitude of recent gradients to normalize the gradients...</div><div class="ttdef"><b>Definition:</b> <a href="rmsprop_8hpp_source.html#l00064">rmsprop.hpp:64</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1RMSprop_html_abc153184d6096c00f391130844b8893f"><div class="ttname"><a href="classmlpack_1_1optimization_1_1RMSprop.html#abc153184d6096c00f391130844b8893f">mlpack::optimization::RMSprop::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="rmsprop_8hpp_source.html#l00125">rmsprop.hpp:125</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1RMSprop_html_a14cd8af80f5740156eb620cd682e7389"><div class="ttname"><a href="classmlpack_1_1optimization_1_1RMSprop.html#a14cd8af80f5740156eb620cd682e7389">mlpack::optimization::RMSprop::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="rmsprop_8hpp_source.html#l00112">rmsprop.hpp:112</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1RMSprop_html_ada68640244436f65bf3c9ba529062ce3"><div class="ttname"><a href="classmlpack_1_1optimization_1_1RMSprop.html#ada68640244436f65bf3c9ba529062ce3">mlpack::optimization::RMSprop::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="rmsprop_8hpp_source.html#l00130">rmsprop.hpp:130</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>
|