134 lines
28 KiB
HTML
134 lines
28 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/sgd/sgd.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_1bfd5596fecf22290211be250d517d41.html">sgd</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">sgd.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="sgd_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="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#ifndef MLPACK_CORE_OPTIMIZERS_SGD_SGD_HPP</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#define MLPACK_CORE_OPTIMIZERS_SGD_SGD_HPP</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <<a class="code" href="prereqs_8hpp.html">mlpack/prereqs.hpp</a>></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <<a class="code" href="vanilla__update_8hpp.html">mlpack/core/optimizers/sgd/update_policies/vanilla_update.hpp</a>></span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <<a class="code" href="momentum__update_8hpp.html">mlpack/core/optimizers/sgd/update_policies/momentum_update.hpp</a>></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">namespace </span><a class="code" href="namespacemlpack.html">mlpack</a> {</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">namespace </span>optimization {</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="keyword">template</span><<span class="keyword">typename</span> DecomposableFunctionType, <span class="keyword">typename</span> UpdatePolicy = VanillaUpdate></div><div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1SGD.html"> 77</a></span> <span class="keyword">class </span><a class="code" href="classmlpack_1_1optimization_1_1SGD.html">SGD</a></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> {</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#afaf353c8c622ac82fe566fef215ccff3">SGD</a>(DecomposableFunctionType& <span class="keyword">function</span>,</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">const</span> <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#a4744d652756e4679c94ffc95e1b1b7e2">stepSize</a> = 0.01,</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#a889407ceed9b4cae88f0d6d668f8c8e4">maxIterations</a> = 100000,</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">const</span> <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#a754ec32abab885aab94d9f600fb1125b">tolerance</a> = 1e-5,</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keyword">const</span> <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#a51150863a1388fa8f6c66e811bb17d15">shuffle</a> = <span class="keyword">true</span>,</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keyword">const</span> UpdatePolicy <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#a239f74b09177ef5c731e5cfbcd0ed0a8">updatePolicy</a> = UpdatePolicy());</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#a8d869b2192f3ac51e9ec6dddb9225260">Optimize</a>(arma::mat& iterate);</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div><div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1SGD.html#a4985df646c5e6e765e16a149cb528e48"> 114</a></span>  <span class="keyword">const</span> DecomposableFunctionType& <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#a4985df646c5e6e765e16a149cb528e48">Function</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">function</span>; }</div><div class="line"><a name="l00116"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1SGD.html#a2b3b65b0a14cdc9e7c66355d828f2c3f"> 116</a></span>  DecomposableFunctionType& <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#a2b3b65b0a14cdc9e7c66355d828f2c3f">Function</a>() { <span class="keywordflow">return</span> <span class="keyword">function</span>; }</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div><div class="line"><a name="l00119"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1SGD.html#a9b5531706e1697df158374fd637e640c"> 119</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#a9b5531706e1697df158374fd637e640c">StepSize</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#a4744d652756e4679c94ffc95e1b1b7e2">stepSize</a>; }</div><div class="line"><a name="l00121"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1SGD.html#af334f1bc4b24f95bdbbe99905c0f8fbe"> 121</a></span>  <span class="keywordtype">double</span>& <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#af334f1bc4b24f95bdbbe99905c0f8fbe">StepSize</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#a4744d652756e4679c94ffc95e1b1b7e2">stepSize</a>; }</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div><div class="line"><a name="l00124"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1SGD.html#a9acf6ce28d3133336f0e02111394e7df"> 124</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#a9acf6ce28d3133336f0e02111394e7df">MaxIterations</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#a889407ceed9b4cae88f0d6d668f8c8e4">maxIterations</a>; }</div><div class="line"><a name="l00126"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1SGD.html#a2edf2f5bba45f7b6c7a6beefdf0895dc"> 126</a></span>  <span class="keywordtype">size_t</span>& <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#a2edf2f5bba45f7b6c7a6beefdf0895dc">MaxIterations</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#a889407ceed9b4cae88f0d6d668f8c8e4">maxIterations</a>; }</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div><div class="line"><a name="l00129"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1SGD.html#a92f8504ca7620f044a6c0f303f2558e9"> 129</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#a92f8504ca7620f044a6c0f303f2558e9">Tolerance</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#a754ec32abab885aab94d9f600fb1125b">tolerance</a>; }</div><div class="line"><a name="l00131"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1SGD.html#a21ecb74784013a446115428056069674"> 131</a></span>  <span class="keywordtype">double</span>& <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#a21ecb74784013a446115428056069674">Tolerance</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#a754ec32abab885aab94d9f600fb1125b">tolerance</a>; }</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div><div class="line"><a name="l00134"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1SGD.html#a548b3b37d879ae799a6b1905a247815d"> 134</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#a548b3b37d879ae799a6b1905a247815d">Shuffle</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#a51150863a1388fa8f6c66e811bb17d15">shuffle</a>; }</div><div class="line"><a name="l00136"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1SGD.html#a2b88013c0ceb4f3e84b5fffad9972bbd"> 136</a></span>  <span class="keywordtype">bool</span>& <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#a2b88013c0ceb4f3e84b5fffad9972bbd">Shuffle</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#a51150863a1388fa8f6c66e811bb17d15">shuffle</a>; }</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> </div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00140"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1SGD.html#aef0f79b5afaa007c4a39eacfaa4a2a86"> 140</a></span>  DecomposableFunctionType& <span class="keyword">function</span>;</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div><div class="line"><a name="l00143"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1SGD.html#a4744d652756e4679c94ffc95e1b1b7e2"> 143</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#a4744d652756e4679c94ffc95e1b1b7e2">stepSize</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_1SGD.html#a889407ceed9b4cae88f0d6d668f8c8e4"> 146</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#a889407ceed9b4cae88f0d6d668f8c8e4">maxIterations</a>;</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div><div class="line"><a name="l00149"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1SGD.html#a754ec32abab885aab94d9f600fb1125b"> 149</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#a754ec32abab885aab94d9f600fb1125b">tolerance</a>;</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div><div class="line"><a name="l00153"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1SGD.html#a51150863a1388fa8f6c66e811bb17d15"> 153</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#a51150863a1388fa8f6c66e811bb17d15">shuffle</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_1SGD.html#a239f74b09177ef5c731e5cfbcd0ed0a8"> 156</a></span>  UpdatePolicy <a class="code" href="classmlpack_1_1optimization_1_1SGD.html#a239f74b09177ef5c731e5cfbcd0ed0a8">updatePolicy</a>;</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> };</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> </div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="keyword">template</span><<span class="keyword">typename</span> DecomposableFunctionType></div><div class="line"><a name="l00160"></a><span class="lineno"><a class="line" href="namespacemlpack_1_1optimization.html#a3a601b2b23932fd95e02b8efc599a46f"> 160</a></span> <span class="keyword">using</span> <a class="code" href="classmlpack_1_1optimization_1_1SGD.html">StandardSGD</a> = <a class="code" href="classmlpack_1_1optimization_1_1SGD.html">SGD<DecomposableFunctionType, VanillaUpdate></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> <span class="keyword">template</span><<span class="keyword">typename</span> DecomposableFunctionType></div><div class="line"><a name="l00163"></a><span class="lineno"><a class="line" href="namespacemlpack_1_1optimization.html#a54725aba08fe3d4e3c232b784122cf0b"> 163</a></span> <span class="keyword">using</span> <a class="code" href="classmlpack_1_1optimization_1_1SGD.html">MomentumSGD</a> = <a class="code" href="classmlpack_1_1optimization_1_1SGD.html">SGD<DecomposableFunctionType, MomentumUpdate></a>;</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> </div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> } <span class="comment">// namespace optimization</span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> } <span class="comment">// namespace mlpack</span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> </div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment">// Include implementation.</span></div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="preprocessor">#include "sgd_impl.hpp"</span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> </div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="momentum__update_8hpp_html"><div class="ttname"><a href="momentum__update_8hpp.html">momentum_update.hpp</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1SGD_html_a51150863a1388fa8f6c66e811bb17d15"><div class="ttname"><a href="classmlpack_1_1optimization_1_1SGD.html#a51150863a1388fa8f6c66e811bb17d15">mlpack::optimization::SGD::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="sgd_8hpp_source.html#l00153">sgd.hpp:153</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1SGD_html_af334f1bc4b24f95bdbbe99905c0f8fbe"><div class="ttname"><a href="classmlpack_1_1optimization_1_1SGD.html#af334f1bc4b24f95bdbbe99905c0f8fbe">mlpack::optimization::SGD::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="sgd_8hpp_source.html#l00121">sgd.hpp:121</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_1SGD_html_a9acf6ce28d3133336f0e02111394e7df"><div class="ttname"><a href="classmlpack_1_1optimization_1_1SGD.html#a9acf6ce28d3133336f0e02111394e7df">mlpack::optimization::SGD::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="sgd_8hpp_source.html#l00124">sgd.hpp:124</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1SGD_html_a889407ceed9b4cae88f0d6d668f8c8e4"><div class="ttname"><a href="classmlpack_1_1optimization_1_1SGD.html#a889407ceed9b4cae88f0d6d668f8c8e4">mlpack::optimization::SGD::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="sgd_8hpp_source.html#l00146">sgd.hpp:146</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1SGD_html_a239f74b09177ef5c731e5cfbcd0ed0a8"><div class="ttname"><a href="classmlpack_1_1optimization_1_1SGD.html#a239f74b09177ef5c731e5cfbcd0ed0a8">mlpack::optimization::SGD::updatePolicy</a></div><div class="ttdeci">UpdatePolicy updatePolicy</div><div class="ttdoc">The update policy used to update the parameters in each iteration. </div><div class="ttdef"><b>Definition:</b> <a href="sgd_8hpp_source.html#l00156">sgd.hpp:156</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_1SGD_html_a2edf2f5bba45f7b6c7a6beefdf0895dc"><div class="ttname"><a href="classmlpack_1_1optimization_1_1SGD.html#a2edf2f5bba45f7b6c7a6beefdf0895dc">mlpack::optimization::SGD::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="sgd_8hpp_source.html#l00126">sgd.hpp:126</a></div></div>
|
|
<div class="ttc" id="vanilla__update_8hpp_html"><div class="ttname"><a href="vanilla__update_8hpp.html">vanilla_update.hpp</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1SGD_html_a4985df646c5e6e765e16a149cb528e48"><div class="ttname"><a href="classmlpack_1_1optimization_1_1SGD.html#a4985df646c5e6e765e16a149cb528e48">mlpack::optimization::SGD::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="sgd_8hpp_source.html#l00114">sgd.hpp:114</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1SGD_html_a2b88013c0ceb4f3e84b5fffad9972bbd"><div class="ttname"><a href="classmlpack_1_1optimization_1_1SGD.html#a2b88013c0ceb4f3e84b5fffad9972bbd">mlpack::optimization::SGD::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="sgd_8hpp_source.html#l00136">sgd.hpp:136</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1SGD_html_a548b3b37d879ae799a6b1905a247815d"><div class="ttname"><a href="classmlpack_1_1optimization_1_1SGD.html#a548b3b37d879ae799a6b1905a247815d">mlpack::optimization::SGD::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="sgd_8hpp_source.html#l00134">sgd.hpp:134</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1SGD_html_a8d869b2192f3ac51e9ec6dddb9225260"><div class="ttname"><a href="classmlpack_1_1optimization_1_1SGD.html#a8d869b2192f3ac51e9ec6dddb9225260">mlpack::optimization::SGD::Optimize</a></div><div class="ttdeci">double Optimize(arma::mat &iterate)</div><div class="ttdoc">Optimize the given function using stochastic gradient descent. </div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1SGD_html_a21ecb74784013a446115428056069674"><div class="ttname"><a href="classmlpack_1_1optimization_1_1SGD.html#a21ecb74784013a446115428056069674">mlpack::optimization::SGD::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="sgd_8hpp_source.html#l00131">sgd.hpp:131</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1SGD_html_a92f8504ca7620f044a6c0f303f2558e9"><div class="ttname"><a href="classmlpack_1_1optimization_1_1SGD.html#a92f8504ca7620f044a6c0f303f2558e9">mlpack::optimization::SGD::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="sgd_8hpp_source.html#l00129">sgd.hpp:129</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1SGD_html_a2b3b65b0a14cdc9e7c66355d828f2c3f"><div class="ttname"><a href="classmlpack_1_1optimization_1_1SGD.html#a2b3b65b0a14cdc9e7c66355d828f2c3f">mlpack::optimization::SGD::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="sgd_8hpp_source.html#l00116">sgd.hpp:116</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1SGD_html_a754ec32abab885aab94d9f600fb1125b"><div class="ttname"><a href="classmlpack_1_1optimization_1_1SGD.html#a754ec32abab885aab94d9f600fb1125b">mlpack::optimization::SGD::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="sgd_8hpp_source.html#l00149">sgd.hpp:149</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1SGD_html_afaf353c8c622ac82fe566fef215ccff3"><div class="ttname"><a href="classmlpack_1_1optimization_1_1SGD.html#afaf353c8c622ac82fe566fef215ccff3">mlpack::optimization::SGD::SGD</a></div><div class="ttdeci">SGD(DecomposableFunctionType &function, const double stepSize=0.01, const size_t maxIterations=100000, const double tolerance=1e-5, const bool shuffle=true, const UpdatePolicy updatePolicy=UpdatePolicy())</div><div class="ttdoc">Construct the SGD optimizer with the given function and parameters. </div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1SGD_html"><div class="ttname"><a href="classmlpack_1_1optimization_1_1SGD.html">mlpack::optimization::SGD</a></div><div class="ttdoc">Stochastic Gradient Descent is a technique for minimizing a function which can be expressed as a sum ...</div><div class="ttdef"><b>Definition:</b> <a href="sgd_8hpp_source.html#l00077">sgd.hpp:77</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1SGD_html_a4744d652756e4679c94ffc95e1b1b7e2"><div class="ttname"><a href="classmlpack_1_1optimization_1_1SGD.html#a4744d652756e4679c94ffc95e1b1b7e2">mlpack::optimization::SGD::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="sgd_8hpp_source.html#l00143">sgd.hpp:143</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1SGD_html_a9b5531706e1697df158374fd637e640c"><div class="ttname"><a href="classmlpack_1_1optimization_1_1SGD.html#a9b5531706e1697df158374fd637e640c">mlpack::optimization::SGD::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="sgd_8hpp_source.html#l00119">sgd.hpp:119</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>
|