992 lines
52 KiB
HTML
992 lines
52 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.9.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>SVM Classifier C++: svm_classifier::SVMClassifier Class Reference</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>
|
|
<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="projectalign">
|
|
<div id="projectname">SVM Classifier C++<span id="projectnumber"> 1.0.0</span>
|
|
</div>
|
|
<div id="projectbrief">High-performance Support Vector Machine classifier with scikit-learn compatible API</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @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&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></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">
|
|
<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 id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><b>svm_classifier</b></li><li class="navelem"><a class="el" href="classsvm__classifier_1_1SVMClassifier.html">SVMClassifier</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classsvm__classifier_1_1SVMClassifier-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">svm_classifier::SVMClassifier Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Support Vector Machine Classifier with scikit-learn compatible API.
|
|
<a href="classsvm__classifier_1_1SVMClassifier.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="svm__classifier_8hpp_source.html">svm_classifier.hpp</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a3ed45cdbc3fc5d947320177f42115dcf" id="r_a3ed45cdbc3fc5d947320177f42115dcf"><td class="memItemLeft" align="right" valign="top"><a id="a3ed45cdbc3fc5d947320177f42115dcf" name="a3ed45cdbc3fc5d947320177f42115dcf"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>SVMClassifier</b> ()</td></tr>
|
|
<tr class="memdesc:a3ed45cdbc3fc5d947320177f42115dcf"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor with default parameters. <br /></td></tr>
|
|
<tr class="separator:a3ed45cdbc3fc5d947320177f42115dcf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2afb41f77de4e8de6368d274a30191ec" id="r_a2afb41f77de4e8de6368d274a30191ec"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvm__classifier_1_1SVMClassifier.html#a2afb41f77de4e8de6368d274a30191ec">SVMClassifier</a> (const nlohmann::json &config)</td></tr>
|
|
<tr class="memdesc:a2afb41f77de4e8de6368d274a30191ec"><td class="mdescLeft"> </td><td class="mdescRight">Constructor with JSON parameters. <br /></td></tr>
|
|
<tr class="separator:a2afb41f77de4e8de6368d274a30191ec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a90b2f18dd2cfeb23cf1375f265e22db0" id="r_a90b2f18dd2cfeb23cf1375f265e22db0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvm__classifier_1_1SVMClassifier.html#a90b2f18dd2cfeb23cf1375f265e22db0">SVMClassifier</a> (KernelType kernel, double C=1.0, MulticlassStrategy multiclass_strategy=MulticlassStrategy::ONE_VS_REST)</td></tr>
|
|
<tr class="memdesc:a90b2f18dd2cfeb23cf1375f265e22db0"><td class="mdescLeft"> </td><td class="mdescRight">Constructor with explicit parameters. <br /></td></tr>
|
|
<tr class="separator:a90b2f18dd2cfeb23cf1375f265e22db0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a233584f6696969ce1a402624fd046146" id="r_a233584f6696969ce1a402624fd046146"><td class="memItemLeft" align="right" valign="top"><a id="a233584f6696969ce1a402624fd046146" name="a233584f6696969ce1a402624fd046146"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>~SVMClassifier</b> ()</td></tr>
|
|
<tr class="memdesc:a233584f6696969ce1a402624fd046146"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
|
|
<tr class="separator:a233584f6696969ce1a402624fd046146"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a377b6082ac4153be3197ef70c1c82984" id="r_a377b6082ac4153be3197ef70c1c82984"><td class="memItemLeft" align="right" valign="top"><a id="a377b6082ac4153be3197ef70c1c82984" name="a377b6082ac4153be3197ef70c1c82984"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>SVMClassifier</b> (const <a class="el" href="classsvm__classifier_1_1SVMClassifier.html">SVMClassifier</a> &)=delete</td></tr>
|
|
<tr class="memdesc:a377b6082ac4153be3197ef70c1c82984"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor (deleted - models are not copyable) <br /></td></tr>
|
|
<tr class="separator:a377b6082ac4153be3197ef70c1c82984"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a209902805c75e8f22c55575adfedc7be" id="r_a209902805c75e8f22c55575adfedc7be"><td class="memItemLeft" align="right" valign="top"><a id="a209902805c75e8f22c55575adfedc7be" name="a209902805c75e8f22c55575adfedc7be"></a>
|
|
<a class="el" href="classsvm__classifier_1_1SVMClassifier.html">SVMClassifier</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classsvm__classifier_1_1SVMClassifier.html">SVMClassifier</a> &)=delete</td></tr>
|
|
<tr class="memdesc:a209902805c75e8f22c55575adfedc7be"><td class="mdescLeft"> </td><td class="mdescRight">Copy assignment (deleted - models are not copyable) <br /></td></tr>
|
|
<tr class="separator:a209902805c75e8f22c55575adfedc7be"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae2eafdc66d1907c145efffd186dfff3f" id="r_ae2eafdc66d1907c145efffd186dfff3f"><td class="memItemLeft" align="right" valign="top"><a id="ae2eafdc66d1907c145efffd186dfff3f" name="ae2eafdc66d1907c145efffd186dfff3f"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>SVMClassifier</b> (<a class="el" href="classsvm__classifier_1_1SVMClassifier.html">SVMClassifier</a> &&) noexcept</td></tr>
|
|
<tr class="memdesc:ae2eafdc66d1907c145efffd186dfff3f"><td class="mdescLeft"> </td><td class="mdescRight">Move constructor. <br /></td></tr>
|
|
<tr class="separator:ae2eafdc66d1907c145efffd186dfff3f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a49b6a4a5ae8a8e0eaf24221482be3d6a" id="r_a49b6a4a5ae8a8e0eaf24221482be3d6a"><td class="memItemLeft" align="right" valign="top"><a id="a49b6a4a5ae8a8e0eaf24221482be3d6a" name="a49b6a4a5ae8a8e0eaf24221482be3d6a"></a>
|
|
<a class="el" href="classsvm__classifier_1_1SVMClassifier.html">SVMClassifier</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classsvm__classifier_1_1SVMClassifier.html">SVMClassifier</a> &&) noexcept</td></tr>
|
|
<tr class="memdesc:a49b6a4a5ae8a8e0eaf24221482be3d6a"><td class="mdescLeft"> </td><td class="mdescRight">Move assignment. <br /></td></tr>
|
|
<tr class="separator:a49b6a4a5ae8a8e0eaf24221482be3d6a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7e6648c4d2bac92bb00381076ea92db3" id="r_a7e6648c4d2bac92bb00381076ea92db3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structsvm__classifier_1_1TrainingMetrics.html">TrainingMetrics</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvm__classifier_1_1SVMClassifier.html#a7e6648c4d2bac92bb00381076ea92db3">fit</a> (const torch::Tensor &X, const torch::Tensor &y)</td></tr>
|
|
<tr class="memdesc:a7e6648c4d2bac92bb00381076ea92db3"><td class="mdescLeft"> </td><td class="mdescRight">Train the SVM classifier. <br /></td></tr>
|
|
<tr class="separator:a7e6648c4d2bac92bb00381076ea92db3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5c998d5574b3b6afe003b23ed02ed1d1" id="r_a5c998d5574b3b6afe003b23ed02ed1d1"><td class="memItemLeft" align="right" valign="top">torch::Tensor </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvm__classifier_1_1SVMClassifier.html#a5c998d5574b3b6afe003b23ed02ed1d1">predict</a> (const torch::Tensor &X)</td></tr>
|
|
<tr class="memdesc:a5c998d5574b3b6afe003b23ed02ed1d1"><td class="mdescLeft"> </td><td class="mdescRight">Predict class labels for samples. <br /></td></tr>
|
|
<tr class="separator:a5c998d5574b3b6afe003b23ed02ed1d1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab4ef3c839e085ece646cdd2501a51f67" id="r_ab4ef3c839e085ece646cdd2501a51f67"><td class="memItemLeft" align="right" valign="top">torch::Tensor </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvm__classifier_1_1SVMClassifier.html#ab4ef3c839e085ece646cdd2501a51f67">predict_proba</a> (const torch::Tensor &X)</td></tr>
|
|
<tr class="memdesc:ab4ef3c839e085ece646cdd2501a51f67"><td class="mdescLeft"> </td><td class="mdescRight">Predict class probabilities for samples. <br /></td></tr>
|
|
<tr class="separator:ab4ef3c839e085ece646cdd2501a51f67"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad153c0537998eae5fbca5fd0b5ead2b7" id="r_ad153c0537998eae5fbca5fd0b5ead2b7"><td class="memItemLeft" align="right" valign="top">torch::Tensor </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvm__classifier_1_1SVMClassifier.html#ad153c0537998eae5fbca5fd0b5ead2b7">decision_function</a> (const torch::Tensor &X)</td></tr>
|
|
<tr class="memdesc:ad153c0537998eae5fbca5fd0b5ead2b7"><td class="mdescLeft"> </td><td class="mdescRight">Get decision function values. <br /></td></tr>
|
|
<tr class="separator:ad153c0537998eae5fbca5fd0b5ead2b7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0479c57489c14be4a5ca79368086f7f6" id="r_a0479c57489c14be4a5ca79368086f7f6"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvm__classifier_1_1SVMClassifier.html#a0479c57489c14be4a5ca79368086f7f6">score</a> (const torch::Tensor &X, const torch::Tensor &y_true)</td></tr>
|
|
<tr class="memdesc:a0479c57489c14be4a5ca79368086f7f6"><td class="mdescLeft"> </td><td class="mdescRight">Calculate accuracy score on test data. <br /></td></tr>
|
|
<tr class="separator:a0479c57489c14be4a5ca79368086f7f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a38a9b020b9f4f9254920c97a3a047e9b" id="r_a38a9b020b9f4f9254920c97a3a047e9b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structsvm__classifier_1_1EvaluationMetrics.html">EvaluationMetrics</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvm__classifier_1_1SVMClassifier.html#a38a9b020b9f4f9254920c97a3a047e9b">evaluate</a> (const torch::Tensor &X, const torch::Tensor &y_true)</td></tr>
|
|
<tr class="memdesc:a38a9b020b9f4f9254920c97a3a047e9b"><td class="mdescLeft"> </td><td class="mdescRight">Calculate detailed evaluation metrics. <br /></td></tr>
|
|
<tr class="separator:a38a9b020b9f4f9254920c97a3a047e9b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adb01e761fea07c709f3a0e315d3d0e06" id="r_adb01e761fea07c709f3a0e315d3d0e06"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvm__classifier_1_1SVMClassifier.html#adb01e761fea07c709f3a0e315d3d0e06">set_parameters</a> (const nlohmann::json &config)</td></tr>
|
|
<tr class="memdesc:adb01e761fea07c709f3a0e315d3d0e06"><td class="mdescLeft"> </td><td class="mdescRight">Set parameters from JSON configuration. <br /></td></tr>
|
|
<tr class="separator:adb01e761fea07c709f3a0e315d3d0e06"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7c39ec09b15186dcb4f04ae7171d23bb" id="r_a7c39ec09b15186dcb4f04ae7171d23bb"><td class="memItemLeft" align="right" valign="top">nlohmann::json </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvm__classifier_1_1SVMClassifier.html#a7c39ec09b15186dcb4f04ae7171d23bb">get_parameters</a> () const</td></tr>
|
|
<tr class="memdesc:a7c39ec09b15186dcb4f04ae7171d23bb"><td class="mdescLeft"> </td><td class="mdescRight">Get current parameters as JSON. <br /></td></tr>
|
|
<tr class="separator:a7c39ec09b15186dcb4f04ae7171d23bb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a71a85ab7893e7e2b40763db34096d8bb" id="r_a71a85ab7893e7e2b40763db34096d8bb"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvm__classifier_1_1SVMClassifier.html#a71a85ab7893e7e2b40763db34096d8bb">is_fitted</a> () const</td></tr>
|
|
<tr class="memdesc:a71a85ab7893e7e2b40763db34096d8bb"><td class="mdescLeft"> </td><td class="mdescRight">Check if the model is fitted/trained. <br /></td></tr>
|
|
<tr class="separator:a71a85ab7893e7e2b40763db34096d8bb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a75d501339e2e2273082b0838e9caadcd" id="r_a75d501339e2e2273082b0838e9caadcd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvm__classifier_1_1SVMClassifier.html#a75d501339e2e2273082b0838e9caadcd">get_n_classes</a> () const</td></tr>
|
|
<tr class="memdesc:a75d501339e2e2273082b0838e9caadcd"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of classes. <br /></td></tr>
|
|
<tr class="separator:a75d501339e2e2273082b0838e9caadcd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af0fea42cdfc9416ed854b0d4aefa82b9" id="r_af0fea42cdfc9416ed854b0d4aefa82b9"><td class="memItemLeft" align="right" valign="top">std::vector< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvm__classifier_1_1SVMClassifier.html#af0fea42cdfc9416ed854b0d4aefa82b9">get_classes</a> () const</td></tr>
|
|
<tr class="memdesc:af0fea42cdfc9416ed854b0d4aefa82b9"><td class="mdescLeft"> </td><td class="mdescRight">Get unique class labels. <br /></td></tr>
|
|
<tr class="separator:af0fea42cdfc9416ed854b0d4aefa82b9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a780afcb2ad618e46541aff8a44e9c7b4" id="r_a780afcb2ad618e46541aff8a44e9c7b4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvm__classifier_1_1SVMClassifier.html#a780afcb2ad618e46541aff8a44e9c7b4">get_n_features</a> () const</td></tr>
|
|
<tr class="memdesc:a780afcb2ad618e46541aff8a44e9c7b4"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of features. <br /></td></tr>
|
|
<tr class="separator:a780afcb2ad618e46541aff8a44e9c7b4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0b8c77f81d84489b2da0d080773a2970" id="r_a0b8c77f81d84489b2da0d080773a2970"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structsvm__classifier_1_1TrainingMetrics.html">TrainingMetrics</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvm__classifier_1_1SVMClassifier.html#a0b8c77f81d84489b2da0d080773a2970">get_training_metrics</a> () const</td></tr>
|
|
<tr class="memdesc:a0b8c77f81d84489b2da0d080773a2970"><td class="mdescLeft"> </td><td class="mdescRight">Get training metrics from last fit. <br /></td></tr>
|
|
<tr class="separator:a0b8c77f81d84489b2da0d080773a2970"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3f8b4e932f075b267507ad77a499a135" id="r_a3f8b4e932f075b267507ad77a499a135"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvm__classifier_1_1SVMClassifier.html#a3f8b4e932f075b267507ad77a499a135">supports_probability</a> () const</td></tr>
|
|
<tr class="memdesc:a3f8b4e932f075b267507ad77a499a135"><td class="mdescLeft"> </td><td class="mdescRight">Check if the current model supports probability prediction. <br /></td></tr>
|
|
<tr class="separator:a3f8b4e932f075b267507ad77a499a135"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab8a0bd35705825e80a7567b576d47359" id="r_ab8a0bd35705825e80a7567b576d47359"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvm__classifier_1_1SVMClassifier.html#ab8a0bd35705825e80a7567b576d47359">save_model</a> (const std::string &filename) const</td></tr>
|
|
<tr class="memdesc:ab8a0bd35705825e80a7567b576d47359"><td class="mdescLeft"> </td><td class="mdescRight">Save model to file. <br /></td></tr>
|
|
<tr class="separator:ab8a0bd35705825e80a7567b576d47359"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a583f5743acf5e6b850e079b9190989f1" id="r_a583f5743acf5e6b850e079b9190989f1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvm__classifier_1_1SVMClassifier.html#a583f5743acf5e6b850e079b9190989f1">load_model</a> (const std::string &filename)</td></tr>
|
|
<tr class="memdesc:a583f5743acf5e6b850e079b9190989f1"><td class="mdescLeft"> </td><td class="mdescRight">Load model from file. <br /></td></tr>
|
|
<tr class="separator:a583f5743acf5e6b850e079b9190989f1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a55338ab396bd5da923b6acbef8ed783a" id="r_a55338ab396bd5da923b6acbef8ed783a"><td class="memItemLeft" align="right" valign="top">KernelType </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvm__classifier_1_1SVMClassifier.html#a55338ab396bd5da923b6acbef8ed783a">get_kernel_type</a> () const</td></tr>
|
|
<tr class="memdesc:a55338ab396bd5da923b6acbef8ed783a"><td class="mdescLeft"> </td><td class="mdescRight">Get kernel type. <br /></td></tr>
|
|
<tr class="separator:a55338ab396bd5da923b6acbef8ed783a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a14c2f7917c8a91154c09160288509f2c" id="r_a14c2f7917c8a91154c09160288509f2c"><td class="memItemLeft" align="right" valign="top">MulticlassStrategy </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvm__classifier_1_1SVMClassifier.html#a14c2f7917c8a91154c09160288509f2c">get_multiclass_strategy</a> () const</td></tr>
|
|
<tr class="memdesc:a14c2f7917c8a91154c09160288509f2c"><td class="mdescLeft"> </td><td class="mdescRight">Get multiclass strategy. <br /></td></tr>
|
|
<tr class="separator:a14c2f7917c8a91154c09160288509f2c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a38173e5cf0f6a4620f032fd54c28d592" id="r_a38173e5cf0f6a4620f032fd54c28d592"><td class="memItemLeft" align="right" valign="top">SVMLibrary </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvm__classifier_1_1SVMClassifier.html#a38173e5cf0f6a4620f032fd54c28d592">get_svm_library</a> () const</td></tr>
|
|
<tr class="memdesc:a38173e5cf0f6a4620f032fd54c28d592"><td class="mdescLeft"> </td><td class="mdescRight">Get SVM library being used. <br /></td></tr>
|
|
<tr class="separator:a38173e5cf0f6a4620f032fd54c28d592"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4c91072ea0d3d9b97ba458ff7d0898b8" id="r_a4c91072ea0d3d9b97ba458ff7d0898b8"><td class="memItemLeft" align="right" valign="top">std::vector< double > </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvm__classifier_1_1SVMClassifier.html#a4c91072ea0d3d9b97ba458ff7d0898b8">cross_validate</a> (const torch::Tensor &X, const torch::Tensor &y, int cv=5)</td></tr>
|
|
<tr class="memdesc:a4c91072ea0d3d9b97ba458ff7d0898b8"><td class="mdescLeft"> </td><td class="mdescRight">Perform cross-validation. <br /></td></tr>
|
|
<tr class="separator:a4c91072ea0d3d9b97ba458ff7d0898b8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afed66a704dfb38cc7d080d3337d10194" id="r_afed66a704dfb38cc7d080d3337d10194"><td class="memItemLeft" align="right" valign="top">nlohmann::json </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvm__classifier_1_1SVMClassifier.html#afed66a704dfb38cc7d080d3337d10194">grid_search</a> (const torch::Tensor &X, const torch::Tensor &y, const nlohmann::json &param_grid, int cv=5)</td></tr>
|
|
<tr class="memdesc:afed66a704dfb38cc7d080d3337d10194"><td class="mdescLeft"> </td><td class="mdescRight">Find optimal hyperparameters using grid search. <br /></td></tr>
|
|
<tr class="separator:afed66a704dfb38cc7d080d3337d10194"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2ade33562381e34cbe4b04089545a715" id="r_a2ade33562381e34cbe4b04089545a715"><td class="memItemLeft" align="right" valign="top">torch::Tensor </td><td class="memItemRight" valign="bottom"><a class="el" href="classsvm__classifier_1_1SVMClassifier.html#a2ade33562381e34cbe4b04089545a715">get_feature_importance</a> () const</td></tr>
|
|
<tr class="memdesc:a2ade33562381e34cbe4b04089545a715"><td class="mdescLeft"> </td><td class="mdescRight">Get feature importance (for linear kernels only) <br /></td></tr>
|
|
<tr class="separator:a2ade33562381e34cbe4b04089545a715"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa2bd5715c9e54e3fb465a9bcbf2e9c8a" id="r_aa2bd5715c9e54e3fb465a9bcbf2e9c8a"><td class="memItemLeft" align="right" valign="top"><a id="aa2bd5715c9e54e3fb465a9bcbf2e9c8a" name="aa2bd5715c9e54e3fb465a9bcbf2e9c8a"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>reset</b> ()</td></tr>
|
|
<tr class="memdesc:aa2bd5715c9e54e3fb465a9bcbf2e9c8a"><td class="mdescLeft"> </td><td class="mdescRight">Reset the classifier (clear trained model) <br /></td></tr>
|
|
<tr class="separator:aa2bd5715c9e54e3fb465a9bcbf2e9c8a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Support Vector Machine Classifier with scikit-learn compatible API. </p>
|
|
<p>This class provides a unified interface for SVM classification using both liblinear (for linear kernels) and libsvm (for non-linear kernels). It supports multiclass classification through One-vs-Rest and One-vs-One strategies. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="svm__classifier_8hpp_source.html#l00021">21</a> of file <a class="el" href="svm__classifier_8hpp_source.html">svm_classifier.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a2afb41f77de4e8de6368d274a30191ec" name="a2afb41f77de4e8de6368d274a30191ec"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2afb41f77de4e8de6368d274a30191ec">◆ </a></span>SVMClassifier() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">svm_classifier::SVMClassifier::SVMClassifier </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const nlohmann::json & </td>
|
|
<td class="paramname"><em>config</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructor with JSON parameters. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>JSON configuration object </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a90b2f18dd2cfeb23cf1375f265e22db0" name="a90b2f18dd2cfeb23cf1375f265e22db0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a90b2f18dd2cfeb23cf1375f265e22db0">◆ </a></span>SVMClassifier() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">svm_classifier::SVMClassifier::SVMClassifier </td>
|
|
<td>(</td>
|
|
<td class="paramtype">KernelType </td>
|
|
<td class="paramname"><em>kernel</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>C</em> = <code>1.0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">MulticlassStrategy </td>
|
|
<td class="paramname"><em>multiclass_strategy</em> = <code>MulticlassStrategy::ONE_VS_REST</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructor with explicit parameters. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">kernel</td><td>Kernel type </td></tr>
|
|
<tr><td class="paramname">C</td><td>Regularization parameter </td></tr>
|
|
<tr><td class="paramname">multiclass_strategy</td><td>Multiclass strategy </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a4c91072ea0d3d9b97ba458ff7d0898b8" name="a4c91072ea0d3d9b97ba458ff7d0898b8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4c91072ea0d3d9b97ba458ff7d0898b8">◆ </a></span>cross_validate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::vector< double > svm_classifier::SVMClassifier::cross_validate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const torch::Tensor & </td>
|
|
<td class="paramname"><em>X</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const torch::Tensor & </td>
|
|
<td class="paramname"><em>y</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>cv</em> = <code>5</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Perform cross-validation. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">X</td><td>Feature tensor </td></tr>
|
|
<tr><td class="paramname">y</td><td>Target tensor </td></tr>
|
|
<tr><td class="paramname">cv</td><td>Number of folds (default: 5) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Cross-validation scores for each fold </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad153c0537998eae5fbca5fd0b5ead2b7" name="ad153c0537998eae5fbca5fd0b5ead2b7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad153c0537998eae5fbca5fd0b5ead2b7">◆ </a></span>decision_function()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">torch::Tensor svm_classifier::SVMClassifier::decision_function </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const torch::Tensor & </td>
|
|
<td class="paramname"><em>X</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get decision function values. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">X</td><td>Feature tensor of shape (n_samples, n_features) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Tensor with decision function values </dd></dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::runtime_error</td><td>if model is not fitted </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a38a9b020b9f4f9254920c97a3a047e9b" name="a38a9b020b9f4f9254920c97a3a047e9b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a38a9b020b9f4f9254920c97a3a047e9b">◆ </a></span>evaluate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structsvm__classifier_1_1EvaluationMetrics.html">EvaluationMetrics</a> svm_classifier::SVMClassifier::evaluate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const torch::Tensor & </td>
|
|
<td class="paramname"><em>X</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const torch::Tensor & </td>
|
|
<td class="paramname"><em>y_true</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Calculate detailed evaluation metrics. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">X</td><td>Feature tensor of shape (n_samples, n_features) </td></tr>
|
|
<tr><td class="paramname">y_true</td><td>True labels tensor of shape (n_samples,) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Evaluation metrics including precision, recall, F1-score </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7e6648c4d2bac92bb00381076ea92db3" name="a7e6648c4d2bac92bb00381076ea92db3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7e6648c4d2bac92bb00381076ea92db3">◆ </a></span>fit()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structsvm__classifier_1_1TrainingMetrics.html">TrainingMetrics</a> svm_classifier::SVMClassifier::fit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const torch::Tensor & </td>
|
|
<td class="paramname"><em>X</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const torch::Tensor & </td>
|
|
<td class="paramname"><em>y</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Train the SVM classifier. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">X</td><td>Feature tensor of shape (n_samples, n_features) </td></tr>
|
|
<tr><td class="paramname">y</td><td>Target tensor of shape (n_samples,) with class labels </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Training metrics </dd></dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::invalid_argument</td><td>if input data is invalid </td></tr>
|
|
<tr><td class="paramname">std::runtime_error</td><td>if training fails </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af0fea42cdfc9416ed854b0d4aefa82b9" name="af0fea42cdfc9416ed854b0d4aefa82b9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af0fea42cdfc9416ed854b0d4aefa82b9">◆ </a></span>get_classes()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::vector< int > svm_classifier::SVMClassifier::get_classes </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get unique class labels. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Vector of unique class labels </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2ade33562381e34cbe4b04089545a715" name="a2ade33562381e34cbe4b04089545a715"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2ade33562381e34cbe4b04089545a715">◆ </a></span>get_feature_importance()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">torch::Tensor svm_classifier::SVMClassifier::get_feature_importance </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get feature importance (for linear kernels only) </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Tensor with feature weights/importance </dd></dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::runtime_error</td><td>if not supported for current kernel </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a55338ab396bd5da923b6acbef8ed783a" name="a55338ab396bd5da923b6acbef8ed783a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a55338ab396bd5da923b6acbef8ed783a">◆ </a></span>get_kernel_type()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">KernelType svm_classifier::SVMClassifier::get_kernel_type </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get kernel type. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Current kernel type </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="svm__classifier_8hpp_source.html#l00187">187</a> of file <a class="el" href="svm__classifier_8hpp_source.html">svm_classifier.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a14c2f7917c8a91154c09160288509f2c" name="a14c2f7917c8a91154c09160288509f2c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a14c2f7917c8a91154c09160288509f2c">◆ </a></span>get_multiclass_strategy()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">MulticlassStrategy svm_classifier::SVMClassifier::get_multiclass_strategy </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get multiclass strategy. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Current multiclass strategy </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="svm__classifier_8hpp_source.html#l00193">193</a> of file <a class="el" href="svm__classifier_8hpp_source.html">svm_classifier.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a75d501339e2e2273082b0838e9caadcd" name="a75d501339e2e2273082b0838e9caadcd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a75d501339e2e2273082b0838e9caadcd">◆ </a></span>get_n_classes()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int svm_classifier::SVMClassifier::get_n_classes </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the number of classes. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of classes (0 if not fitted) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a780afcb2ad618e46541aff8a44e9c7b4" name="a780afcb2ad618e46541aff8a44e9c7b4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a780afcb2ad618e46541aff8a44e9c7b4">◆ </a></span>get_n_features()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int svm_classifier::SVMClassifier::get_n_features </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the number of features. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of features (0 if not fitted) </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="svm__classifier_8hpp_source.html#l00155">155</a> of file <a class="el" href="svm__classifier_8hpp_source.html">svm_classifier.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7c39ec09b15186dcb4f04ae7171d23bb" name="a7c39ec09b15186dcb4f04ae7171d23bb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7c39ec09b15186dcb4f04ae7171d23bb">◆ </a></span>get_parameters()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">nlohmann::json svm_classifier::SVMClassifier::get_parameters </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get current parameters as JSON. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>JSON object with current parameters </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a38173e5cf0f6a4620f032fd54c28d592" name="a38173e5cf0f6a4620f032fd54c28d592"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a38173e5cf0f6a4620f032fd54c28d592">◆ </a></span>get_svm_library()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">SVMLibrary svm_classifier::SVMClassifier::get_svm_library </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get SVM library being used. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>SVM library type </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="svm__classifier_8hpp_source.html#l00199">199</a> of file <a class="el" href="svm__classifier_8hpp_source.html">svm_classifier.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0b8c77f81d84489b2da0d080773a2970" name="a0b8c77f81d84489b2da0d080773a2970"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0b8c77f81d84489b2da0d080773a2970">◆ </a></span>get_training_metrics()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structsvm__classifier_1_1TrainingMetrics.html">TrainingMetrics</a> svm_classifier::SVMClassifier::get_training_metrics </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get training metrics from last fit. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Training metrics </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="svm__classifier_8hpp_source.html#l00161">161</a> of file <a class="el" href="svm__classifier_8hpp_source.html">svm_classifier.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afed66a704dfb38cc7d080d3337d10194" name="afed66a704dfb38cc7d080d3337d10194"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afed66a704dfb38cc7d080d3337d10194">◆ </a></span>grid_search()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">nlohmann::json svm_classifier::SVMClassifier::grid_search </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const torch::Tensor & </td>
|
|
<td class="paramname"><em>X</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const torch::Tensor & </td>
|
|
<td class="paramname"><em>y</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const nlohmann::json & </td>
|
|
<td class="paramname"><em>param_grid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>cv</em> = <code>5</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Find optimal hyperparameters using grid search. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">X</td><td>Feature tensor </td></tr>
|
|
<tr><td class="paramname">y</td><td>Target tensor </td></tr>
|
|
<tr><td class="paramname">param_grid</td><td>JSON object with parameter grid </td></tr>
|
|
<tr><td class="paramname">cv</td><td>Number of cross-validation folds </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>JSON object with best parameters and score </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a71a85ab7893e7e2b40763db34096d8bb" name="a71a85ab7893e7e2b40763db34096d8bb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a71a85ab7893e7e2b40763db34096d8bb">◆ </a></span>is_fitted()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool svm_classifier::SVMClassifier::is_fitted </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check if the model is fitted/trained. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if model is fitted </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="svm__classifier_8hpp_source.html#l00137">137</a> of file <a class="el" href="svm__classifier_8hpp_source.html">svm_classifier.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a583f5743acf5e6b850e079b9190989f1" name="a583f5743acf5e6b850e079b9190989f1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a583f5743acf5e6b850e079b9190989f1">◆ </a></span>load_model()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void svm_classifier::SVMClassifier::load_model </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>filename</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Load model from file. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">filename</td><td>Path to load the model from </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::runtime_error</td><td>if loading fails </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5c998d5574b3b6afe003b23ed02ed1d1" name="a5c998d5574b3b6afe003b23ed02ed1d1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5c998d5574b3b6afe003b23ed02ed1d1">◆ </a></span>predict()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">torch::Tensor svm_classifier::SVMClassifier::predict </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const torch::Tensor & </td>
|
|
<td class="paramname"><em>X</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Predict class labels for samples. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">X</td><td>Feature tensor of shape (n_samples, n_features) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Tensor of predicted class labels </dd></dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::runtime_error</td><td>if model is not fitted </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab4ef3c839e085ece646cdd2501a51f67" name="ab4ef3c839e085ece646cdd2501a51f67"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab4ef3c839e085ece646cdd2501a51f67">◆ </a></span>predict_proba()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">torch::Tensor svm_classifier::SVMClassifier::predict_proba </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const torch::Tensor & </td>
|
|
<td class="paramname"><em>X</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Predict class probabilities for samples. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">X</td><td>Feature tensor of shape (n_samples, n_features) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Tensor of shape (n_samples, n_classes) with class probabilities </dd></dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::runtime_error</td><td>if model is not fitted or doesn't support probabilities </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab8a0bd35705825e80a7567b576d47359" name="ab8a0bd35705825e80a7567b576d47359"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab8a0bd35705825e80a7567b576d47359">◆ </a></span>save_model()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void svm_classifier::SVMClassifier::save_model </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>filename</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Save model to file. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">filename</td><td>Path to save the model </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::runtime_error</td><td>if saving fails </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0479c57489c14be4a5ca79368086f7f6" name="a0479c57489c14be4a5ca79368086f7f6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0479c57489c14be4a5ca79368086f7f6">◆ </a></span>score()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double svm_classifier::SVMClassifier::score </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const torch::Tensor & </td>
|
|
<td class="paramname"><em>X</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const torch::Tensor & </td>
|
|
<td class="paramname"><em>y_true</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Calculate accuracy score on test data. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">X</td><td>Feature tensor of shape (n_samples, n_features) </td></tr>
|
|
<tr><td class="paramname">y_true</td><td>True labels tensor of shape (n_samples,) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Accuracy score (fraction of correctly predicted samples) </dd></dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::runtime_error</td><td>if model is not fitted </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adb01e761fea07c709f3a0e315d3d0e06" name="adb01e761fea07c709f3a0e315d3d0e06"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adb01e761fea07c709f3a0e315d3d0e06">◆ </a></span>set_parameters()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void svm_classifier::SVMClassifier::set_parameters </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const nlohmann::json & </td>
|
|
<td class="paramname"><em>config</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set parameters from JSON configuration. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">config</td><td>JSON configuration object </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::invalid_argument</td><td>if parameters are invalid </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3f8b4e932f075b267507ad77a499a135" name="a3f8b4e932f075b267507ad77a499a135"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3f8b4e932f075b267507ad77a499a135">◆ </a></span>supports_probability()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool svm_classifier::SVMClassifier::supports_probability </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check if the current model supports probability prediction. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if probabilities are supported </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>include/svm_classifier/<a class="el" href="svm__classifier_8hpp_source.html">svm_classifier.hpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Sun Jun 22 2025 11:25:27 for SVM Classifier C++ by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
|
|
</small></address>
|
|
</body>
|
|
</html>
|