138 lines
35 KiB
HTML
138 lines
35 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/methods/softmax_regression/softmax_regression.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_3cfbf900288ec2fe8dd2c2c8482f216e.html">methods</a></li><li class="navelem"><a class="el" href="dir_ef6c2ad6ea2e7fbc564fdee0127eb9cb.html">softmax_regression</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">softmax_regression.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="softmax__regression_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_METHODS_SOFTMAX_REGRESSION_SOFTMAX_REGRESSION_HPP</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#define MLPACK_METHODS_SOFTMAX_REGRESSION_SOFTMAX_REGRESSION_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> <span class="preprocessor">#include <<a class="code" href="lbfgs_8hpp.html">mlpack/core/optimizers/lbfgs/lbfgs.hpp</a>></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "<a class="code" href="softmax__regression__function_8hpp.html">softmax_regression_function.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>regression {</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="keyword">template</span><</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">template</span><<span class="keyword">typename</span>> <span class="keyword">class </span>OptimizerType = <a class="code" href="classmlpack_1_1optimization_1_1L__BFGS.html">mlpack::optimization::L_BFGS</a></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> ></div><div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classmlpack_1_1regression_1_1SoftmaxRegression.html"> 65</a></span> <span class="keyword">class </span><a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html">SoftmaxRegression</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="l00077"></a><span class="lineno"> 77</span>  <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#acfda4ac0b9d1c0bce568216082c7cff9">SoftmaxRegression</a>(<span class="keyword">const</span> <span class="keywordtype">size_t</span> inputSize = 0,</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#aaed8a6bfc7425da155ba44a23e4668f8">numClasses</a> = 0,</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">const</span> <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#ae643ea6357151eb09f76e85d2e685f57">fitIntercept</a> = <span class="keyword">false</span>);</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#acfda4ac0b9d1c0bce568216082c7cff9">SoftmaxRegression</a>(<span class="keyword">const</span> arma::mat& data,</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keyword">const</span> arma::Row<size_t>& labels,</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_1regression_1_1SoftmaxRegression.html#aaed8a6bfc7425da155ba44a23e4668f8">numClasses</a>,</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_1regression_1_1SoftmaxRegression.html#aef8244c429815ff3172bc9adeb8547d4">lambda</a> = 0.0001,</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_1regression_1_1SoftmaxRegression.html#ae643ea6357151eb09f76e85d2e685f57">fitIntercept</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="l00109"></a><span class="lineno"> 109</span>  <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#acfda4ac0b9d1c0bce568216082c7cff9">SoftmaxRegression</a>(OptimizerType<SoftmaxRegressionFunction>& optimizer);</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <a class="code" href="deprecated_8hpp.html#a3d7d5df477a8805980e43e423e18a525">mlpack_deprecated</a> <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#ae7700132c466763bc4adf5d937979876">Predict</a>(<span class="keyword">const</span> arma::mat& testData,</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  arma::Row<size_t>& predictions) <span class="keyword">const</span>;</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#ae45e4d9839896128f87a19f8185b987c">Classify</a>(<span class="keyword">const</span> arma::mat& dataset, arma::Row<size_t>& labels) <span class="keyword">const</span>;</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#a4efe331c20f62c5980144c7e1d79d540">ComputeAccuracy</a>(<span class="keyword">const</span> arma::mat& testData,</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="keyword">const</span> arma::Row<size_t>& labels) <span class="keyword">const</span>;</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#a845c6e6199bd5d5cf67c4705ee23fe21">Train</a>(OptimizerType<SoftmaxRegressionFunction>& optimizer);</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> </div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#a845c6e6199bd5d5cf67c4705ee23fe21">Train</a>(<span class="keyword">const</span> arma::mat &data, <span class="keyword">const</span> arma::Row<size_t>& labels,</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span> numClasses);</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> </div><div class="line"><a name="l00168"></a><span class="lineno"><a class="line" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#a8032ac6b0433178822f5c249817064f4"> 168</a></span>  <span class="keywordtype">size_t</span>& <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#a8032ac6b0433178822f5c249817064f4">NumClasses</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#aaed8a6bfc7425da155ba44a23e4668f8">numClasses</a>; }</div><div class="line"><a name="l00170"></a><span class="lineno"><a class="line" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#ac7c2654cd2afd45488a73c537aa50438"> 170</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#ac7c2654cd2afd45488a73c537aa50438">NumClasses</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#aaed8a6bfc7425da155ba44a23e4668f8">numClasses</a>; }</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> </div><div class="line"><a name="l00173"></a><span class="lineno"><a class="line" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#a05874dd6a0566c6fd98704469eb3c52f"> 173</a></span>  <span class="keywordtype">double</span>& <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#a05874dd6a0566c6fd98704469eb3c52f">Lambda</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#aef8244c429815ff3172bc9adeb8547d4">lambda</a>; }</div><div class="line"><a name="l00175"></a><span class="lineno"><a class="line" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#ab36546ccd6396e56aa98b944a48454f9"> 175</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#ab36546ccd6396e56aa98b944a48454f9">Lambda</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#aef8244c429815ff3172bc9adeb8547d4">lambda</a>; }</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> </div><div class="line"><a name="l00178"></a><span class="lineno"><a class="line" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#ae458fe0155bc5bcf7098baba03ad0c5c"> 178</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#ae458fe0155bc5bcf7098baba03ad0c5c">FitIntercept</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#ae643ea6357151eb09f76e85d2e685f57">fitIntercept</a>; }</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> </div><div class="line"><a name="l00181"></a><span class="lineno"><a class="line" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#abbb2e08416cb7e0d44cc978121159f8f"> 181</a></span>  arma::mat& <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#abbb2e08416cb7e0d44cc978121159f8f">Parameters</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#adfea798694e3d7f89a6b19da02f0b44d">parameters</a>; }</div><div class="line"><a name="l00183"></a><span class="lineno"><a class="line" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#a8edc251f8933e00178fc6aef04e75ed6"> 183</a></span>  <span class="keyword">const</span> arma::mat& <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#a8edc251f8933e00178fc6aef04e75ed6">Parameters</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#adfea798694e3d7f89a6b19da02f0b44d">parameters</a>; }</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> </div><div class="line"><a name="l00186"></a><span class="lineno"><a class="line" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#abb105ab8417e765169e6e58bd1892d95"> 186</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#abb105ab8417e765169e6e58bd1892d95">FeatureSize</a>()<span class="keyword"> const</span></div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="keyword"> </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#ae643ea6357151eb09f76e85d2e685f57">fitIntercept</a> ? <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#adfea798694e3d7f89a6b19da02f0b44d">parameters</a>.n_cols - 1 :</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#adfea798694e3d7f89a6b19da02f0b44d">parameters</a>.n_cols; }</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> </div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  <span class="keyword">template</span><<span class="keyword">typename</span> Archive></div><div class="line"><a name="l00194"></a><span class="lineno"><a class="line" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#aa403b4fc83017f8268eee3d68bc3785d"> 194</a></span>  <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#aa403b4fc83017f8268eee3d68bc3785d">Serialize</a>(Archive& ar, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <span class="comment">/* version */</span>)</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  {</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  <span class="keyword">using</span> <a class="code" href="namespacemlpack_1_1data.html#a785ee98e0070286ef86eeeea85a74018">mlpack::data::CreateNVP</a>;</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> </div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  ar & <a class="code" href="namespacemlpack_1_1data.html#a785ee98e0070286ef86eeeea85a74018">CreateNVP</a>(<a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#adfea798694e3d7f89a6b19da02f0b44d">parameters</a>, <span class="stringliteral">"parameters"</span>);</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  ar & <a class="code" href="namespacemlpack_1_1data.html#a785ee98e0070286ef86eeeea85a74018">CreateNVP</a>(numClasses, <span class="stringliteral">"numClasses"</span>);</div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  ar & <a class="code" href="namespacemlpack_1_1data.html#a785ee98e0070286ef86eeeea85a74018">CreateNVP</a>(<a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#aef8244c429815ff3172bc9adeb8547d4">lambda</a>, <span class="stringliteral">"lambda"</span>);</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  ar & <a class="code" href="namespacemlpack_1_1data.html#a785ee98e0070286ef86eeeea85a74018">CreateNVP</a>(<a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#ae643ea6357151eb09f76e85d2e685f57">fitIntercept</a>, <span class="stringliteral">"fitIntercept"</span>);</div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  }</div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> </div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00206"></a><span class="lineno"><a class="line" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#adfea798694e3d7f89a6b19da02f0b44d"> 206</a></span>  arma::mat <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#adfea798694e3d7f89a6b19da02f0b44d">parameters</a>;</div><div class="line"><a name="l00208"></a><span class="lineno"><a class="line" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#aaed8a6bfc7425da155ba44a23e4668f8"> 208</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#aaed8a6bfc7425da155ba44a23e4668f8">numClasses</a>;</div><div class="line"><a name="l00210"></a><span class="lineno"><a class="line" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#aef8244c429815ff3172bc9adeb8547d4"> 210</a></span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#aef8244c429815ff3172bc9adeb8547d4">lambda</a>;</div><div class="line"><a name="l00212"></a><span class="lineno"><a class="line" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#ae643ea6357151eb09f76e85d2e685f57"> 212</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegression.html#ae643ea6357151eb09f76e85d2e685f57">fitIntercept</a>;</div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> };</div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> </div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span> } <span class="comment">// namespace regression</span></div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span> } <span class="comment">// namespace mlpack</span></div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span> </div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment">// Include implementation.</span></div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="preprocessor">#include "softmax_regression_impl.hpp"</span></div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span> </div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegression_html_a05874dd6a0566c6fd98704469eb3c52f"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegression.html#a05874dd6a0566c6fd98704469eb3c52f">mlpack::regression::SoftmaxRegression::Lambda</a></div><div class="ttdeci">double & Lambda()</div><div class="ttdoc">Sets the regularization parameter. </div><div class="ttdef"><b>Definition:</b> <a href="softmax__regression_8hpp_source.html#l00173">softmax_regression.hpp:173</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegression_html_ae7700132c466763bc4adf5d937979876"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegression.html#ae7700132c466763bc4adf5d937979876">mlpack::regression::SoftmaxRegression::Predict</a></div><div class="ttdeci">mlpack_deprecated void Predict(const arma::mat &testData, arma::Row< size_t > &predictions) const </div><div class="ttdoc">Predict the class labels for the provided feature points. </div></div>
|
|
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegression_html_acfda4ac0b9d1c0bce568216082c7cff9"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegression.html#acfda4ac0b9d1c0bce568216082c7cff9">mlpack::regression::SoftmaxRegression::SoftmaxRegression</a></div><div class="ttdeci">SoftmaxRegression(const size_t inputSize=0, const size_t numClasses=0, const bool fitIntercept=false)</div><div class="ttdoc">Initialize the SoftmaxRegression without performing training. </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_1regression_1_1SoftmaxRegression_html_abbb2e08416cb7e0d44cc978121159f8f"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegression.html#abbb2e08416cb7e0d44cc978121159f8f">mlpack::regression::SoftmaxRegression::Parameters</a></div><div class="ttdeci">arma::mat & Parameters()</div><div class="ttdoc">Get the model parameters. </div><div class="ttdef"><b>Definition:</b> <a href="softmax__regression_8hpp_source.html#l00181">softmax_regression.hpp:181</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="namespacemlpack_1_1data_html_a785ee98e0070286ef86eeeea85a74018"><div class="ttname"><a href="namespacemlpack_1_1data.html#a785ee98e0070286ef86eeeea85a74018">mlpack::data::CreateNVP</a></div><div class="ttdeci">FirstShim< T > CreateNVP(T &t, const std::string &name, typename std::enable_if_t< HasSerialize< T >::value > *=0)</div><div class="ttdoc">Call this function to produce a name-value pair; this is similar to BOOST_SERIALIZATION_NVP(), but should be used for types that have a Serialize() function (or contain a type that has a Serialize() function) instead of a serialize() function. </div><div class="ttdef"><b>Definition:</b> <a href="serialization__shim_8hpp_source.html#l00094">serialization_shim.hpp:94</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegression_html_aaed8a6bfc7425da155ba44a23e4668f8"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegression.html#aaed8a6bfc7425da155ba44a23e4668f8">mlpack::regression::SoftmaxRegression::numClasses</a></div><div class="ttdeci">size_t numClasses</div><div class="ttdoc">Number of classes. </div><div class="ttdef"><b>Definition:</b> <a href="softmax__regression_8hpp_source.html#l00208">softmax_regression.hpp:208</a></div></div>
|
|
<div class="ttc" id="deprecated_8hpp_html_a3d7d5df477a8805980e43e423e18a525"><div class="ttname"><a href="deprecated_8hpp.html#a3d7d5df477a8805980e43e423e18a525">mlpack_deprecated</a></div><div class="ttdeci">#define mlpack_deprecated</div><div class="ttdef"><b>Definition:</b> <a href="deprecated_8hpp_source.html#l00022">deprecated.hpp:22</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegression_html_a8edc251f8933e00178fc6aef04e75ed6"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegression.html#a8edc251f8933e00178fc6aef04e75ed6">mlpack::regression::SoftmaxRegression::Parameters</a></div><div class="ttdeci">const arma::mat & Parameters() const </div><div class="ttdoc">Get the model parameters. </div><div class="ttdef"><b>Definition:</b> <a href="softmax__regression_8hpp_source.html#l00183">softmax_regression.hpp:183</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegression_html_a845c6e6199bd5d5cf67c4705ee23fe21"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegression.html#a845c6e6199bd5d5cf67c4705ee23fe21">mlpack::regression::SoftmaxRegression::Train</a></div><div class="ttdeci">double Train(OptimizerType< SoftmaxRegressionFunction > &optimizer)</div><div class="ttdoc">Train the softmax regression model with the given optimizer. </div></div>
|
|
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegression_html_ae45e4d9839896128f87a19f8185b987c"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegression.html#ae45e4d9839896128f87a19f8185b987c">mlpack::regression::SoftmaxRegression::Classify</a></div><div class="ttdeci">void Classify(const arma::mat &dataset, arma::Row< size_t > &labels) const </div><div class="ttdoc">Classify the given points, returning the predicted labels for each point. </div></div>
|
|
<div class="ttc" id="lbfgs_8hpp_html"><div class="ttname"><a href="lbfgs_8hpp.html">lbfgs.hpp</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegression_html"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegression.html">mlpack::regression::SoftmaxRegression</a></div><div class="ttdoc">Softmax Regression is a classifier which can be used for classification when the data available can t...</div><div class="ttdef"><b>Definition:</b> <a href="softmax__regression_8hpp_source.html#l00065">softmax_regression.hpp:65</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegression_html_a8032ac6b0433178822f5c249817064f4"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegression.html#a8032ac6b0433178822f5c249817064f4">mlpack::regression::SoftmaxRegression::NumClasses</a></div><div class="ttdeci">size_t & NumClasses()</div><div class="ttdoc">Sets the number of classes. </div><div class="ttdef"><b>Definition:</b> <a href="softmax__regression_8hpp_source.html#l00168">softmax_regression.hpp:168</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegression_html_ae643ea6357151eb09f76e85d2e685f57"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegression.html#ae643ea6357151eb09f76e85d2e685f57">mlpack::regression::SoftmaxRegression::fitIntercept</a></div><div class="ttdeci">bool fitIntercept</div><div class="ttdoc">Intercept term flag. </div><div class="ttdef"><b>Definition:</b> <a href="softmax__regression_8hpp_source.html#l00212">softmax_regression.hpp:212</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegression_html_ac7c2654cd2afd45488a73c537aa50438"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegression.html#ac7c2654cd2afd45488a73c537aa50438">mlpack::regression::SoftmaxRegression::NumClasses</a></div><div class="ttdeci">size_t NumClasses() const </div><div class="ttdoc">Gets the number of classes. </div><div class="ttdef"><b>Definition:</b> <a href="softmax__regression_8hpp_source.html#l00170">softmax_regression.hpp:170</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegression_html_ab36546ccd6396e56aa98b944a48454f9"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegression.html#ab36546ccd6396e56aa98b944a48454f9">mlpack::regression::SoftmaxRegression::Lambda</a></div><div class="ttdeci">double Lambda() const </div><div class="ttdoc">Gets the regularization parameter. </div><div class="ttdef"><b>Definition:</b> <a href="softmax__regression_8hpp_source.html#l00175">softmax_regression.hpp:175</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegression_html_ae458fe0155bc5bcf7098baba03ad0c5c"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegression.html#ae458fe0155bc5bcf7098baba03ad0c5c">mlpack::regression::SoftmaxRegression::FitIntercept</a></div><div class="ttdeci">bool FitIntercept() const </div><div class="ttdoc">Gets the intercept term flag. We can&#39;t change this after training. </div><div class="ttdef"><b>Definition:</b> <a href="softmax__regression_8hpp_source.html#l00178">softmax_regression.hpp:178</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegression_html_aa403b4fc83017f8268eee3d68bc3785d"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegression.html#aa403b4fc83017f8268eee3d68bc3785d">mlpack::regression::SoftmaxRegression::Serialize</a></div><div class="ttdeci">void Serialize(Archive &ar, const unsigned int)</div><div class="ttdoc">Serialize the SoftmaxRegression model. </div><div class="ttdef"><b>Definition:</b> <a href="softmax__regression_8hpp_source.html#l00194">softmax_regression.hpp:194</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegression_html_aef8244c429815ff3172bc9adeb8547d4"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegression.html#aef8244c429815ff3172bc9adeb8547d4">mlpack::regression::SoftmaxRegression::lambda</a></div><div class="ttdeci">double lambda</div><div class="ttdoc">L2-regularization constant. </div><div class="ttdef"><b>Definition:</b> <a href="softmax__regression_8hpp_source.html#l00210">softmax_regression.hpp:210</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegression_html_abb105ab8417e765169e6e58bd1892d95"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegression.html#abb105ab8417e765169e6e58bd1892d95">mlpack::regression::SoftmaxRegression::FeatureSize</a></div><div class="ttdeci">size_t FeatureSize() const </div><div class="ttdoc">Gets the features size of the training data. </div><div class="ttdef"><b>Definition:</b> <a href="softmax__regression_8hpp_source.html#l00186">softmax_regression.hpp:186</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegression_html_adfea798694e3d7f89a6b19da02f0b44d"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegression.html#adfea798694e3d7f89a6b19da02f0b44d">mlpack::regression::SoftmaxRegression::parameters</a></div><div class="ttdeci">arma::mat parameters</div><div class="ttdoc">Parameters after optimization. </div><div class="ttdef"><b>Definition:</b> <a href="softmax__regression_8hpp_source.html#l00206">softmax_regression.hpp:206</a></div></div>
|
|
<div class="ttc" id="softmax__regression__function_8hpp_html"><div class="ttname"><a href="softmax__regression__function_8hpp.html">softmax_regression_function.hpp</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1L__BFGS_html"><div class="ttname"><a href="classmlpack_1_1optimization_1_1L__BFGS.html">mlpack::optimization::L_BFGS</a></div><div class="ttdoc">The generic L-BFGS optimizer, which uses a back-tracking line search algorithm to minimize a function...</div><div class="ttdef"><b>Definition:</b> <a href="lbfgs_8hpp_source.html#l00034">lbfgs.hpp:34</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegression_html_a4efe331c20f62c5980144c7e1d79d540"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegression.html#a4efe331c20f62c5980144c7e1d79d540">mlpack::regression::SoftmaxRegression::ComputeAccuracy</a></div><div class="ttdeci">double ComputeAccuracy(const arma::mat &testData, const arma::Row< size_t > &labels) const </div><div class="ttdoc">Computes accuracy of the learned model given the feature data and the labels associated with each dat...</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>
|