134 lines
29 KiB
HTML
134 lines
29 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/minibatch_sgd/minibatch_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_66272309bbbae2ac1ebb1e2f8790a019.html">minibatch_sgd</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">minibatch_sgd.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="minibatch__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="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#ifndef MLPACK_CORE_OPTIMIZERS_MINIBATCH_SGD_MINIBATCH_SGD_HPP</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#define MLPACK_CORE_OPTIMIZERS_MINIBATCH_SGD_MINIBATCH_SGD_HPP</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <<a class="code" href="prereqs_8hpp.html">mlpack/prereqs.hpp</a>></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="keyword">namespace </span><a class="code" href="namespacemlpack.html">mlpack</a> {</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">namespace </span>optimization {</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="keyword">template</span><<span class="keyword">typename</span> DecomposableFunctionType></div><div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html"> 74</a></span> <span class="keyword">class </span><a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html">MiniBatchSGD</a></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> {</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a15035e9fb9538743cd8bd3e05fd31977">MiniBatchSGD</a>(DecomposableFunctionType& <span class="keyword">function</span>,</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#aa87b27e65bb995d63cc976c7c9fd9d52">batchSize</a> = 1000,</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keyword">const</span> <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a5695a8062e02b0bdc48723b75f215ca3">stepSize</a> = 0.01,</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#ad88647ff30103350ba0ac296e965993d">maxIterations</a> = 100000,</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_1MiniBatchSGD.html#afbcad6a84e07072c718b68049d27ece8">tolerance</a> = 1e-5,</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_1MiniBatchSGD.html#a9d2859a232290853a81d2ca143882f35">shuffle</a> = <span class="keyword">true</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_1MiniBatchSGD.html#ab6ba9ce7ae508fe85c7620576a68f20a">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_1MiniBatchSGD.html#a55758ee335253b0e0b2f82e4a01ee965"> 111</a></span>  <span class="keyword">const</span> DecomposableFunctionType& <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a55758ee335253b0e0b2f82e4a01ee965">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_1MiniBatchSGD.html#a35502af6b3f7732738e2caf8eb8fe96c"> 113</a></span>  DecomposableFunctionType& <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a35502af6b3f7732738e2caf8eb8fe96c">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_1MiniBatchSGD.html#aa680a3700b1105df18a8f85374b56638"> 116</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#aa680a3700b1105df18a8f85374b56638">BatchSize</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#aa87b27e65bb995d63cc976c7c9fd9d52">batchSize</a>; }</div><div class="line"><a name="l00118"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#ad901c56284441c5bb5af30b549e2ae8a"> 118</a></span>  <span class="keywordtype">size_t</span>& <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#ad901c56284441c5bb5af30b549e2ae8a">BatchSize</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#aa87b27e65bb995d63cc976c7c9fd9d52">batchSize</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_1MiniBatchSGD.html#a00169352ab9074e067ab37864e115dbb"> 121</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a00169352ab9074e067ab37864e115dbb">StepSize</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a5695a8062e02b0bdc48723b75f215ca3">stepSize</a>; }</div><div class="line"><a name="l00123"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a3899b6a9ded146d82bb4458c03302073"> 123</a></span>  <span class="keywordtype">double</span>& <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a3899b6a9ded146d82bb4458c03302073">StepSize</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a5695a8062e02b0bdc48723b75f215ca3">stepSize</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_1MiniBatchSGD.html#a35a9ef041c0bb3f940e78593754ac536"> 126</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a35a9ef041c0bb3f940e78593754ac536">MaxIterations</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#ad88647ff30103350ba0ac296e965993d">maxIterations</a>; }</div><div class="line"><a name="l00128"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a5dd0b12834b720a696a6d33ef438f93e"> 128</a></span>  <span class="keywordtype">size_t</span>& <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a5dd0b12834b720a696a6d33ef438f93e">MaxIterations</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#ad88647ff30103350ba0ac296e965993d">maxIterations</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_1MiniBatchSGD.html#a90c9709a7dd0312d5ff93a312a5fe9db"> 131</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a90c9709a7dd0312d5ff93a312a5fe9db">Tolerance</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#afbcad6a84e07072c718b68049d27ece8">tolerance</a>; }</div><div class="line"><a name="l00133"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a8bf3c9ed107adb32109657f443a747a7"> 133</a></span>  <span class="keywordtype">double</span>& <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a8bf3c9ed107adb32109657f443a747a7">Tolerance</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#afbcad6a84e07072c718b68049d27ece8">tolerance</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_1MiniBatchSGD.html#a73566d6bfca44f2b0c77650c01fbff1e"> 136</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a73566d6bfca44f2b0c77650c01fbff1e">Shuffle</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a9d2859a232290853a81d2ca143882f35">shuffle</a>; }</div><div class="line"><a name="l00138"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#ab2ca6ae65a0dca7b18ae56d2c1340e05"> 138</a></span>  <span class="keywordtype">bool</span>& <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#ab2ca6ae65a0dca7b18ae56d2c1340e05">Shuffle</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a9d2859a232290853a81d2ca143882f35">shuffle</a>; }</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00142"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a0140eedeab2cb8f7f2fb12f682d11840"> 142</a></span>  DecomposableFunctionType& <span class="keyword">function</span>;</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div><div class="line"><a name="l00145"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#aa87b27e65bb995d63cc976c7c9fd9d52"> 145</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#aa87b27e65bb995d63cc976c7c9fd9d52">batchSize</a>;</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div><div class="line"><a name="l00148"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a5695a8062e02b0bdc48723b75f215ca3"> 148</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a5695a8062e02b0bdc48723b75f215ca3">stepSize</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_1MiniBatchSGD.html#ad88647ff30103350ba0ac296e965993d"> 151</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#ad88647ff30103350ba0ac296e965993d">maxIterations</a>;</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> </div><div class="line"><a name="l00154"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#afbcad6a84e07072c718b68049d27ece8"> 154</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#afbcad6a84e07072c718b68049d27ece8">tolerance</a>;</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div><div class="line"><a name="l00158"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a9d2859a232290853a81d2ca143882f35"> 158</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a9d2859a232290853a81d2ca143882f35">shuffle</a>;</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> };</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> </div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> } <span class="comment">// namespace optimization</span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> } <span class="comment">// namespace mlpack</span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> </div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment">// Include implementation.</span></div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="preprocessor">#include "minibatch_sgd_impl.hpp"</span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> </div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classmlpack_1_1optimization_1_1MiniBatchSGD_html_aa87b27e65bb995d63cc976c7c9fd9d52"><div class="ttname"><a href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#aa87b27e65bb995d63cc976c7c9fd9d52">mlpack::optimization::MiniBatchSGD::batchSize</a></div><div class="ttdeci">size_t batchSize</div><div class="ttdoc">The size of each mini-batch. </div><div class="ttdef"><b>Definition:</b> <a href="minibatch__sgd_8hpp_source.html#l00145">minibatch_sgd.hpp:145</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1MiniBatchSGD_html_ab2ca6ae65a0dca7b18ae56d2c1340e05"><div class="ttname"><a href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#ab2ca6ae65a0dca7b18ae56d2c1340e05">mlpack::optimization::MiniBatchSGD::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="minibatch__sgd_8hpp_source.html#l00138">minibatch_sgd.hpp:138</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_1MiniBatchSGD_html_a8bf3c9ed107adb32109657f443a747a7"><div class="ttname"><a href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a8bf3c9ed107adb32109657f443a747a7">mlpack::optimization::MiniBatchSGD::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="minibatch__sgd_8hpp_source.html#l00133">minibatch_sgd.hpp:133</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1MiniBatchSGD_html_a55758ee335253b0e0b2f82e4a01ee965"><div class="ttname"><a href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a55758ee335253b0e0b2f82e4a01ee965">mlpack::optimization::MiniBatchSGD::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="minibatch__sgd_8hpp_source.html#l00111">minibatch_sgd.hpp:111</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_1MiniBatchSGD_html_a15035e9fb9538743cd8bd3e05fd31977"><div class="ttname"><a href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a15035e9fb9538743cd8bd3e05fd31977">mlpack::optimization::MiniBatchSGD::MiniBatchSGD</a></div><div class="ttdeci">MiniBatchSGD(DecomposableFunctionType &function, const size_t batchSize=1000, const double stepSize=0.01, const size_t maxIterations=100000, const double tolerance=1e-5, const bool shuffle=true)</div><div class="ttdoc">Construct the MiniBatchSGD optimizer with the given function and parameters. </div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1MiniBatchSGD_html"><div class="ttname"><a href="classmlpack_1_1optimization_1_1MiniBatchSGD.html">mlpack::optimization::MiniBatchSGD</a></div><div class="ttdoc">Mini-batch Stochastic Gradient Descent is a technique for minimizing a function which can be expresse...</div><div class="ttdef"><b>Definition:</b> <a href="minibatch__sgd_8hpp_source.html#l00074">minibatch_sgd.hpp:74</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1MiniBatchSGD_html_a35a9ef041c0bb3f940e78593754ac536"><div class="ttname"><a href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a35a9ef041c0bb3f940e78593754ac536">mlpack::optimization::MiniBatchSGD::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="minibatch__sgd_8hpp_source.html#l00126">minibatch_sgd.hpp:126</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1MiniBatchSGD_html_a90c9709a7dd0312d5ff93a312a5fe9db"><div class="ttname"><a href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a90c9709a7dd0312d5ff93a312a5fe9db">mlpack::optimization::MiniBatchSGD::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="minibatch__sgd_8hpp_source.html#l00131">minibatch_sgd.hpp:131</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1MiniBatchSGD_html_a5dd0b12834b720a696a6d33ef438f93e"><div class="ttname"><a href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a5dd0b12834b720a696a6d33ef438f93e">mlpack::optimization::MiniBatchSGD::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="minibatch__sgd_8hpp_source.html#l00128">minibatch_sgd.hpp:128</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1MiniBatchSGD_html_a35502af6b3f7732738e2caf8eb8fe96c"><div class="ttname"><a href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a35502af6b3f7732738e2caf8eb8fe96c">mlpack::optimization::MiniBatchSGD::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="minibatch__sgd_8hpp_source.html#l00113">minibatch_sgd.hpp:113</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1MiniBatchSGD_html_afbcad6a84e07072c718b68049d27ece8"><div class="ttname"><a href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#afbcad6a84e07072c718b68049d27ece8">mlpack::optimization::MiniBatchSGD::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="minibatch__sgd_8hpp_source.html#l00154">minibatch_sgd.hpp:154</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1MiniBatchSGD_html_a5695a8062e02b0bdc48723b75f215ca3"><div class="ttname"><a href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a5695a8062e02b0bdc48723b75f215ca3">mlpack::optimization::MiniBatchSGD::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="minibatch__sgd_8hpp_source.html#l00148">minibatch_sgd.hpp:148</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1MiniBatchSGD_html_a3899b6a9ded146d82bb4458c03302073"><div class="ttname"><a href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a3899b6a9ded146d82bb4458c03302073">mlpack::optimization::MiniBatchSGD::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="minibatch__sgd_8hpp_source.html#l00123">minibatch_sgd.hpp:123</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1MiniBatchSGD_html_ab6ba9ce7ae508fe85c7620576a68f20a"><div class="ttname"><a href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#ab6ba9ce7ae508fe85c7620576a68f20a">mlpack::optimization::MiniBatchSGD::Optimize</a></div><div class="ttdeci">double Optimize(arma::mat &iterate)</div><div class="ttdoc">Optimize the given function using mini-batch SGD. </div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1MiniBatchSGD_html_a9d2859a232290853a81d2ca143882f35"><div class="ttname"><a href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a9d2859a232290853a81d2ca143882f35">mlpack::optimization::MiniBatchSGD::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="minibatch__sgd_8hpp_source.html#l00158">minibatch_sgd.hpp:158</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1MiniBatchSGD_html_ad901c56284441c5bb5af30b549e2ae8a"><div class="ttname"><a href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#ad901c56284441c5bb5af30b549e2ae8a">mlpack::optimization::MiniBatchSGD::BatchSize</a></div><div class="ttdeci">size_t & BatchSize()</div><div class="ttdoc">Modify the batch size. </div><div class="ttdef"><b>Definition:</b> <a href="minibatch__sgd_8hpp_source.html#l00118">minibatch_sgd.hpp:118</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1MiniBatchSGD_html_aa680a3700b1105df18a8f85374b56638"><div class="ttname"><a href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#aa680a3700b1105df18a8f85374b56638">mlpack::optimization::MiniBatchSGD::BatchSize</a></div><div class="ttdeci">size_t BatchSize() const </div><div class="ttdoc">Get the batch size. </div><div class="ttdef"><b>Definition:</b> <a href="minibatch__sgd_8hpp_source.html#l00116">minibatch_sgd.hpp:116</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1MiniBatchSGD_html_a00169352ab9074e067ab37864e115dbb"><div class="ttname"><a href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a00169352ab9074e067ab37864e115dbb">mlpack::optimization::MiniBatchSGD::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="minibatch__sgd_8hpp_source.html#l00121">minibatch_sgd.hpp:121</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1MiniBatchSGD_html_ad88647ff30103350ba0ac296e965993d"><div class="ttname"><a href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#ad88647ff30103350ba0ac296e965993d">mlpack::optimization::MiniBatchSGD::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="minibatch__sgd_8hpp_source.html#l00151">minibatch_sgd.hpp:151</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1MiniBatchSGD_html_a73566d6bfca44f2b0c77650c01fbff1e"><div class="ttname"><a href="classmlpack_1_1optimization_1_1MiniBatchSGD.html#a73566d6bfca44f2b0c77650c01fbff1e">mlpack::optimization::MiniBatchSGD::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="minibatch__sgd_8hpp_source.html#l00136">minibatch_sgd.hpp:136</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>
|