Files
BayesNet/docs/manual/_classifier_8h_source.html

185 lines
18 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.11.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>BayesNet: /Users/rmontanana/Code/BayesNet/bayesnet/classifiers/Classifier.h 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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>
<link href="doxygen.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 id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logo_small.png"/></td>
<td id="projectalign">
<div id="projectname">BayesNet<span id="projectnumber">&#160;1.0.5</span>
</div>
<div id="projectbrief">Bayesian Network Classifiers using libtorch from scratch</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.11.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('_classifier_8h_source.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">Classifier.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// ***************************************************************</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// SPDX-FileCopyrightText: Copyright 2024 Ricardo Montañana Gómez</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// SPDX-FileType: SOURCE</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment">// SPDX-License-Identifier: MIT</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">// ***************************************************************</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#ifndef CLASSIFIER_H</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#define CLASSIFIER_H</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &lt;torch/torch.h&gt;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &quot;bayesnet/utils/BayesMetrics.h&quot;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include &quot;bayesnet/network/Network.h&quot;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include &quot;bayesnet/BaseClassifier.h&quot;</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="keyword">namespace </span>bayesnet {</div>
<div class="foldopen" id="foldopen00015" data-start="{" data-end="};">
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="classbayesnet_1_1_classifier.html"> 15</a></span> <span class="keyword">class </span><a class="code hl_class" href="classbayesnet_1_1_classifier.html">Classifier</a> : <span class="keyword">public</span> <a class="code hl_class" href="classbayesnet_1_1_base_classifier.html">BaseClassifier</a> {</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <a class="code hl_class" href="classbayesnet_1_1_classifier.html">Classifier</a>(<a class="code hl_class" href="classbayesnet_1_1_network.html">Network</a> model);</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">virtual</span> <a class="code hl_class" href="classbayesnet_1_1_classifier.html">~Classifier</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <a class="code hl_class" href="classbayesnet_1_1_classifier.html">Classifier</a>&amp; fit(std::vector&lt;std::vector&lt;int&gt;&gt;&amp; X, std::vector&lt;int&gt;&amp; y, <span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; features, <span class="keyword">const</span> std::string&amp; className, std::map&lt;std::string, std::vector&lt;int&gt;&gt;&amp; states) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <a class="code hl_class" href="classbayesnet_1_1_classifier.html">Classifier</a>&amp; fit(torch::Tensor&amp; X, torch::Tensor&amp; y, <span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; features, <span class="keyword">const</span> std::string&amp; className, std::map&lt;std::string, std::vector&lt;int&gt;&gt;&amp; states) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <a class="code hl_class" href="classbayesnet_1_1_classifier.html">Classifier</a>&amp; fit(torch::Tensor&amp; dataset, <span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; features, <span class="keyword">const</span> std::string&amp; className, std::map&lt;std::string, std::vector&lt;int&gt;&gt;&amp; states) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <a class="code hl_class" href="classbayesnet_1_1_classifier.html">Classifier</a>&amp; fit(torch::Tensor&amp; dataset, <span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; features, <span class="keyword">const</span> std::string&amp; className, std::map&lt;std::string, std::vector&lt;int&gt;&gt;&amp; states, <span class="keyword">const</span> torch::Tensor&amp; weights) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keywordtype">void</span> addNodes();</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keywordtype">int</span> getNumberOfNodes() <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keywordtype">int</span> getNumberOfEdges() <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keywordtype">int</span> getNumberOfStates() <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keywordtype">int</span> getClassNumStates() <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> torch::Tensor predict(torch::Tensor&amp; X) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> std::vector&lt;int&gt; predict(std::vector&lt;std::vector&lt;int&gt;&gt;&amp; X) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> torch::Tensor predict_proba(torch::Tensor&amp; X) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> std::vector&lt;std::vector&lt;double&gt;&gt; predict_proba(std::vector&lt;std::vector&lt;int&gt;&gt;&amp; X) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> status_t getStatus()<span class="keyword"> const override </span>{ <span class="keywordflow">return</span> status; }</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> std::string getVersion()<span class="keyword"> override </span>{ <span class="keywordflow">return</span> { project_version.begin(), project_version.end() }; };</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keywordtype">float</span> score(torch::Tensor&amp; X, torch::Tensor&amp; y) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keywordtype">float</span> score(std::vector&lt;std::vector&lt;int&gt;&gt;&amp; X, std::vector&lt;int&gt;&amp; y) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> std::vector&lt;std::string&gt; show() <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> std::vector&lt;std::string&gt; topological_order() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> std::vector&lt;std::string&gt; getNotes()<span class="keyword"> const override </span>{ <span class="keywordflow">return</span> notes; }</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> std::string dump_cpt() <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keywordtype">void</span> setHyperparameters(<span class="keyword">const</span> nlohmann::json&amp; hyperparameters) <span class="keyword">override</span>; <span class="comment">//For classifiers that don&#39;t have hyperparameters</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">protected</span>:</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keywordtype">bool</span> fitted;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> m, n; <span class="comment">// m: number of samples, n: number of features</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <a class="code hl_class" href="classbayesnet_1_1_network.html">Network</a> model;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> Metrics metrics;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> std::vector&lt;std::string&gt; features;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> std::string className;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> std::map&lt;std::string, std::vector&lt;int&gt;&gt; states;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> torch::Tensor dataset; <span class="comment">// (n+1)xm tensor</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> status_t status = NORMAL;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> std::vector&lt;std::string&gt; notes; <span class="comment">// Used to store messages occurred during the fit process</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keywordtype">void</span> checkFitParameters();</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> buildModel(<span class="keyword">const</span> torch::Tensor&amp; weights) = 0;</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keywordtype">void</span> trainModel(<span class="keyword">const</span> torch::Tensor&amp; weights) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keywordtype">void</span> buildDataset(torch::Tensor&amp; y);</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <a class="code hl_class" href="classbayesnet_1_1_classifier.html">Classifier</a>&amp; build(<span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; features, <span class="keyword">const</span> std::string&amp; className, std::map&lt;std::string, std::vector&lt;int&gt;&gt;&amp; states, <span class="keyword">const</span> torch::Tensor&amp; weights);</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> };</div>
</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span>}</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="ttc" id="aclassbayesnet_1_1_base_classifier_html"><div class="ttname"><a href="classbayesnet_1_1_base_classifier.html">bayesnet::BaseClassifier</a></div><div class="ttdef"><b>Definition</b> <a href="_base_classifier_8h_source.html#l00013">BaseClassifier.h:13</a></div></div>
<div class="ttc" id="aclassbayesnet_1_1_classifier_html"><div class="ttname"><a href="classbayesnet_1_1_classifier.html">bayesnet::Classifier</a></div><div class="ttdef"><b>Definition</b> <a href="#l00015">Classifier.h:15</a></div></div>
<div class="ttc" id="aclassbayesnet_1_1_network_html"><div class="ttname"><a href="classbayesnet_1_1_network.html">bayesnet::Network</a></div><div class="ttdef"><b>Definition</b> <a href="_network_8h_source.html#l00015">Network.h:15</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_40070fdff85d618b4d1d3ab4ac4f79bb.html">bayesnet</a></li><li class="navelem"><a class="el" href="dir_520a649ed2b1c3b658a695aeefe46a5a.html">classifiers</a></li><li class="navelem"><b>Classifier.h</b></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.11.0 </li>
</ul>
</div>
</body>
</html>