rmontanana/BayesNet
1
0
Fork 0
Code Issues 2 Pull Requests 1 Actions Packages Projects Releases 6 Wiki Activity

Add Doxygen to generate man and manual pages

Browse Source
This commit is contained in:
Ricardo Montañana Gómez
2024-05-21 23:38:10 +02:00
parent 0341bd5648
commit a2853dd2e5
303 changed files with 35356 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

257
docs/man3/bayesnet_A2DE.3 Normal file
View File

@@ -0,0 +1,257 @@
.TH "bayesnet::A2DE" 3 "Version 1.0.5" "BayesNet" \" -*- nroff -*-
.ad l
.nh
.SH NAME
bayesnet::A2DE
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBbayesnet::Ensemble\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBA2DE\fP (bool predict_voting=false)"
.br
.ti -1c
.RI "void \fBsetHyperparameters\fP (const nlohmann::json &hyperparameters) override"
.br
.ti -1c
.RI "std::vector< std::string > \fBgraph\fP (const std::string &title='A2DE') const override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::Ensemble\fP
.in +1c
.ti -1c
.RI "\fBEnsemble\fP (bool predict_voting=true)"
.br
.ti -1c
.RI "torch::Tensor \fBpredict\fP (torch::Tensor &X) override"
.br
.ti -1c
.RI "std::vector< int > \fBpredict\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "torch::Tensor \fBpredict_proba\fP (torch::Tensor &X) override"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_proba\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "float \fBscore\fP (torch::Tensor &X, torch::Tensor &y) override"
.br
.ti -1c
.RI "float \fBscore\fP (std::vector< std::vector< int > > &X, std::vector< int > &y) override"
.br
.ti -1c
.RI "int \fBgetNumberOfNodes\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfEdges\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfStates\fP () const override"
.br
.ti -1c
.RI "std::vector< std::string > \fBshow\fP () const override"
.br
.ti -1c
.RI "std::vector< std::string > \fBgraph\fP (const std::string &title) const override"
.br
.ti -1c
.RI "std::vector< std::string > \fBtopological_order\fP () override"
.br
.ti -1c
.RI "std::string \fBdump_cpt\fP () const override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "\fBClassifier\fP (\fBNetwork\fP model)"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (std::vector< std::vector< int > > &X, std::vector< int > &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &X, torch::Tensor &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states, const torch::Tensor &weights) override"
.br
.ti -1c
.RI "void \fBaddNodes\fP ()"
.br
.ti -1c
.RI "int \fBgetClassNumStates\fP () const override"
.br
.ti -1c
.RI "status_t \fBgetStatus\fP () const override"
.br
.ti -1c
.RI "std::string \fBgetVersion\fP () override"
.br
.ti -1c
.RI "std::vector< std::string > \fBgetNotes\fP () const override"
.br
.ti -1c
.RI "void \fBsetHyperparameters\fP (const nlohmann::json &hyperparameters) override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "std::vector< std::string > & \fBgetValidHyperparameters\fP ()"
.br
.in -1c
.SS "Protected Member Functions"
.in +1c
.ti -1c
.RI "void \fBbuildModel\fP (const torch::Tensor &weights) override"
.br
.in -1c
Protected Member Functions inherited from \fBbayesnet::Ensemble\fP
.in +1c
.ti -1c
.RI "torch::Tensor \fBpredict_average_voting\fP (torch::Tensor &X)"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_average_voting\fP (std::vector< std::vector< int > > &X)"
.br
.ti -1c
.RI "torch::Tensor \fBpredict_average_proba\fP (torch::Tensor &X)"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_average_proba\fP (std::vector< std::vector< int > > &X)"
.br
.ti -1c
.RI "torch::Tensor \fBcompute_arg_max\fP (torch::Tensor &X)"
.br
.ti -1c
.RI "std::vector< int > \fBcompute_arg_max\fP (std::vector< std::vector< double > > &X)"
.br
.ti -1c
.RI "torch::Tensor \fBvoting\fP (torch::Tensor &votes)"
.br
.ti -1c
.RI "void \fBtrainModel\fP (const torch::Tensor &weights) override"
.br
.in -1c
Protected Member Functions inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "void \fBcheckFitParameters\fP ()"
.br
.ti -1c
.RI "void \fBbuildDataset\fP (torch::Tensor &y)"
.br
.in -1c
.SS "Additional Inherited Members"
Protected Attributes inherited from \fBbayesnet::Ensemble\fP
.in +1c
.ti -1c
.RI "unsigned \fBn_models\fP"
.br
.ti -1c
.RI "std::vector< std::unique_ptr< \fBClassifier\fP > > \fBmodels\fP"
.br
.ti -1c
.RI "std::vector< double > \fBsignificanceModels\fP"
.br
.ti -1c
.RI "bool \fBpredict_voting\fP"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "bool \fBfitted\fP"
.br
.ti -1c
.RI "unsigned int \fBm\fP"
.br
.ti -1c
.RI "unsigned int \fBn\fP"
.br
.ti -1c
.RI "\fBNetwork\fP \fBmodel\fP"
.br
.ti -1c
.RI "Metrics \fBmetrics\fP"
.br
.ti -1c
.RI "std::vector< std::string > \fBfeatures\fP"
.br
.ti -1c
.RI "std::string \fBclassName\fP"
.br
.ti -1c
.RI "std::map< std::string, std::vector< int > > \fBstates\fP"
.br
.ti -1c
.RI "torch::Tensor \fBdataset\fP"
.br
.ti -1c
.RI "status_t \fBstatus\fP = NORMAL"
.br
.ti -1c
.RI "std::vector< std::string > \fBnotes\fP"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "std::vector< std::string > \fBvalidHyperparameters\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
Definition at line \fB12\fP of file \fBA2DE\&.h\fP\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "bayesnet::A2DE::A2DE (bool predict_voting = \fRfalse\fP)"
.PP
Definition at line \fB10\fP of file \fBA2DE\&.cc\fP\&.
.SS "virtual bayesnet::A2DE::~A2DE ()\fR [inline]\fP, \fR [virtual]\fP"
.PP
Definition at line \fB15\fP of file \fBA2DE\&.h\fP\&.
.SH "Member Function Documentation"
.PP
.SS "void bayesnet::A2DE::buildModel (const torch::Tensor & weights)\fR [override]\fP, \fR [protected]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::Classifier\fP\&.
.PP
Definition at line \fB23\fP of file \fBA2DE\&.cc\fP\&.
.SS "std::vector< std::string > bayesnet::A2DE::graph (const std::string & title = \fR'A2DE'\fP) const\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB36\fP of file \fBA2DE\&.cc\fP\&.
.SS "void bayesnet::A2DE::setHyperparameters (const nlohmann::json & hyperparameters)\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB14\fP of file \fBA2DE\&.cc\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for BayesNet from the source code\&.

257
docs/man3/bayesnet_AODE.3 Normal file
View File

@@ -0,0 +1,257 @@
.TH "bayesnet::AODE" 3 "Version 1.0.5" "BayesNet" \" -*- nroff -*-
.ad l
.nh
.SH NAME
bayesnet::AODE
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBbayesnet::Ensemble\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBAODE\fP (bool predict_voting=false)"
.br
.ti -1c
.RI "void \fBsetHyperparameters\fP (const nlohmann::json &hyperparameters) override"
.br
.ti -1c
.RI "std::vector< std::string > \fBgraph\fP (const std::string &title='AODE') const override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::Ensemble\fP
.in +1c
.ti -1c
.RI "\fBEnsemble\fP (bool predict_voting=true)"
.br
.ti -1c
.RI "torch::Tensor \fBpredict\fP (torch::Tensor &X) override"
.br
.ti -1c
.RI "std::vector< int > \fBpredict\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "torch::Tensor \fBpredict_proba\fP (torch::Tensor &X) override"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_proba\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "float \fBscore\fP (torch::Tensor &X, torch::Tensor &y) override"
.br
.ti -1c
.RI "float \fBscore\fP (std::vector< std::vector< int > > &X, std::vector< int > &y) override"
.br
.ti -1c
.RI "int \fBgetNumberOfNodes\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfEdges\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfStates\fP () const override"
.br
.ti -1c
.RI "std::vector< std::string > \fBshow\fP () const override"
.br
.ti -1c
.RI "std::vector< std::string > \fBgraph\fP (const std::string &title) const override"
.br
.ti -1c
.RI "std::vector< std::string > \fBtopological_order\fP () override"
.br
.ti -1c
.RI "std::string \fBdump_cpt\fP () const override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "\fBClassifier\fP (\fBNetwork\fP model)"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (std::vector< std::vector< int > > &X, std::vector< int > &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &X, torch::Tensor &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states, const torch::Tensor &weights) override"
.br
.ti -1c
.RI "void \fBaddNodes\fP ()"
.br
.ti -1c
.RI "int \fBgetClassNumStates\fP () const override"
.br
.ti -1c
.RI "status_t \fBgetStatus\fP () const override"
.br
.ti -1c
.RI "std::string \fBgetVersion\fP () override"
.br
.ti -1c
.RI "std::vector< std::string > \fBgetNotes\fP () const override"
.br
.ti -1c
.RI "void \fBsetHyperparameters\fP (const nlohmann::json &hyperparameters) override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "std::vector< std::string > & \fBgetValidHyperparameters\fP ()"
.br
.in -1c
.SS "Protected Member Functions"
.in +1c
.ti -1c
.RI "void \fBbuildModel\fP (const torch::Tensor &weights) override"
.br
.in -1c
Protected Member Functions inherited from \fBbayesnet::Ensemble\fP
.in +1c
.ti -1c
.RI "torch::Tensor \fBpredict_average_voting\fP (torch::Tensor &X)"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_average_voting\fP (std::vector< std::vector< int > > &X)"
.br
.ti -1c
.RI "torch::Tensor \fBpredict_average_proba\fP (torch::Tensor &X)"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_average_proba\fP (std::vector< std::vector< int > > &X)"
.br
.ti -1c
.RI "torch::Tensor \fBcompute_arg_max\fP (torch::Tensor &X)"
.br
.ti -1c
.RI "std::vector< int > \fBcompute_arg_max\fP (std::vector< std::vector< double > > &X)"
.br
.ti -1c
.RI "torch::Tensor \fBvoting\fP (torch::Tensor &votes)"
.br
.ti -1c
.RI "void \fBtrainModel\fP (const torch::Tensor &weights) override"
.br
.in -1c
Protected Member Functions inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "void \fBcheckFitParameters\fP ()"
.br
.ti -1c
.RI "void \fBbuildDataset\fP (torch::Tensor &y)"
.br
.in -1c
.SS "Additional Inherited Members"
Protected Attributes inherited from \fBbayesnet::Ensemble\fP
.in +1c
.ti -1c
.RI "unsigned \fBn_models\fP"
.br
.ti -1c
.RI "std::vector< std::unique_ptr< \fBClassifier\fP > > \fBmodels\fP"
.br
.ti -1c
.RI "std::vector< double > \fBsignificanceModels\fP"
.br
.ti -1c
.RI "bool \fBpredict_voting\fP"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "bool \fBfitted\fP"
.br
.ti -1c
.RI "unsigned int \fBm\fP"
.br
.ti -1c
.RI "unsigned int \fBn\fP"
.br
.ti -1c
.RI "\fBNetwork\fP \fBmodel\fP"
.br
.ti -1c
.RI "Metrics \fBmetrics\fP"
.br
.ti -1c
.RI "std::vector< std::string > \fBfeatures\fP"
.br
.ti -1c
.RI "std::string \fBclassName\fP"
.br
.ti -1c
.RI "std::map< std::string, std::vector< int > > \fBstates\fP"
.br
.ti -1c
.RI "torch::Tensor \fBdataset\fP"
.br
.ti -1c
.RI "status_t \fBstatus\fP = NORMAL"
.br
.ti -1c
.RI "std::vector< std::string > \fBnotes\fP"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "std::vector< std::string > \fBvalidHyperparameters\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
Definition at line \fB12\fP of file \fBAODE\&.h\fP\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "bayesnet::AODE::AODE (bool predict_voting = \fRfalse\fP)"
.PP
Definition at line \fB10\fP of file \fBAODE\&.cc\fP\&.
.SS "virtual bayesnet::AODE::~AODE ()\fR [inline]\fP, \fR [virtual]\fP"
.PP
Definition at line \fB15\fP of file \fBAODE\&.h\fP\&.
.SH "Member Function Documentation"
.PP
.SS "void bayesnet::AODE::buildModel (const torch::Tensor & weights)\fR [override]\fP, \fR [protected]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::Classifier\fP\&.
.PP
Definition at line \fB24\fP of file \fBAODE\&.cc\fP\&.
.SS "std::vector< std::string > bayesnet::AODE::graph (const std::string & title = \fR'AODE'\fP) const\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB34\fP of file \fBAODE\&.cc\fP\&.
.SS "void bayesnet::AODE::setHyperparameters (const nlohmann::json & hyperparameters)\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB15\fP of file \fBAODE\&.cc\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for BayesNet from the source code\&.

296
docs/man3/bayesnet_AODELd.3 Normal file
View File

@@ -0,0 +1,296 @@
.TH "bayesnet::AODELd" 3 "Version 1.0.5" "BayesNet" \" -*- nroff -*-
.ad l
.nh
.SH NAME
bayesnet::AODELd
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBbayesnet::Ensemble\fP, and \fBbayesnet::Proposal\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBAODELd\fP (bool predict_voting=true)"
.br
.ti -1c
.RI "\fBAODELd\fP & \fBfit\fP (torch::Tensor &X_, torch::Tensor &y_, const std::vector< std::string > &features_, const std::string &className_, map< std::string, std::vector< int > > &states_) override"
.br
.ti -1c
.RI "std::vector< std::string > \fBgraph\fP (const std::string &name='AODELd') const override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::Ensemble\fP
.in +1c
.ti -1c
.RI "\fBEnsemble\fP (bool predict_voting=true)"
.br
.ti -1c
.RI "torch::Tensor \fBpredict\fP (torch::Tensor &X) override"
.br
.ti -1c
.RI "std::vector< int > \fBpredict\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "torch::Tensor \fBpredict_proba\fP (torch::Tensor &X) override"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_proba\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "float \fBscore\fP (torch::Tensor &X, torch::Tensor &y) override"
.br
.ti -1c
.RI "float \fBscore\fP (std::vector< std::vector< int > > &X, std::vector< int > &y) override"
.br
.ti -1c
.RI "int \fBgetNumberOfNodes\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfEdges\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfStates\fP () const override"
.br
.ti -1c
.RI "std::vector< std::string > \fBshow\fP () const override"
.br
.ti -1c
.RI "std::vector< std::string > \fBgraph\fP (const std::string &title) const override"
.br
.ti -1c
.RI "std::vector< std::string > \fBtopological_order\fP () override"
.br
.ti -1c
.RI "std::string \fBdump_cpt\fP () const override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "\fBClassifier\fP (\fBNetwork\fP model)"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (std::vector< std::vector< int > > &X, std::vector< int > &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &X, torch::Tensor &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states, const torch::Tensor &weights) override"
.br
.ti -1c
.RI "void \fBaddNodes\fP ()"
.br
.ti -1c
.RI "int \fBgetClassNumStates\fP () const override"
.br
.ti -1c
.RI "status_t \fBgetStatus\fP () const override"
.br
.ti -1c
.RI "std::string \fBgetVersion\fP () override"
.br
.ti -1c
.RI "std::vector< std::string > \fBgetNotes\fP () const override"
.br
.ti -1c
.RI "void \fBsetHyperparameters\fP (const nlohmann::json &hyperparameters) override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "std::vector< std::string > & \fBgetValidHyperparameters\fP ()"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::Proposal\fP
.in +1c
.ti -1c
.RI "\fBProposal\fP (torch::Tensor &pDataset, std::vector< std::string > &features_, std::string &className_)"
.br
.in -1c
.SS "Protected Member Functions"
.in +1c
.ti -1c
.RI "void \fBtrainModel\fP (const torch::Tensor &weights) override"
.br
.ti -1c
.RI "void \fBbuildModel\fP (const torch::Tensor &weights) override"
.br
.in -1c
Protected Member Functions inherited from \fBbayesnet::Ensemble\fP
.in +1c
.ti -1c
.RI "torch::Tensor \fBpredict_average_voting\fP (torch::Tensor &X)"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_average_voting\fP (std::vector< std::vector< int > > &X)"
.br
.ti -1c
.RI "torch::Tensor \fBpredict_average_proba\fP (torch::Tensor &X)"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_average_proba\fP (std::vector< std::vector< int > > &X)"
.br
.ti -1c
.RI "torch::Tensor \fBcompute_arg_max\fP (torch::Tensor &X)"
.br
.ti -1c
.RI "std::vector< int > \fBcompute_arg_max\fP (std::vector< std::vector< double > > &X)"
.br
.ti -1c
.RI "torch::Tensor \fBvoting\fP (torch::Tensor &votes)"
.br
.ti -1c
.RI "void \fBtrainModel\fP (const torch::Tensor &weights) override"
.br
.in -1c
Protected Member Functions inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "void \fBcheckFitParameters\fP ()"
.br
.ti -1c
.RI "void \fBbuildDataset\fP (torch::Tensor &y)"
.br
.in -1c
Protected Member Functions inherited from \fBbayesnet::Proposal\fP
.in +1c
.ti -1c
.RI "void \fBcheckInput\fP (const torch::Tensor &X, const torch::Tensor &y)"
.br
.ti -1c
.RI "torch::Tensor \fBprepareX\fP (torch::Tensor &X)"
.br
.ti -1c
.RI "map< std::string, std::vector< int > > \fBlocalDiscretizationProposal\fP (const map< std::string, std::vector< int > > &states, \fBNetwork\fP &model)"
.br
.ti -1c
.RI "map< std::string, std::vector< int > > \fBfit_local_discretization\fP (const torch::Tensor &y)"
.br
.in -1c
.SS "Additional Inherited Members"
Protected Attributes inherited from \fBbayesnet::Ensemble\fP
.in +1c
.ti -1c
.RI "unsigned \fBn_models\fP"
.br
.ti -1c
.RI "std::vector< std::unique_ptr< \fBClassifier\fP > > \fBmodels\fP"
.br
.ti -1c
.RI "std::vector< double > \fBsignificanceModels\fP"
.br
.ti -1c
.RI "bool \fBpredict_voting\fP"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "bool \fBfitted\fP"
.br
.ti -1c
.RI "unsigned int \fBm\fP"
.br
.ti -1c
.RI "unsigned int \fBn\fP"
.br
.ti -1c
.RI "\fBNetwork\fP \fBmodel\fP"
.br
.ti -1c
.RI "Metrics \fBmetrics\fP"
.br
.ti -1c
.RI "std::vector< std::string > \fBfeatures\fP"
.br
.ti -1c
.RI "std::string \fBclassName\fP"
.br
.ti -1c
.RI "std::map< std::string, std::vector< int > > \fBstates\fP"
.br
.ti -1c
.RI "torch::Tensor \fBdataset\fP"
.br
.ti -1c
.RI "status_t \fBstatus\fP = NORMAL"
.br
.ti -1c
.RI "std::vector< std::string > \fBnotes\fP"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "std::vector< std::string > \fBvalidHyperparameters\fP"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::Proposal\fP
.in +1c
.ti -1c
.RI "torch::Tensor \fBXf\fP"
.br
.ti -1c
.RI "torch::Tensor \fBy\fP"
.br
.ti -1c
.RI "map< std::string, mdlp::CPPFImdlp * > \fBdiscretizers\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
Definition at line \fB14\fP of file \fBAODELd\&.h\fP\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "bayesnet::AODELd::AODELd (bool predict_voting = \fRtrue\fP)"
.PP
Definition at line \fB10\fP of file \fBAODELd\&.cc\fP\&.
.SH "Member Function Documentation"
.PP
.SS "void bayesnet::AODELd::buildModel (const torch::Tensor & weights)\fR [override]\fP, \fR [protected]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::Classifier\fP\&.
.PP
Definition at line \fB28\fP of file \fBAODELd\&.cc\fP\&.
.SS "\fBAODELd\fP & bayesnet::AODELd::fit (torch::Tensor & X_, torch::Tensor & y_, const std::vector< std::string > & features_, const std::string & className_, map< std::string, std::vector< int > > & states_)\fR [override]\fP"
.PP
Definition at line \fB13\fP of file \fBAODELd\&.cc\fP\&.
.SS "std::vector< std::string > bayesnet::AODELd::graph (const std::string & name = \fR'AODELd'\fP) const\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB43\fP of file \fBAODELd\&.cc\fP\&.
.SS "void bayesnet::AODELd::trainModel (const torch::Tensor & weights)\fR [override]\fP, \fR [protected]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB37\fP of file \fBAODELd\&.cc\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for BayesNet from the source code\&.

116
docs/man3/bayesnet_BaseClassifier.3 Normal file
View File

@@ -0,0 +1,116 @@
.TH "bayesnet::BaseClassifier" 3 "Version 1.0.5" "BayesNet" \" -*- nroff -*-
.ad l
.nh
.SH NAME
bayesnet::BaseClassifier
.SH SYNOPSIS
.br
.PP
.PP
Inherited by \fBbayesnet::Classifier\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "virtual \fBBaseClassifier\fP & \fBfit\fP (std::vector< std::vector< int > > &X, std::vector< int > &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states)=0"
.br
.ti -1c
.RI "virtual \fBBaseClassifier\fP & \fBfit\fP (torch::Tensor &X, torch::Tensor &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states)=0"
.br
.ti -1c
.RI "virtual \fBBaseClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states)=0"
.br
.ti -1c
.RI "virtual \fBBaseClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states, const torch::Tensor &weights)=0"
.br
.ti -1c
.RI "virtual torch::Tensor \fBpredict\fP (torch::Tensor &X)=0"
.br
.ti -1c
.RI "virtual std::vector< int > \fBpredict\fP (std::vector< std::vector< int > > &X)=0"
.br
.ti -1c
.RI "virtual torch::Tensor \fBpredict_proba\fP (torch::Tensor &X)=0"
.br
.ti -1c
.RI "virtual std::vector< std::vector< double > > \fBpredict_proba\fP (std::vector< std::vector< int > > &X)=0"
.br
.ti -1c
.RI "virtual status_t \fBgetStatus\fP () const =0"
.br
.ti -1c
.RI "virtual float \fBscore\fP (std::vector< std::vector< int > > &X, std::vector< int > &y)=0"
.br
.ti -1c
.RI "virtual float \fBscore\fP (torch::Tensor &X, torch::Tensor &y)=0"
.br
.ti -1c
.RI "virtual int \fBgetNumberOfNodes\fP () const =0"
.br
.ti -1c
.RI "virtual int \fBgetNumberOfEdges\fP () const =0"
.br
.ti -1c
.RI "virtual int \fBgetNumberOfStates\fP () const =0"
.br
.ti -1c
.RI "virtual int \fBgetClassNumStates\fP () const =0"
.br
.ti -1c
.RI "virtual std::vector< std::string > \fBshow\fP () const =0"
.br
.ti -1c
.RI "virtual std::vector< std::string > \fBgraph\fP (const std::string &title='') const =0"
.br
.ti -1c
.RI "virtual std::string \fBgetVersion\fP ()=0"
.br
.ti -1c
.RI "virtual std::vector< std::string > \fBtopological_order\fP ()=0"
.br
.ti -1c
.RI "virtual std::vector< std::string > \fBgetNotes\fP () const =0"
.br
.ti -1c
.RI "virtual std::string \fBdump_cpt\fP () const =0"
.br
.ti -1c
.RI "virtual void \fBsetHyperparameters\fP (const nlohmann::json &hyperparameters)=0"
.br
.ti -1c
.RI "std::vector< std::string > & \fBgetValidHyperparameters\fP ()"
.br
.in -1c
.SS "Protected Member Functions"
.in +1c
.ti -1c
.RI "virtual void \fBtrainModel\fP (const torch::Tensor &weights)=0"
.br
.in -1c
.SS "Protected Attributes"
.in +1c
.ti -1c
.RI "std::vector< std::string > \fBvalidHyperparameters\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
Definition at line \fB13\fP of file \fBBaseClassifier\&.h\fP\&.
.SH "Member Function Documentation"
.PP
.SS "std::vector< std::string > & bayesnet::BaseClassifier::getValidHyperparameters ()\fR [inline]\fP"
.PP
Definition at line \fB40\fP of file \fBBaseClassifier\&.h\fP\&.
.SH "Member Data Documentation"
.PP
.SS "std::vector<std::string> bayesnet::BaseClassifier::validHyperparameters\fR [protected]\fP"
.PP
Definition at line \fB43\fP of file \fBBaseClassifier\&.h\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for BayesNet from the source code\&.

369
docs/man3/bayesnet_Boost.3 Normal file
View File

@@ -0,0 +1,369 @@
.TH "bayesnet::Boost" 3 "Version 1.0.5" "BayesNet" \" -*- nroff -*-
.ad l
.nh
.SH NAME
bayesnet::Boost
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBbayesnet::Ensemble\fP\&.
.PP
Inherited by \fBbayesnet::BoostA2DE\fP, and \fBbayesnet::BoostAODE\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBBoost\fP (bool predict_voting=false)"
.br
.ti -1c
.RI "void \fBsetHyperparameters\fP (const nlohmann::json &hyperparameters_) override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::Ensemble\fP
.in +1c
.ti -1c
.RI "\fBEnsemble\fP (bool predict_voting=true)"
.br
.ti -1c
.RI "torch::Tensor \fBpredict\fP (torch::Tensor &X) override"
.br
.ti -1c
.RI "std::vector< int > \fBpredict\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "torch::Tensor \fBpredict_proba\fP (torch::Tensor &X) override"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_proba\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "float \fBscore\fP (torch::Tensor &X, torch::Tensor &y) override"
.br
.ti -1c
.RI "float \fBscore\fP (std::vector< std::vector< int > > &X, std::vector< int > &y) override"
.br
.ti -1c
.RI "int \fBgetNumberOfNodes\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfEdges\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfStates\fP () const override"
.br
.ti -1c
.RI "std::vector< std::string > \fBshow\fP () const override"
.br
.ti -1c
.RI "std::vector< std::string > \fBgraph\fP (const std::string &title) const override"
.br
.ti -1c
.RI "std::vector< std::string > \fBtopological_order\fP () override"
.br
.ti -1c
.RI "std::string \fBdump_cpt\fP () const override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "\fBClassifier\fP (\fBNetwork\fP model)"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (std::vector< std::vector< int > > &X, std::vector< int > &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &X, torch::Tensor &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states, const torch::Tensor &weights) override"
.br
.ti -1c
.RI "void \fBaddNodes\fP ()"
.br
.ti -1c
.RI "int \fBgetClassNumStates\fP () const override"
.br
.ti -1c
.RI "status_t \fBgetStatus\fP () const override"
.br
.ti -1c
.RI "std::string \fBgetVersion\fP () override"
.br
.ti -1c
.RI "std::vector< std::string > \fBgetNotes\fP () const override"
.br
.ti -1c
.RI "void \fBsetHyperparameters\fP (const nlohmann::json &hyperparameters) override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "std::vector< std::string > & \fBgetValidHyperparameters\fP ()"
.br
.in -1c
.SS "Protected Member Functions"
.in +1c
.ti -1c
.RI "std::vector< int > \fBfeatureSelection\fP (torch::Tensor &weights_)"
.br
.ti -1c
.RI "void \fBbuildModel\fP (const torch::Tensor &weights) override"
.br
.ti -1c
.RI "std::tuple< torch::Tensor &, double, bool > \fBupdate_weights\fP (torch::Tensor &ytrain, torch::Tensor &ypred, torch::Tensor &weights)"
.br
.ti -1c
.RI "std::tuple< torch::Tensor &, double, bool > \fBupdate_weights_block\fP (int k, torch::Tensor &ytrain, torch::Tensor &weights)"
.br
.in -1c
Protected Member Functions inherited from \fBbayesnet::Ensemble\fP
.in +1c
.ti -1c
.RI "torch::Tensor \fBpredict_average_voting\fP (torch::Tensor &X)"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_average_voting\fP (std::vector< std::vector< int > > &X)"
.br
.ti -1c
.RI "torch::Tensor \fBpredict_average_proba\fP (torch::Tensor &X)"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_average_proba\fP (std::vector< std::vector< int > > &X)"
.br
.ti -1c
.RI "torch::Tensor \fBcompute_arg_max\fP (torch::Tensor &X)"
.br
.ti -1c
.RI "std::vector< int > \fBcompute_arg_max\fP (std::vector< std::vector< double > > &X)"
.br
.ti -1c
.RI "torch::Tensor \fBvoting\fP (torch::Tensor &votes)"
.br
.ti -1c
.RI "void \fBtrainModel\fP (const torch::Tensor &weights) override"
.br
.in -1c
Protected Member Functions inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "void \fBcheckFitParameters\fP ()"
.br
.ti -1c
.RI "void \fBbuildDataset\fP (torch::Tensor &y)"
.br
.in -1c
.SS "Protected Attributes"
.in +1c
.ti -1c
.RI "torch::Tensor \fBX_train\fP"
.br
.ti -1c
.RI "torch::Tensor \fBy_train\fP"
.br
.ti -1c
.RI "torch::Tensor \fBX_test\fP"
.br
.ti -1c
.RI "torch::Tensor \fBy_test\fP"
.br
.ti -1c
.RI "bool \fBbisection\fP = true"
.br
.ti -1c
.RI "int \fBmaxTolerance\fP = 3"
.br
.ti -1c
.RI "std::string \fBorder_algorithm\fP"
.br
.ti -1c
.RI "bool \fBconvergence\fP = true"
.br
.ti -1c
.RI "bool \fBconvergence_best\fP = false"
.br
.ti -1c
.RI "bool \fBselectFeatures\fP = false"
.br
.ti -1c
.RI "std::string \fBselect_features_algorithm\fP = Orders\&.DESC"
.br
.ti -1c
.RI "FeatureSelect * \fBfeatureSelector\fP = nullptr"
.br
.ti -1c
.RI "double \fBthreshold\fP = \-1"
.br
.ti -1c
.RI "bool \fBblock_update\fP = false"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::Ensemble\fP
.in +1c
.ti -1c
.RI "unsigned \fBn_models\fP"
.br
.ti -1c
.RI "std::vector< std::unique_ptr< \fBClassifier\fP > > \fBmodels\fP"
.br
.ti -1c
.RI "std::vector< double > \fBsignificanceModels\fP"
.br
.ti -1c
.RI "bool \fBpredict_voting\fP"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "bool \fBfitted\fP"
.br
.ti -1c
.RI "unsigned int \fBm\fP"
.br
.ti -1c
.RI "unsigned int \fBn\fP"
.br
.ti -1c
.RI "\fBNetwork\fP \fBmodel\fP"
.br
.ti -1c
.RI "Metrics \fBmetrics\fP"
.br
.ti -1c
.RI "std::vector< std::string > \fBfeatures\fP"
.br
.ti -1c
.RI "std::string \fBclassName\fP"
.br
.ti -1c
.RI "std::map< std::string, std::vector< int > > \fBstates\fP"
.br
.ti -1c
.RI "torch::Tensor \fBdataset\fP"
.br
.ti -1c
.RI "status_t \fBstatus\fP = NORMAL"
.br
.ti -1c
.RI "std::vector< std::string > \fBnotes\fP"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "std::vector< std::string > \fBvalidHyperparameters\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
Definition at line \fB27\fP of file \fBBoost\&.h\fP\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "bayesnet::Boost::Boost (bool predict_voting = \fRfalse\fP)\fR [explicit]\fP"
.PP
Definition at line \fB13\fP of file \fBBoost\&.cc\fP\&.
.SH "Member Function Documentation"
.PP
.SS "void bayesnet::Boost::buildModel (const torch::Tensor & weights)\fR [override]\fP, \fR [protected]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::Classifier\fP\&.
.PP
Definition at line \fB71\fP of file \fBBoost\&.cc\fP\&.
.SS "std::vector< int > bayesnet::Boost::featureSelection (torch::Tensor & weights_)\fR [protected]\fP"
.PP
Definition at line \fB102\fP of file \fBBoost\&.cc\fP\&.
.SS "void bayesnet::Boost::setHyperparameters (const nlohmann::json & hyperparameters_)\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB18\fP of file \fBBoost\&.cc\fP\&.
.SS "std::tuple< torch::Tensor &, double, bool > bayesnet::Boost::update_weights (torch::Tensor & ytrain, torch::Tensor & ypred, torch::Tensor & weights)\fR [protected]\fP"
.PP
Definition at line \fB123\fP of file \fBBoost\&.cc\fP\&.
.SS "std::tuple< torch::Tensor &, double, bool > bayesnet::Boost::update_weights_block (int k, torch::Tensor & ytrain, torch::Tensor & weights)\fR [protected]\fP"
.PP
Definition at line \fB150\fP of file \fBBoost\&.cc\fP\&.
.SH "Member Data Documentation"
.PP
.SS "bool bayesnet::Boost::bisection = true\fR [protected]\fP"
.PP
Definition at line \fB39\fP of file \fBBoost\&.h\fP\&.
.SS "bool bayesnet::Boost::block_update = false\fR [protected]\fP"
.PP
Definition at line \fB48\fP of file \fBBoost\&.h\fP\&.
.SS "bool bayesnet::Boost::convergence = true\fR [protected]\fP"
.PP
Definition at line \fB42\fP of file \fBBoost\&.h\fP\&.
.SS "bool bayesnet::Boost::convergence_best = false\fR [protected]\fP"
.PP
Definition at line \fB43\fP of file \fBBoost\&.h\fP\&.
.SS "FeatureSelect* bayesnet::Boost::featureSelector = nullptr\fR [protected]\fP"
.PP
Definition at line \fB46\fP of file \fBBoost\&.h\fP\&.
.SS "int bayesnet::Boost::maxTolerance = 3\fR [protected]\fP"
.PP
Definition at line \fB40\fP of file \fBBoost\&.h\fP\&.
.SS "std::string bayesnet::Boost::order_algorithm\fR [protected]\fP"
.PP
Definition at line \fB41\fP of file \fBBoost\&.h\fP\&.
.SS "std::string bayesnet::Boost::select_features_algorithm = Orders\&.DESC\fR [protected]\fP"
.PP
Definition at line \fB45\fP of file \fBBoost\&.h\fP\&.
.SS "bool bayesnet::Boost::selectFeatures = false\fR [protected]\fP"
.PP
Definition at line \fB44\fP of file \fBBoost\&.h\fP\&.
.SS "double bayesnet::Boost::threshold = \-1\fR [protected]\fP"
.PP
Definition at line \fB47\fP of file \fBBoost\&.h\fP\&.
.SS "torch::Tensor bayesnet::Boost::X_test\fR [protected]\fP"
.PP
Definition at line \fB37\fP of file \fBBoost\&.h\fP\&.
.SS "torch::Tensor bayesnet::Boost::X_train\fR [protected]\fP"
.PP
Definition at line \fB37\fP of file \fBBoost\&.h\fP\&.
.SS "torch::Tensor bayesnet::Boost::y_test\fR [protected]\fP"
.PP
Definition at line \fB37\fP of file \fBBoost\&.h\fP\&.
.SS "torch::Tensor bayesnet::Boost::y_train\fR [protected]\fP"
.PP
Definition at line \fB37\fP of file \fBBoost\&.h\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for BayesNet from the source code\&.

316
docs/man3/bayesnet_BoostA2DE.3 Normal file
View File

@@ -0,0 +1,316 @@
.TH "bayesnet::BoostA2DE" 3 "Version 1.0.5" "BayesNet" \" -*- nroff -*-
.ad l
.nh
.SH NAME
bayesnet::BoostA2DE
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBbayesnet::Boost\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBBoostA2DE\fP (bool predict_voting=false)"
.br
.ti -1c
.RI "std::vector< std::string > \fBgraph\fP (const std::string &title='BoostA2DE') const override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::Boost\fP
.in +1c
.ti -1c
.RI "\fBBoost\fP (bool predict_voting=false)"
.br
.ti -1c
.RI "void \fBsetHyperparameters\fP (const nlohmann::json &hyperparameters_) override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::Ensemble\fP
.in +1c
.ti -1c
.RI "\fBEnsemble\fP (bool predict_voting=true)"
.br
.ti -1c
.RI "torch::Tensor \fBpredict\fP (torch::Tensor &X) override"
.br
.ti -1c
.RI "std::vector< int > \fBpredict\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "torch::Tensor \fBpredict_proba\fP (torch::Tensor &X) override"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_proba\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "float \fBscore\fP (torch::Tensor &X, torch::Tensor &y) override"
.br
.ti -1c
.RI "float \fBscore\fP (std::vector< std::vector< int > > &X, std::vector< int > &y) override"
.br
.ti -1c
.RI "int \fBgetNumberOfNodes\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfEdges\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfStates\fP () const override"
.br
.ti -1c
.RI "std::vector< std::string > \fBshow\fP () const override"
.br
.ti -1c
.RI "std::vector< std::string > \fBgraph\fP (const std::string &title) const override"
.br
.ti -1c
.RI "std::vector< std::string > \fBtopological_order\fP () override"
.br
.ti -1c
.RI "std::string \fBdump_cpt\fP () const override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "\fBClassifier\fP (\fBNetwork\fP model)"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (std::vector< std::vector< int > > &X, std::vector< int > &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &X, torch::Tensor &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states, const torch::Tensor &weights) override"
.br
.ti -1c
.RI "void \fBaddNodes\fP ()"
.br
.ti -1c
.RI "int \fBgetClassNumStates\fP () const override"
.br
.ti -1c
.RI "status_t \fBgetStatus\fP () const override"
.br
.ti -1c
.RI "std::string \fBgetVersion\fP () override"
.br
.ti -1c
.RI "std::vector< std::string > \fBgetNotes\fP () const override"
.br
.ti -1c
.RI "void \fBsetHyperparameters\fP (const nlohmann::json &hyperparameters) override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "std::vector< std::string > & \fBgetValidHyperparameters\fP ()"
.br
.in -1c
.SS "Protected Member Functions"
.in +1c
.ti -1c
.RI "void \fBtrainModel\fP (const torch::Tensor &weights) override"
.br
.in -1c
Protected Member Functions inherited from \fBbayesnet::Boost\fP
.in +1c
.ti -1c
.RI "std::vector< int > \fBfeatureSelection\fP (torch::Tensor &weights_)"
.br
.ti -1c
.RI "void \fBbuildModel\fP (const torch::Tensor &weights) override"
.br
.ti -1c
.RI "std::tuple< torch::Tensor &, double, bool > \fBupdate_weights\fP (torch::Tensor &ytrain, torch::Tensor &ypred, torch::Tensor &weights)"
.br
.ti -1c
.RI "std::tuple< torch::Tensor &, double, bool > \fBupdate_weights_block\fP (int k, torch::Tensor &ytrain, torch::Tensor &weights)"
.br
.in -1c
Protected Member Functions inherited from \fBbayesnet::Ensemble\fP
.in +1c
.ti -1c
.RI "torch::Tensor \fBpredict_average_voting\fP (torch::Tensor &X)"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_average_voting\fP (std::vector< std::vector< int > > &X)"
.br
.ti -1c
.RI "torch::Tensor \fBpredict_average_proba\fP (torch::Tensor &X)"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_average_proba\fP (std::vector< std::vector< int > > &X)"
.br
.ti -1c
.RI "torch::Tensor \fBcompute_arg_max\fP (torch::Tensor &X)"
.br
.ti -1c
.RI "std::vector< int > \fBcompute_arg_max\fP (std::vector< std::vector< double > > &X)"
.br
.ti -1c
.RI "torch::Tensor \fBvoting\fP (torch::Tensor &votes)"
.br
.ti -1c
.RI "void \fBtrainModel\fP (const torch::Tensor &weights) override"
.br
.in -1c
Protected Member Functions inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "void \fBcheckFitParameters\fP ()"
.br
.ti -1c
.RI "void \fBbuildDataset\fP (torch::Tensor &y)"
.br
.in -1c
.SS "Additional Inherited Members"
Protected Attributes inherited from \fBbayesnet::Boost\fP
.in +1c
.ti -1c
.RI "torch::Tensor \fBX_train\fP"
.br
.ti -1c
.RI "torch::Tensor \fBy_train\fP"
.br
.ti -1c
.RI "torch::Tensor \fBX_test\fP"
.br
.ti -1c
.RI "torch::Tensor \fBy_test\fP"
.br
.ti -1c
.RI "bool \fBbisection\fP = true"
.br
.ti -1c
.RI "int \fBmaxTolerance\fP = 3"
.br
.ti -1c
.RI "std::string \fBorder_algorithm\fP"
.br
.ti -1c
.RI "bool \fBconvergence\fP = true"
.br
.ti -1c
.RI "bool \fBconvergence_best\fP = false"
.br
.ti -1c
.RI "bool \fBselectFeatures\fP = false"
.br
.ti -1c
.RI "std::string \fBselect_features_algorithm\fP = Orders\&.DESC"
.br
.ti -1c
.RI "FeatureSelect * \fBfeatureSelector\fP = nullptr"
.br
.ti -1c
.RI "double \fBthreshold\fP = \-1"
.br
.ti -1c
.RI "bool \fBblock_update\fP = false"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::Ensemble\fP
.in +1c
.ti -1c
.RI "unsigned \fBn_models\fP"
.br
.ti -1c
.RI "std::vector< std::unique_ptr< \fBClassifier\fP > > \fBmodels\fP"
.br
.ti -1c
.RI "std::vector< double > \fBsignificanceModels\fP"
.br
.ti -1c
.RI "bool \fBpredict_voting\fP"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "bool \fBfitted\fP"
.br
.ti -1c
.RI "unsigned int \fBm\fP"
.br
.ti -1c
.RI "unsigned int \fBn\fP"
.br
.ti -1c
.RI "\fBNetwork\fP \fBmodel\fP"
.br
.ti -1c
.RI "Metrics \fBmetrics\fP"
.br
.ti -1c
.RI "std::vector< std::string > \fBfeatures\fP"
.br
.ti -1c
.RI "std::string \fBclassName\fP"
.br
.ti -1c
.RI "std::map< std::string, std::vector< int > > \fBstates\fP"
.br
.ti -1c
.RI "torch::Tensor \fBdataset\fP"
.br
.ti -1c
.RI "status_t \fBstatus\fP = NORMAL"
.br
.ti -1c
.RI "std::vector< std::string > \fBnotes\fP"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "std::vector< std::string > \fBvalidHyperparameters\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
Definition at line \fB14\fP of file \fBBoostA2DE\&.h\fP\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "bayesnet::BoostA2DE::BoostA2DE (bool predict_voting = \fRfalse\fP)\fR [explicit]\fP"
.PP
Definition at line \fB19\fP of file \fBBoostA2DE\&.cc\fP\&.
.SH "Member Function Documentation"
.PP
.SS "std::vector< std::string > bayesnet::BoostA2DE::graph (const std::string & title = \fR'BoostA2DE'\fP) const\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB163\fP of file \fBBoostA2DE\&.cc\fP\&.
.SS "void bayesnet::BoostA2DE::trainModel (const torch::Tensor & weights)\fR [override]\fP, \fR [protected]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB44\fP of file \fBBoostA2DE\&.cc\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for BayesNet from the source code\&.

316
docs/man3/bayesnet_BoostAODE.3 Normal file
View File

@@ -0,0 +1,316 @@
.TH "bayesnet::BoostAODE" 3 "Version 1.0.5" "BayesNet" \" -*- nroff -*-
.ad l
.nh
.SH NAME
bayesnet::BoostAODE
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBbayesnet::Boost\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBBoostAODE\fP (bool predict_voting=false)"
.br
.ti -1c
.RI "std::vector< std::string > \fBgraph\fP (const std::string &title='BoostAODE') const override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::Boost\fP
.in +1c
.ti -1c
.RI "\fBBoost\fP (bool predict_voting=false)"
.br
.ti -1c
.RI "void \fBsetHyperparameters\fP (const nlohmann::json &hyperparameters_) override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::Ensemble\fP
.in +1c
.ti -1c
.RI "\fBEnsemble\fP (bool predict_voting=true)"
.br
.ti -1c
.RI "torch::Tensor \fBpredict\fP (torch::Tensor &X) override"
.br
.ti -1c
.RI "std::vector< int > \fBpredict\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "torch::Tensor \fBpredict_proba\fP (torch::Tensor &X) override"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_proba\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "float \fBscore\fP (torch::Tensor &X, torch::Tensor &y) override"
.br
.ti -1c
.RI "float \fBscore\fP (std::vector< std::vector< int > > &X, std::vector< int > &y) override"
.br
.ti -1c
.RI "int \fBgetNumberOfNodes\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfEdges\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfStates\fP () const override"
.br
.ti -1c
.RI "std::vector< std::string > \fBshow\fP () const override"
.br
.ti -1c
.RI "std::vector< std::string > \fBgraph\fP (const std::string &title) const override"
.br
.ti -1c
.RI "std::vector< std::string > \fBtopological_order\fP () override"
.br
.ti -1c
.RI "std::string \fBdump_cpt\fP () const override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "\fBClassifier\fP (\fBNetwork\fP model)"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (std::vector< std::vector< int > > &X, std::vector< int > &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &X, torch::Tensor &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states, const torch::Tensor &weights) override"
.br
.ti -1c
.RI "void \fBaddNodes\fP ()"
.br
.ti -1c
.RI "int \fBgetClassNumStates\fP () const override"
.br
.ti -1c
.RI "status_t \fBgetStatus\fP () const override"
.br
.ti -1c
.RI "std::string \fBgetVersion\fP () override"
.br
.ti -1c
.RI "std::vector< std::string > \fBgetNotes\fP () const override"
.br
.ti -1c
.RI "void \fBsetHyperparameters\fP (const nlohmann::json &hyperparameters) override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "std::vector< std::string > & \fBgetValidHyperparameters\fP ()"
.br
.in -1c
.SS "Protected Member Functions"
.in +1c
.ti -1c
.RI "void \fBtrainModel\fP (const torch::Tensor &weights) override"
.br
.in -1c
Protected Member Functions inherited from \fBbayesnet::Boost\fP
.in +1c
.ti -1c
.RI "std::vector< int > \fBfeatureSelection\fP (torch::Tensor &weights_)"
.br
.ti -1c
.RI "void \fBbuildModel\fP (const torch::Tensor &weights) override"
.br
.ti -1c
.RI "std::tuple< torch::Tensor &, double, bool > \fBupdate_weights\fP (torch::Tensor &ytrain, torch::Tensor &ypred, torch::Tensor &weights)"
.br
.ti -1c
.RI "std::tuple< torch::Tensor &, double, bool > \fBupdate_weights_block\fP (int k, torch::Tensor &ytrain, torch::Tensor &weights)"
.br
.in -1c
Protected Member Functions inherited from \fBbayesnet::Ensemble\fP
.in +1c
.ti -1c
.RI "torch::Tensor \fBpredict_average_voting\fP (torch::Tensor &X)"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_average_voting\fP (std::vector< std::vector< int > > &X)"
.br
.ti -1c
.RI "torch::Tensor \fBpredict_average_proba\fP (torch::Tensor &X)"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_average_proba\fP (std::vector< std::vector< int > > &X)"
.br
.ti -1c
.RI "torch::Tensor \fBcompute_arg_max\fP (torch::Tensor &X)"
.br
.ti -1c
.RI "std::vector< int > \fBcompute_arg_max\fP (std::vector< std::vector< double > > &X)"
.br
.ti -1c
.RI "torch::Tensor \fBvoting\fP (torch::Tensor &votes)"
.br
.ti -1c
.RI "void \fBtrainModel\fP (const torch::Tensor &weights) override"
.br
.in -1c
Protected Member Functions inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "void \fBcheckFitParameters\fP ()"
.br
.ti -1c
.RI "void \fBbuildDataset\fP (torch::Tensor &y)"
.br
.in -1c
.SS "Additional Inherited Members"
Protected Attributes inherited from \fBbayesnet::Boost\fP
.in +1c
.ti -1c
.RI "torch::Tensor \fBX_train\fP"
.br
.ti -1c
.RI "torch::Tensor \fBy_train\fP"
.br
.ti -1c
.RI "torch::Tensor \fBX_test\fP"
.br
.ti -1c
.RI "torch::Tensor \fBy_test\fP"
.br
.ti -1c
.RI "bool \fBbisection\fP = true"
.br
.ti -1c
.RI "int \fBmaxTolerance\fP = 3"
.br
.ti -1c
.RI "std::string \fBorder_algorithm\fP"
.br
.ti -1c
.RI "bool \fBconvergence\fP = true"
.br
.ti -1c
.RI "bool \fBconvergence_best\fP = false"
.br
.ti -1c
.RI "bool \fBselectFeatures\fP = false"
.br
.ti -1c
.RI "std::string \fBselect_features_algorithm\fP = Orders\&.DESC"
.br
.ti -1c
.RI "FeatureSelect * \fBfeatureSelector\fP = nullptr"
.br
.ti -1c
.RI "double \fBthreshold\fP = \-1"
.br
.ti -1c
.RI "bool \fBblock_update\fP = false"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::Ensemble\fP
.in +1c
.ti -1c
.RI "unsigned \fBn_models\fP"
.br
.ti -1c
.RI "std::vector< std::unique_ptr< \fBClassifier\fP > > \fBmodels\fP"
.br
.ti -1c
.RI "std::vector< double > \fBsignificanceModels\fP"
.br
.ti -1c
.RI "bool \fBpredict_voting\fP"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "bool \fBfitted\fP"
.br
.ti -1c
.RI "unsigned int \fBm\fP"
.br
.ti -1c
.RI "unsigned int \fBn\fP"
.br
.ti -1c
.RI "\fBNetwork\fP \fBmodel\fP"
.br
.ti -1c
.RI "Metrics \fBmetrics\fP"
.br
.ti -1c
.RI "std::vector< std::string > \fBfeatures\fP"
.br
.ti -1c
.RI "std::string \fBclassName\fP"
.br
.ti -1c
.RI "std::map< std::string, std::vector< int > > \fBstates\fP"
.br
.ti -1c
.RI "torch::Tensor \fBdataset\fP"
.br
.ti -1c
.RI "status_t \fBstatus\fP = NORMAL"
.br
.ti -1c
.RI "std::vector< std::string > \fBnotes\fP"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "std::vector< std::string > \fBvalidHyperparameters\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
Definition at line \fB15\fP of file \fBBoostAODE\&.h\fP\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "bayesnet::BoostAODE::BoostAODE (bool predict_voting = \fRfalse\fP)\fR [explicit]\fP"
.PP
Definition at line \fB16\fP of file \fBBoostAODE\&.cc\fP\&.
.SH "Member Function Documentation"
.PP
.SS "std::vector< std::string > bayesnet::BoostAODE::graph (const std::string & title = \fR'BoostAODE'\fP) const\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB157\fP of file \fBBoostAODE\&.cc\fP\&.
.SS "void bayesnet::BoostAODE::trainModel (const torch::Tensor & weights)\fR [override]\fP, \fR [protected]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB33\fP of file \fBBoostAODE\&.cc\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for BayesNet from the source code\&.

360
docs/man3/bayesnet_Classifier.3 Normal file
View File

@@ -0,0 +1,360 @@
.TH "bayesnet::Classifier" 3 "Version 1.0.5" "BayesNet" \" -*- nroff -*-
.ad l
.nh
.SH NAME
bayesnet::Classifier
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBbayesnet::BaseClassifier\fP\&.
.PP
Inherited by \fBbayesnet::Ensemble\fP, \fBbayesnet::KDB\fP, \fBbayesnet::SPODE\fP, \fBbayesnet::SPnDE\fP, and \fBbayesnet::TAN\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBClassifier\fP (\fBNetwork\fP model)"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (std::vector< std::vector< int > > &X, std::vector< int > &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &X, torch::Tensor &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states, const torch::Tensor &weights) override"
.br
.ti -1c
.RI "void \fBaddNodes\fP ()"
.br
.ti -1c
.RI "int \fBgetNumberOfNodes\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfEdges\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfStates\fP () const override"
.br
.ti -1c
.RI "int \fBgetClassNumStates\fP () const override"
.br
.ti -1c
.RI "torch::Tensor \fBpredict\fP (torch::Tensor &X) override"
.br
.ti -1c
.RI "std::vector< int > \fBpredict\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "torch::Tensor \fBpredict_proba\fP (torch::Tensor &X) override"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_proba\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "status_t \fBgetStatus\fP () const override"
.br
.ti -1c
.RI "std::string \fBgetVersion\fP () override"
.br
.ti -1c
.RI "float \fBscore\fP (torch::Tensor &X, torch::Tensor &y) override"
.br
.ti -1c
.RI "float \fBscore\fP (std::vector< std::vector< int > > &X, std::vector< int > &y) override"
.br
.ti -1c
.RI "std::vector< std::string > \fBshow\fP () const override"
.br
.ti -1c
.RI "std::vector< std::string > \fBtopological_order\fP () override"
.br
.ti -1c
.RI "std::vector< std::string > \fBgetNotes\fP () const override"
.br
.ti -1c
.RI "std::string \fBdump_cpt\fP () const override"
.br
.ti -1c
.RI "void \fBsetHyperparameters\fP (const nlohmann::json &hyperparameters) override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "virtual std::vector< std::string > \fBgraph\fP (const std::string &title='') const =0"
.br
.ti -1c
.RI "std::vector< std::string > & \fBgetValidHyperparameters\fP ()"
.br
.in -1c
.SS "Protected Member Functions"
.in +1c
.ti -1c
.RI "void \fBcheckFitParameters\fP ()"
.br
.ti -1c
.RI "virtual void \fBbuildModel\fP (const torch::Tensor &weights)=0"
.br
.ti -1c
.RI "void \fBtrainModel\fP (const torch::Tensor &weights) override"
.br
.ti -1c
.RI "void \fBbuildDataset\fP (torch::Tensor &y)"
.br
.in -1c
.SS "Protected Attributes"
.in +1c
.ti -1c
.RI "bool \fBfitted\fP"
.br
.ti -1c
.RI "unsigned int \fBm\fP"
.br
.ti -1c
.RI "unsigned int \fBn\fP"
.br
.ti -1c
.RI "\fBNetwork\fP \fBmodel\fP"
.br
.ti -1c
.RI "Metrics \fBmetrics\fP"
.br
.ti -1c
.RI "std::vector< std::string > \fBfeatures\fP"
.br
.ti -1c
.RI "std::string \fBclassName\fP"
.br
.ti -1c
.RI "std::map< std::string, std::vector< int > > \fBstates\fP"
.br
.ti -1c
.RI "torch::Tensor \fBdataset\fP"
.br
.ti -1c
.RI "status_t \fBstatus\fP = NORMAL"
.br
.ti -1c
.RI "std::vector< std::string > \fBnotes\fP"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "std::vector< std::string > \fBvalidHyperparameters\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
Definition at line \fB15\fP of file \fBClassifier\&.h\fP\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "bayesnet::Classifier::Classifier (\fBNetwork\fP model)"
.PP
Definition at line \fB12\fP of file \fBClassifier\&.cc\fP\&.
.SH "Member Function Documentation"
.PP
.SS "void bayesnet::Classifier::addNodes ()"
.PP
Definition at line \fB155\fP of file \fBClassifier\&.cc\fP\&.
.SS "void bayesnet::Classifier::buildDataset (torch::Tensor & y)\fR [protected]\fP"
.PP
Definition at line \fB30\fP of file \fBClassifier\&.cc\fP\&.
.SS "void bayesnet::Classifier::checkFitParameters ()\fR [protected]\fP"
.PP
Definition at line \fB79\fP of file \fBClassifier\&.cc\fP\&.
.SS "std::string bayesnet::Classifier::dump_cpt () const\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB184\fP of file \fBClassifier\&.cc\fP\&.
.SS "\fBClassifier\fP & bayesnet::Classifier::fit (std::vector< std::vector< int > > & X, std::vector< int > & y, const std::vector< std::string > & features, const std::string & className, std::map< std::string, std::vector< int > > & states)\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB57\fP of file \fBClassifier\&.cc\fP\&.
.SS "\fBClassifier\fP & bayesnet::Classifier::fit (torch::Tensor & dataset, const std::vector< std::string > & features, const std::string & className, std::map< std::string, std::vector< int > > & states)\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB68\fP of file \fBClassifier\&.cc\fP\&.
.SS "\fBClassifier\fP & bayesnet::Classifier::fit (torch::Tensor & dataset, const std::vector< std::string > & features, const std::string & className, std::map< std::string, std::vector< int > > & states, const torch::Tensor & weights)\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB74\fP of file \fBClassifier\&.cc\fP\&.
.SS "\fBClassifier\fP & bayesnet::Classifier::fit (torch::Tensor & X, torch::Tensor & y, const std::vector< std::string > & features, const std::string & className, std::map< std::string, std::vector< int > > & states)\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB49\fP of file \fBClassifier\&.cc\fP\&.
.SS "int bayesnet::Classifier::getClassNumStates () const\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB176\fP of file \fBClassifier\&.cc\fP\&.
.SS "std::vector< std::string > bayesnet::Classifier::getNotes () const\fR [inline]\fP, \fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB38\fP of file \fBClassifier\&.h\fP\&.
.SS "int bayesnet::Classifier::getNumberOfEdges () const\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB168\fP of file \fBClassifier\&.cc\fP\&.
.SS "int bayesnet::Classifier::getNumberOfNodes () const\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB163\fP of file \fBClassifier\&.cc\fP\&.
.SS "int bayesnet::Classifier::getNumberOfStates () const\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB172\fP of file \fBClassifier\&.cc\fP\&.
.SS "status_t bayesnet::Classifier::getStatus () const\fR [inline]\fP, \fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB32\fP of file \fBClassifier\&.h\fP\&.
.SS "std::string bayesnet::Classifier::getVersion ()\fR [inline]\fP, \fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB33\fP of file \fBClassifier\&.h\fP\&.
.SS "std::vector< int > bayesnet::Classifier::predict (std::vector< std::vector< int > > & X)\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB103\fP of file \fBClassifier\&.cc\fP\&.
.SS "torch::Tensor bayesnet::Classifier::predict (torch::Tensor & X)\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB96\fP of file \fBClassifier\&.cc\fP\&.
.SS "std::vector< std::vector< double > > bayesnet::Classifier::predict_proba (std::vector< std::vector< int > > & X)\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB124\fP of file \fBClassifier\&.cc\fP\&.
.SS "torch::Tensor bayesnet::Classifier::predict_proba (torch::Tensor & X)\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB117\fP of file \fBClassifier\&.cc\fP\&.
.SS "float bayesnet::Classifier::score (std::vector< std::vector< int > > & X, std::vector< int > & y)\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB144\fP of file \fBClassifier\&.cc\fP\&.
.SS "float bayesnet::Classifier::score (torch::Tensor & X, torch::Tensor & y)\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB139\fP of file \fBClassifier\&.cc\fP\&.
.SS "void bayesnet::Classifier::setHyperparameters (const nlohmann::json & hyperparameters)\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB188\fP of file \fBClassifier\&.cc\fP\&.
.SS "std::vector< std::string > bayesnet::Classifier::show () const\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB151\fP of file \fBClassifier\&.cc\fP\&.
.SS "std::vector< std::string > bayesnet::Classifier::topological_order ()\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB180\fP of file \fBClassifier\&.cc\fP\&.
.SS "void bayesnet::Classifier::trainModel (const torch::Tensor & weights)\fR [override]\fP, \fR [protected]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB44\fP of file \fBClassifier\&.cc\fP\&.
.SH "Member Data Documentation"
.PP
.SS "std::string bayesnet::Classifier::className\fR [protected]\fP"
.PP
Definition at line \fB47\fP of file \fBClassifier\&.h\fP\&.
.SS "torch::Tensor bayesnet::Classifier::dataset\fR [protected]\fP"
.PP
Definition at line \fB49\fP of file \fBClassifier\&.h\fP\&.
.SS "std::vector<std::string> bayesnet::Classifier::features\fR [protected]\fP"
.PP
Definition at line \fB46\fP of file \fBClassifier\&.h\fP\&.
.SS "bool bayesnet::Classifier::fitted\fR [protected]\fP"
.PP
Definition at line \fB42\fP of file \fBClassifier\&.h\fP\&.
.SS "unsigned int bayesnet::Classifier::m\fR [protected]\fP"
.PP
Definition at line \fB43\fP of file \fBClassifier\&.h\fP\&.
.SS "Metrics bayesnet::Classifier::metrics\fR [protected]\fP"
.PP
Definition at line \fB45\fP of file \fBClassifier\&.h\fP\&.
.SS "\fBNetwork\fP bayesnet::Classifier::model\fR [protected]\fP"
.PP
Definition at line \fB44\fP of file \fBClassifier\&.h\fP\&.
.SS "unsigned int bayesnet::Classifier::n\fR [protected]\fP"
.PP
Definition at line \fB43\fP of file \fBClassifier\&.h\fP\&.
.SS "std::vector<std::string> bayesnet::Classifier::notes\fR [protected]\fP"
.PP
Definition at line \fB51\fP of file \fBClassifier\&.h\fP\&.
.SS "std::map<std::string, std::vector<int> > bayesnet::Classifier::states\fR [protected]\fP"
.PP
Definition at line \fB48\fP of file \fBClassifier\&.h\fP\&.
.SS "status_t bayesnet::Classifier::status = NORMAL\fR [protected]\fP"
.PP
Definition at line \fB50\fP of file \fBClassifier\&.h\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for BayesNet from the source code\&.

348
docs/man3/bayesnet_Ensemble.3 Normal file
View File

@@ -0,0 +1,348 @@
.TH "bayesnet::Ensemble" 3 "Version 1.0.5" "BayesNet" \" -*- nroff -*-
.ad l
.nh
.SH NAME
bayesnet::Ensemble
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBbayesnet::Classifier\fP\&.
.PP
Inherited by \fBbayesnet::A2DE\fP, \fBbayesnet::AODE\fP, \fBbayesnet::AODELd\fP, and \fBbayesnet::Boost\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBEnsemble\fP (bool predict_voting=true)"
.br
.ti -1c
.RI "torch::Tensor \fBpredict\fP (torch::Tensor &X) override"
.br
.ti -1c
.RI "std::vector< int > \fBpredict\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "torch::Tensor \fBpredict_proba\fP (torch::Tensor &X) override"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_proba\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "float \fBscore\fP (torch::Tensor &X, torch::Tensor &y) override"
.br
.ti -1c
.RI "float \fBscore\fP (std::vector< std::vector< int > > &X, std::vector< int > &y) override"
.br
.ti -1c
.RI "int \fBgetNumberOfNodes\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfEdges\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfStates\fP () const override"
.br
.ti -1c
.RI "std::vector< std::string > \fBshow\fP () const override"
.br
.ti -1c
.RI "std::vector< std::string > \fBgraph\fP (const std::string &title) const override"
.br
.ti -1c
.RI "std::vector< std::string > \fBtopological_order\fP () override"
.br
.ti -1c
.RI "std::string \fBdump_cpt\fP () const override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "\fBClassifier\fP (\fBNetwork\fP model)"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (std::vector< std::vector< int > > &X, std::vector< int > &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &X, torch::Tensor &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states, const torch::Tensor &weights) override"
.br
.ti -1c
.RI "void \fBaddNodes\fP ()"
.br
.ti -1c
.RI "int \fBgetClassNumStates\fP () const override"
.br
.ti -1c
.RI "status_t \fBgetStatus\fP () const override"
.br
.ti -1c
.RI "std::string \fBgetVersion\fP () override"
.br
.ti -1c
.RI "std::vector< std::string > \fBgetNotes\fP () const override"
.br
.ti -1c
.RI "void \fBsetHyperparameters\fP (const nlohmann::json &hyperparameters) override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "std::vector< std::string > & \fBgetValidHyperparameters\fP ()"
.br
.in -1c
.SS "Protected Member Functions"
.in +1c
.ti -1c
.RI "torch::Tensor \fBpredict_average_voting\fP (torch::Tensor &X)"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_average_voting\fP (std::vector< std::vector< int > > &X)"
.br
.ti -1c
.RI "torch::Tensor \fBpredict_average_proba\fP (torch::Tensor &X)"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_average_proba\fP (std::vector< std::vector< int > > &X)"
.br
.ti -1c
.RI "torch::Tensor \fBcompute_arg_max\fP (torch::Tensor &X)"
.br
.ti -1c
.RI "std::vector< int > \fBcompute_arg_max\fP (std::vector< std::vector< double > > &X)"
.br
.ti -1c
.RI "torch::Tensor \fBvoting\fP (torch::Tensor &votes)"
.br
.ti -1c
.RI "void \fBtrainModel\fP (const torch::Tensor &weights) override"
.br
.in -1c
Protected Member Functions inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "void \fBcheckFitParameters\fP ()"
.br
.ti -1c
.RI "virtual void \fBbuildModel\fP (const torch::Tensor &weights)=0"
.br
.ti -1c
.RI "void \fBbuildDataset\fP (torch::Tensor &y)"
.br
.in -1c
.SS "Protected Attributes"
.in +1c
.ti -1c
.RI "unsigned \fBn_models\fP"
.br
.ti -1c
.RI "std::vector< std::unique_ptr< \fBClassifier\fP > > \fBmodels\fP"
.br
.ti -1c
.RI "std::vector< double > \fBsignificanceModels\fP"
.br
.ti -1c
.RI "bool \fBpredict_voting\fP"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "bool \fBfitted\fP"
.br
.ti -1c
.RI "unsigned int \fBm\fP"
.br
.ti -1c
.RI "unsigned int \fBn\fP"
.br
.ti -1c
.RI "\fBNetwork\fP \fBmodel\fP"
.br
.ti -1c
.RI "Metrics \fBmetrics\fP"
.br
.ti -1c
.RI "std::vector< std::string > \fBfeatures\fP"
.br
.ti -1c
.RI "std::string \fBclassName\fP"
.br
.ti -1c
.RI "std::map< std::string, std::vector< int > > \fBstates\fP"
.br
.ti -1c
.RI "torch::Tensor \fBdataset\fP"
.br
.ti -1c
.RI "status_t \fBstatus\fP = NORMAL"
.br
.ti -1c
.RI "std::vector< std::string > \fBnotes\fP"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "std::vector< std::string > \fBvalidHyperparameters\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
Definition at line \fB15\fP of file \fBEnsemble\&.h\fP\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "bayesnet::Ensemble::Ensemble (bool predict_voting = \fRtrue\fP)"
.PP
Definition at line \fB11\fP of file \fBEnsemble\&.cc\fP\&.
.SH "Member Function Documentation"
.PP
.SS "std::vector< int > bayesnet::Ensemble::compute_arg_max (std::vector< std::vector< double > > & X)\fR [protected]\fP"
.PP
Definition at line \fB24\fP of file \fBEnsemble\&.cc\fP\&.
.SS "torch::Tensor bayesnet::Ensemble::compute_arg_max (torch::Tensor & X)\fR [protected]\fP"
.PP
Definition at line \fB33\fP of file \fBEnsemble\&.cc\fP\&.
.SS "std::string bayesnet::Ensemble::dump_cpt () const\fR [inline]\fP, \fR [override]\fP, \fR [virtual]\fP"
.PP
Reimplemented from \fBbayesnet::Classifier\fP\&.
.PP
Definition at line \fB34\fP of file \fBEnsemble\&.h\fP\&.
.SS "int bayesnet::Ensemble::getNumberOfEdges () const\fR [override]\fP, \fR [virtual]\fP"
.PP
Reimplemented from \fBbayesnet::Classifier\fP\&.
.PP
Definition at line \fB206\fP of file \fBEnsemble\&.cc\fP\&.
.SS "int bayesnet::Ensemble::getNumberOfNodes () const\fR [override]\fP, \fR [virtual]\fP"
.PP
Reimplemented from \fBbayesnet::Classifier\fP\&.
.PP
Definition at line \fB198\fP of file \fBEnsemble\&.cc\fP\&.
.SS "int bayesnet::Ensemble::getNumberOfStates () const\fR [override]\fP, \fR [virtual]\fP"
.PP
Reimplemented from \fBbayesnet::Classifier\fP\&.
.PP
Definition at line \fB214\fP of file \fBEnsemble\&.cc\fP\&.
.SS "std::vector< std::string > bayesnet::Ensemble::graph (const std::string & title) const\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB189\fP of file \fBEnsemble\&.cc\fP\&.
.SS "std::vector< int > bayesnet::Ensemble::predict (std::vector< std::vector< int > > & X)\fR [override]\fP, \fR [virtual]\fP"
.PP
Reimplemented from \fBbayesnet::Classifier\fP\&.
.PP
Definition at line \fB74\fP of file \fBEnsemble\&.cc\fP\&.
.SS "torch::Tensor bayesnet::Ensemble::predict (torch::Tensor & X)\fR [override]\fP, \fR [virtual]\fP"
.PP
Reimplemented from \fBbayesnet::Classifier\fP\&.
.PP
Definition at line \fB79\fP of file \fBEnsemble\&.cc\fP\&.
.SS "std::vector< std::vector< double > > bayesnet::Ensemble::predict_average_proba (std::vector< std::vector< int > > & X)\fR [protected]\fP"
.PP
Definition at line \fB104\fP of file \fBEnsemble\&.cc\fP\&.
.SS "torch::Tensor bayesnet::Ensemble::predict_average_proba (torch::Tensor & X)\fR [protected]\fP"
.PP
Definition at line \fB84\fP of file \fBEnsemble\&.cc\fP\&.
.SS "std::vector< std::vector< double > > bayesnet::Ensemble::predict_average_voting (std::vector< std::vector< int > > & X)\fR [protected]\fP"
.PP
Definition at line \fB133\fP of file \fBEnsemble\&.cc\fP\&.
.SS "torch::Tensor bayesnet::Ensemble::predict_average_voting (torch::Tensor & X)\fR [protected]\fP"
.PP
Definition at line \fB140\fP of file \fBEnsemble\&.cc\fP\&.
.SS "std::vector< std::vector< double > > bayesnet::Ensemble::predict_proba (std::vector< std::vector< int > > & X)\fR [override]\fP, \fR [virtual]\fP"
.PP
Reimplemented from \fBbayesnet::Classifier\fP\&.
.PP
Definition at line \fB60\fP of file \fBEnsemble\&.cc\fP\&.
.SS "torch::Tensor bayesnet::Ensemble::predict_proba (torch::Tensor & X)\fR [override]\fP, \fR [virtual]\fP"
.PP
Reimplemented from \fBbayesnet::Classifier\fP\&.
.PP
Definition at line \fB67\fP of file \fBEnsemble\&.cc\fP\&.
.SS "float bayesnet::Ensemble::score (std::vector< std::vector< int > > & X, std::vector< int > & y)\fR [override]\fP, \fR [virtual]\fP"
.PP
Reimplemented from \fBbayesnet::Classifier\fP\&.
.PP
Definition at line \fB169\fP of file \fBEnsemble\&.cc\fP\&.
.SS "float bayesnet::Ensemble::score (torch::Tensor & X, torch::Tensor & y)\fR [override]\fP, \fR [virtual]\fP"
.PP
Reimplemented from \fBbayesnet::Classifier\fP\&.
.PP
Definition at line \fB158\fP of file \fBEnsemble\&.cc\fP\&.
.SS "std::vector< std::string > bayesnet::Ensemble::show () const\fR [override]\fP, \fR [virtual]\fP"
.PP
Reimplemented from \fBbayesnet::Classifier\fP\&.
.PP
Definition at line \fB180\fP of file \fBEnsemble\&.cc\fP\&.
.SS "std::vector< std::string > bayesnet::Ensemble::topological_order ()\fR [inline]\fP, \fR [override]\fP, \fR [virtual]\fP"
.PP
Reimplemented from \fBbayesnet::Classifier\fP\&.
.PP
Definition at line \fB30\fP of file \fBEnsemble\&.h\fP\&.
.SS "void bayesnet::Ensemble::trainModel (const torch::Tensor & weights)\fR [override]\fP, \fR [protected]\fP, \fR [virtual]\fP"
.PP
Reimplemented from \fBbayesnet::Classifier\fP\&.
.PP
Definition at line \fB16\fP of file \fBEnsemble\&.cc\fP\&.
.SS "torch::Tensor bayesnet::Ensemble::voting (torch::Tensor & votes)\fR [protected]\fP"
.PP
Definition at line \fB38\fP of file \fBEnsemble\&.cc\fP\&.
.SH "Member Data Documentation"
.PP
.SS "std::vector<std::unique_ptr<\fBClassifier\fP> > bayesnet::Ensemble::models\fR [protected]\fP"
.PP
Definition at line \fB47\fP of file \fBEnsemble\&.h\fP\&.
.SS "unsigned bayesnet::Ensemble::n_models\fR [protected]\fP"
.PP
Definition at line \fB46\fP of file \fBEnsemble\&.h\fP\&.
.SS "bool bayesnet::Ensemble::predict_voting\fR [protected]\fP"
.PP
Definition at line \fB50\fP of file \fBEnsemble\&.h\fP\&.
.SS "std::vector<double> bayesnet::Ensemble::significanceModels\fR [protected]\fP"
.PP
Definition at line \fB48\fP of file \fBEnsemble\&.h\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for BayesNet from the source code\&.

201
docs/man3/bayesnet_KDB.3 Normal file
View File

@@ -0,0 +1,201 @@
.TH "bayesnet::KDB" 3 "Version 1.0.5" "BayesNet" \" -*- nroff -*-
.ad l
.nh
.SH NAME
bayesnet::KDB
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBbayesnet::Classifier\fP\&.
.PP
Inherited by \fBbayesnet::KDBLd\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBKDB\fP (int k, float theta=0\&.03)"
.br
.ti -1c
.RI "void \fBsetHyperparameters\fP (const nlohmann::json &hyperparameters_) override"
.br
.ti -1c
.RI "std::vector< std::string > \fBgraph\fP (const std::string &name='KDB') const override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "\fBClassifier\fP (\fBNetwork\fP model)"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (std::vector< std::vector< int > > &X, std::vector< int > &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &X, torch::Tensor &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states, const torch::Tensor &weights) override"
.br
.ti -1c
.RI "void \fBaddNodes\fP ()"
.br
.ti -1c
.RI "int \fBgetNumberOfNodes\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfEdges\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfStates\fP () const override"
.br
.ti -1c
.RI "int \fBgetClassNumStates\fP () const override"
.br
.ti -1c
.RI "torch::Tensor \fBpredict\fP (torch::Tensor &X) override"
.br
.ti -1c
.RI "std::vector< int > \fBpredict\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "torch::Tensor \fBpredict_proba\fP (torch::Tensor &X) override"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_proba\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "status_t \fBgetStatus\fP () const override"
.br
.ti -1c
.RI "std::string \fBgetVersion\fP () override"
.br
.ti -1c
.RI "float \fBscore\fP (torch::Tensor &X, torch::Tensor &y) override"
.br
.ti -1c
.RI "float \fBscore\fP (std::vector< std::vector< int > > &X, std::vector< int > &y) override"
.br
.ti -1c
.RI "std::vector< std::string > \fBshow\fP () const override"
.br
.ti -1c
.RI "std::vector< std::string > \fBtopological_order\fP () override"
.br
.ti -1c
.RI "std::vector< std::string > \fBgetNotes\fP () const override"
.br
.ti -1c
.RI "std::string \fBdump_cpt\fP () const override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "std::vector< std::string > & \fBgetValidHyperparameters\fP ()"
.br
.in -1c
.SS "Protected Member Functions"
.in +1c
.ti -1c
.RI "void \fBbuildModel\fP (const torch::Tensor &weights) override"
.br
.in -1c
Protected Member Functions inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "void \fBcheckFitParameters\fP ()"
.br
.ti -1c
.RI "void \fBtrainModel\fP (const torch::Tensor &weights) override"
.br
.ti -1c
.RI "void \fBbuildDataset\fP (torch::Tensor &y)"
.br
.in -1c
.SS "Additional Inherited Members"
Protected Attributes inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "bool \fBfitted\fP"
.br
.ti -1c
.RI "unsigned int \fBm\fP"
.br
.ti -1c
.RI "unsigned int \fBn\fP"
.br
.ti -1c
.RI "\fBNetwork\fP \fBmodel\fP"
.br
.ti -1c
.RI "Metrics \fBmetrics\fP"
.br
.ti -1c
.RI "std::vector< std::string > \fBfeatures\fP"
.br
.ti -1c
.RI "std::string \fBclassName\fP"
.br
.ti -1c
.RI "std::map< std::string, std::vector< int > > \fBstates\fP"
.br
.ti -1c
.RI "torch::Tensor \fBdataset\fP"
.br
.ti -1c
.RI "status_t \fBstatus\fP = NORMAL"
.br
.ti -1c
.RI "std::vector< std::string > \fBnotes\fP"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "std::vector< std::string > \fBvalidHyperparameters\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
Definition at line \fB13\fP of file \fBKDB\&.h\fP\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "bayesnet::KDB::KDB (int k, float theta = \fR0\&.03\fP)\fR [explicit]\fP"
.PP
Definition at line \fB10\fP of file \fBKDB\&.cc\fP\&.
.SH "Member Function Documentation"
.PP
.SS "void bayesnet::KDB::buildModel (const torch::Tensor & weights)\fR [override]\fP, \fR [protected]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::Classifier\fP\&.
.PP
Definition at line \fB28\fP of file \fBKDB\&.cc\fP\&.
.SS "std::vector< std::string > bayesnet::KDB::graph (const std::string & name = \fR'KDB'\fP) const\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB103\fP of file \fBKDB\&.cc\fP\&.
.SS "void bayesnet::KDB::setHyperparameters (const nlohmann::json & hyperparameters_)\fR [override]\fP, \fR [virtual]\fP"
.PP
Reimplemented from \fBbayesnet::Classifier\fP\&.
.PP
Definition at line \fB15\fP of file \fBKDB\&.cc\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for BayesNet from the source code\&.

254
docs/man3/bayesnet_KDBLd.3 Normal file
View File

@@ -0,0 +1,254 @@
.TH "bayesnet::KDBLd" 3 "Version 1.0.5" "BayesNet" \" -*- nroff -*-
.ad l
.nh
.SH NAME
bayesnet::KDBLd
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBbayesnet::KDB\fP, and \fBbayesnet::Proposal\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBKDBLd\fP (int k)"
.br
.ti -1c
.RI "\fBKDBLd\fP & \fBfit\fP (torch::Tensor &X, torch::Tensor &y, const std::vector< std::string > &features, const std::string &className, map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "std::vector< std::string > \fBgraph\fP (const std::string &name='KDB') const override"
.br
.ti -1c
.RI "torch::Tensor \fBpredict\fP (torch::Tensor &X) override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::KDB\fP
.in +1c
.ti -1c
.RI "\fBKDB\fP (int k, float theta=0\&.03)"
.br
.ti -1c
.RI "void \fBsetHyperparameters\fP (const nlohmann::json &hyperparameters_) override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "\fBClassifier\fP (\fBNetwork\fP model)"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (std::vector< std::vector< int > > &X, std::vector< int > &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &X, torch::Tensor &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states, const torch::Tensor &weights) override"
.br
.ti -1c
.RI "void \fBaddNodes\fP ()"
.br
.ti -1c
.RI "int \fBgetNumberOfNodes\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfEdges\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfStates\fP () const override"
.br
.ti -1c
.RI "int \fBgetClassNumStates\fP () const override"
.br
.ti -1c
.RI "std::vector< int > \fBpredict\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "torch::Tensor \fBpredict_proba\fP (torch::Tensor &X) override"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_proba\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "status_t \fBgetStatus\fP () const override"
.br
.ti -1c
.RI "std::string \fBgetVersion\fP () override"
.br
.ti -1c
.RI "float \fBscore\fP (torch::Tensor &X, torch::Tensor &y) override"
.br
.ti -1c
.RI "float \fBscore\fP (std::vector< std::vector< int > > &X, std::vector< int > &y) override"
.br
.ti -1c
.RI "std::vector< std::string > \fBshow\fP () const override"
.br
.ti -1c
.RI "std::vector< std::string > \fBtopological_order\fP () override"
.br
.ti -1c
.RI "std::vector< std::string > \fBgetNotes\fP () const override"
.br
.ti -1c
.RI "std::string \fBdump_cpt\fP () const override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "std::vector< std::string > & \fBgetValidHyperparameters\fP ()"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::Proposal\fP
.in +1c
.ti -1c
.RI "\fBProposal\fP (torch::Tensor &pDataset, std::vector< std::string > &features_, std::string &className_)"
.br
.in -1c
.SS "Static Public Member Functions"
.in +1c
.ti -1c
.RI "static std::string \fBversion\fP ()"
.br
.in -1c
.SS "Additional Inherited Members"
Protected Member Functions inherited from \fBbayesnet::KDB\fP
.in +1c
.ti -1c
.RI "void \fBbuildModel\fP (const torch::Tensor &weights) override"
.br
.in -1c
Protected Member Functions inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "void \fBcheckFitParameters\fP ()"
.br
.ti -1c
.RI "void \fBtrainModel\fP (const torch::Tensor &weights) override"
.br
.ti -1c
.RI "void \fBbuildDataset\fP (torch::Tensor &y)"
.br
.in -1c
Protected Member Functions inherited from \fBbayesnet::Proposal\fP
.in +1c
.ti -1c
.RI "void \fBcheckInput\fP (const torch::Tensor &X, const torch::Tensor &y)"
.br
.ti -1c
.RI "torch::Tensor \fBprepareX\fP (torch::Tensor &X)"
.br
.ti -1c
.RI "map< std::string, std::vector< int > > \fBlocalDiscretizationProposal\fP (const map< std::string, std::vector< int > > &states, \fBNetwork\fP &model)"
.br
.ti -1c
.RI "map< std::string, std::vector< int > > \fBfit_local_discretization\fP (const torch::Tensor &y)"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "bool \fBfitted\fP"
.br
.ti -1c
.RI "unsigned int \fBm\fP"
.br
.ti -1c
.RI "unsigned int \fBn\fP"
.br
.ti -1c
.RI "\fBNetwork\fP \fBmodel\fP"
.br
.ti -1c
.RI "Metrics \fBmetrics\fP"
.br
.ti -1c
.RI "std::vector< std::string > \fBfeatures\fP"
.br
.ti -1c
.RI "std::string \fBclassName\fP"
.br
.ti -1c
.RI "std::map< std::string, std::vector< int > > \fBstates\fP"
.br
.ti -1c
.RI "torch::Tensor \fBdataset\fP"
.br
.ti -1c
.RI "status_t \fBstatus\fP = NORMAL"
.br
.ti -1c
.RI "std::vector< std::string > \fBnotes\fP"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "std::vector< std::string > \fBvalidHyperparameters\fP"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::Proposal\fP
.in +1c
.ti -1c
.RI "torch::Tensor \fBXf\fP"
.br
.ti -1c
.RI "torch::Tensor \fBy\fP"
.br
.ti -1c
.RI "map< std::string, mdlp::CPPFImdlp * > \fBdiscretizers\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
Definition at line \fB13\fP of file \fBKDBLd\&.h\fP\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "bayesnet::KDBLd::KDBLd (int k)\fR [explicit]\fP"
.PP
Definition at line \fB10\fP of file \fBKDBLd\&.cc\fP\&.
.SH "Member Function Documentation"
.PP
.SS "\fBKDBLd\fP & bayesnet::KDBLd::fit (torch::Tensor & X, torch::Tensor & y, const std::vector< std::string > & features, const std::string & className, map< std::string, std::vector< int > > & states)\fR [override]\fP"
.PP
Definition at line \fB11\fP of file \fBKDBLd\&.cc\fP\&.
.SS "std::vector< std::string > bayesnet::KDBLd::graph (const std::string & name = \fR'KDB'\fP) const\fR [override]\fP, \fR [virtual]\fP"
.PP
Reimplemented from \fBbayesnet::KDB\fP\&.
.PP
Definition at line \fB31\fP of file \fBKDBLd\&.cc\fP\&.
.SS "torch::Tensor bayesnet::KDBLd::predict (torch::Tensor & X)\fR [override]\fP, \fR [virtual]\fP"
.PP
Reimplemented from \fBbayesnet::Classifier\fP\&.
.PP
Definition at line \fB26\fP of file \fBKDBLd\&.cc\fP\&.
.SS "static std::string bayesnet::KDBLd::version ()\fR [inline]\fP, \fR [static]\fP"
.PP
Definition at line \fB21\fP of file \fBKDBLd\&.h\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for BayesNet from the source code\&.

223
docs/man3/bayesnet_Network.3 Normal file
View File

@@ -0,0 +1,223 @@
.TH "bayesnet::Network" 3 "Version 1.0.5" "BayesNet" \" -*- nroff -*-
.ad l
.nh
.SH NAME
bayesnet::Network
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBNetwork\fP (float)"
.br
.ti -1c
.RI "\fBNetwork\fP (const \fBNetwork\fP &)"
.br
.ti -1c
.RI "torch::Tensor & \fBgetSamples\fP ()"
.br
.ti -1c
.RI "float \fBgetMaxThreads\fP () const"
.br
.ti -1c
.RI "void \fBaddNode\fP (const std::string &)"
.br
.ti -1c
.RI "void \fBaddEdge\fP (const std::string &, const std::string &)"
.br
.ti -1c
.RI "std::map< std::string, std::unique_ptr< \fBNode\fP > > & \fBgetNodes\fP ()"
.br
.ti -1c
.RI "std::vector< std::string > \fBgetFeatures\fP () const"
.br
.ti -1c
.RI "int \fBgetStates\fP () const"
.br
.ti -1c
.RI "std::vector< std::pair< std::string, std::string > > \fBgetEdges\fP () const"
.br
.ti -1c
.RI "int \fBgetNumEdges\fP () const"
.br
.ti -1c
.RI "int \fBgetClassNumStates\fP () const"
.br
.ti -1c
.RI "std::string \fBgetClassName\fP () const"
.br
.ti -1c
.RI "void \fBfit\fP (const std::vector< std::vector< int > > &input_data, const std::vector< int > &labels, const std::vector< double > &weights, const std::vector< std::string > &featureNames, const std::string &className, const std::map< std::string, std::vector< int > > &states)"
.br
.ti -1c
.RI "void \fBfit\fP (const torch::Tensor &X, const torch::Tensor &y, const torch::Tensor &weights, const std::vector< std::string > &featureNames, const std::string &className, const std::map< std::string, std::vector< int > > &states)"
.br
.ti -1c
.RI "void \fBfit\fP (const torch::Tensor &samples, const torch::Tensor &weights, const std::vector< std::string > &featureNames, const std::string &className, const std::map< std::string, std::vector< int > > &states)"
.br
.ti -1c
.RI "std::vector< int > \fBpredict\fP (const std::vector< std::vector< int > > &)"
.br
.ti -1c
.RI "torch::Tensor \fBpredict\fP (const torch::Tensor &)"
.br
.ti -1c
.RI "torch::Tensor \fBpredict_tensor\fP (const torch::Tensor &samples, const bool proba)"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_proba\fP (const std::vector< std::vector< int > > &)"
.br
.ti -1c
.RI "torch::Tensor \fBpredict_proba\fP (const torch::Tensor &)"
.br
.ti -1c
.RI "double \fBscore\fP (const std::vector< std::vector< int > > &, const std::vector< int > &)"
.br
.ti -1c
.RI "std::vector< std::string > \fBtopological_sort\fP ()"
.br
.ti -1c
.RI "std::vector< std::string > \fBshow\fP () const"
.br
.ti -1c
.RI "std::vector< std::string > \fBgraph\fP (const std::string &title) const"
.br
.ti -1c
.RI "void \fBinitialize\fP ()"
.br
.ti -1c
.RI "std::string \fBdump_cpt\fP () const"
.br
.ti -1c
.RI "std::string \fBversion\fP ()"
.br
.in -1c
.SH "Detailed Description"
.PP
Definition at line \fB15\fP of file \fBNetwork\&.h\fP\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "bayesnet::Network::Network ()"
.PP
Definition at line \fB13\fP of file \fBNetwork\&.cc\fP\&.
.SS "bayesnet::Network::Network (float maxT)\fR [explicit]\fP"
.PP
Definition at line \fB16\fP of file \fBNetwork\&.cc\fP\&.
.SS "bayesnet::Network::Network (const \fBNetwork\fP & other)\fR [explicit]\fP"
.PP
Definition at line \fB20\fP of file \fBNetwork\&.cc\fP\&.
.SH "Member Function Documentation"
.PP
.SS "void bayesnet::Network::addEdge (const std::string & parent, const std::string & child)"
.PP
Definition at line \fB95\fP of file \fBNetwork\&.cc\fP\&.
.SS "void bayesnet::Network::addNode (const std::string & name)"
.PP
Definition at line \fB46\fP of file \fBNetwork\&.cc\fP\&.
.SS "std::string bayesnet::Network::dump_cpt () const"
.PP
Definition at line \fB420\fP of file \fBNetwork\&.cc\fP\&.
.SS "void bayesnet::Network::fit (const std::vector< std::vector< int > > & input_data, const std::vector< int > & labels, const std::vector< double > & weights, const std::vector< std::string > & featureNames, const std::string & className, const std::map< std::string, std::vector< int > > & states)"
.PP
Definition at line \fB177\fP of file \fBNetwork\&.cc\fP\&.
.SS "void bayesnet::Network::fit (const torch::Tensor & samples, const torch::Tensor & weights, const std::vector< std::string > & featureNames, const std::string & className, const std::map< std::string, std::vector< int > > & states)"
.PP
Definition at line \fB169\fP of file \fBNetwork\&.cc\fP\&.
.SS "void bayesnet::Network::fit (const torch::Tensor & X, const torch::Tensor & y, const torch::Tensor & weights, const std::vector< std::string > & featureNames, const std::string & className, const std::map< std::string, std::vector< int > > & states)"
.PP
Definition at line \fB158\fP of file \fBNetwork\&.cc\fP\&.
.SS "std::string bayesnet::Network::getClassName () const"
.PP
Definition at line \fB75\fP of file \fBNetwork\&.cc\fP\&.
.SS "int bayesnet::Network::getClassNumStates () const"
.PP
Definition at line \fB63\fP of file \fBNetwork\&.cc\fP\&.
.SS "std::vector< std::pair< std::string, std::string > > bayesnet::Network::getEdges () const"
.PP
Definition at line \fB371\fP of file \fBNetwork\&.cc\fP\&.
.SS "std::vector< std::string > bayesnet::Network::getFeatures () const"
.PP
Definition at line \fB59\fP of file \fBNetwork\&.cc\fP\&.
.SS "float bayesnet::Network::getMaxThreads () const"
.PP
Definition at line \fB38\fP of file \fBNetwork\&.cc\fP\&.
.SS "std::map< std::string, std::unique_ptr< \fBNode\fP > > & bayesnet::Network::getNodes ()"
.PP
Definition at line \fB116\fP of file \fBNetwork\&.cc\fP\&.
.SS "int bayesnet::Network::getNumEdges () const"
.PP
Definition at line \fB383\fP of file \fBNetwork\&.cc\fP\&.
.SS "torch::Tensor & bayesnet::Network::getSamples ()"
.PP
Definition at line \fB42\fP of file \fBNetwork\&.cc\fP\&.
.SS "int bayesnet::Network::getStates () const"
.PP
Definition at line \fB67\fP of file \fBNetwork\&.cc\fP\&.
.SS "std::vector< std::string > bayesnet::Network::graph (const std::string & title) const"
.PP
Definition at line \fB357\fP of file \fBNetwork\&.cc\fP\&.
.SS "void bayesnet::Network::initialize ()"
.PP
Definition at line \fB29\fP of file \fBNetwork\&.cc\fP\&.
.SS "std::vector< int > bayesnet::Network::predict (const std::vector< std::vector< int > > & tsamples)"
.PP
Definition at line \fB237\fP of file \fBNetwork\&.cc\fP\&.
.SS "torch::Tensor bayesnet::Network::predict (const torch::Tensor & samples)"
.PP
Definition at line \fB230\fP of file \fBNetwork\&.cc\fP\&.
.SS "std::vector< std::vector< double > > bayesnet::Network::predict_proba (const std::vector< std::vector< int > > & tsamples)"
.PP
Definition at line \fB259\fP of file \fBNetwork\&.cc\fP\&.
.SS "torch::Tensor bayesnet::Network::predict_proba (const torch::Tensor & samples)"
.PP
Definition at line \fB224\fP of file \fBNetwork\&.cc\fP\&.
.SS "torch::Tensor bayesnet::Network::predict_tensor (const torch::Tensor & samples, const bool proba)"
.PP
Definition at line \fB205\fP of file \fBNetwork\&.cc\fP\&.
.SS "double bayesnet::Network::score (const std::vector< std::vector< int > > & tsamples, const std::vector< int > & labels)"
.PP
Definition at line \fB275\fP of file \fBNetwork\&.cc\fP\&.
.SS "std::vector< std::string > bayesnet::Network::show () const"
.PP
Definition at line \fB344\fP of file \fBNetwork\&.cc\fP\&.
.SS "std::vector< std::string > bayesnet::Network::topological_sort ()"
.PP
Definition at line \fB387\fP of file \fBNetwork\&.cc\fP\&.
.SS "std::string bayesnet::Network::version ()\fR [inline]\fP"
.PP
Definition at line \fB49\fP of file \fBNetwork\&.h\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for BayesNet from the source code\&.

135
docs/man3/bayesnet_Node.3 Normal file
View File

@@ -0,0 +1,135 @@
.TH "bayesnet::Node" 3 "Version 1.0.5" "BayesNet" \" -*- nroff -*-
.ad l
.nh
.SH NAME
bayesnet::Node
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBNode\fP (const std::string &)"
.br
.ti -1c
.RI "void \fBclear\fP ()"
.br
.ti -1c
.RI "void \fBaddParent\fP (\fBNode\fP *)"
.br
.ti -1c
.RI "void \fBaddChild\fP (\fBNode\fP *)"
.br
.ti -1c
.RI "void \fBremoveParent\fP (\fBNode\fP *)"
.br
.ti -1c
.RI "void \fBremoveChild\fP (\fBNode\fP *)"
.br
.ti -1c
.RI "std::string \fBgetName\fP () const"
.br
.ti -1c
.RI "std::vector< \fBNode\fP * > & \fBgetParents\fP ()"
.br
.ti -1c
.RI "std::vector< \fBNode\fP * > & \fBgetChildren\fP ()"
.br
.ti -1c
.RI "torch::Tensor & \fBgetCPT\fP ()"
.br
.ti -1c
.RI "void \fBcomputeCPT\fP (const torch::Tensor &dataset, const std::vector< std::string > &features, const double laplaceSmoothing, const torch::Tensor &weights)"
.br
.ti -1c
.RI "int \fBgetNumStates\fP () const"
.br
.ti -1c
.RI "void \fBsetNumStates\fP (int)"
.br
.ti -1c
.RI "unsigned \fBminFill\fP ()"
.br
.ti -1c
.RI "std::vector< std::string > \fBgraph\fP (const std::string &clasName)"
.br
.ti -1c
.RI "float \fBgetFactorValue\fP (std::map< std::string, int > &)"
.br
.in -1c
.SH "Detailed Description"
.PP
Definition at line \fB14\fP of file \fBNode\&.h\fP\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "bayesnet::Node::Node (const std::string & name)\fR [explicit]\fP"
.PP
Definition at line \fB11\fP of file \fBNode\&.cc\fP\&.
.SH "Member Function Documentation"
.PP
.SS "void bayesnet::Node::addChild (\fBNode\fP * child)"
.PP
Definition at line \fB39\fP of file \fBNode\&.cc\fP\&.
.SS "void bayesnet::Node::addParent (\fBNode\fP * parent)"
.PP
Definition at line \fB27\fP of file \fBNode\&.cc\fP\&.
.SS "void bayesnet::Node::clear ()"
.PP
Definition at line \fB15\fP of file \fBNode\&.cc\fP\&.
.SS "void bayesnet::Node::computeCPT (const torch::Tensor & dataset, const std::vector< std::string > & features, const double laplaceSmoothing, const torch::Tensor & weights)"
.PP
Definition at line \fB93\fP of file \fBNode\&.cc\fP\&.
.SS "std::vector< \fBNode\fP * > & bayesnet::Node::getChildren ()"
.PP
Definition at line \fB47\fP of file \fBNode\&.cc\fP\&.
.SS "torch::Tensor & bayesnet::Node::getCPT ()"
.PP
Definition at line \fB59\fP of file \fBNode\&.cc\fP\&.
.SS "float bayesnet::Node::getFactorValue (std::map< std::string, int > & evidence)"
.PP
Definition at line \fB124\fP of file \fBNode\&.cc\fP\&.
.SS "std::string bayesnet::Node::getName () const"
.PP
Definition at line \fB23\fP of file \fBNode\&.cc\fP\&.
.SS "int bayesnet::Node::getNumStates () const"
.PP
Definition at line \fB51\fP of file \fBNode\&.cc\fP\&.
.SS "std::vector< \fBNode\fP * > & bayesnet::Node::getParents ()"
.PP
Definition at line \fB43\fP of file \fBNode\&.cc\fP\&.
.SS "std::vector< std::string > bayesnet::Node::graph (const std::string & clasName)"
.PP
Definition at line \fB132\fP of file \fBNode\&.cc\fP\&.
.SS "unsigned bayesnet::Node::minFill ()"
.PP
Definition at line \fB70\fP of file \fBNode\&.cc\fP\&.
.SS "void bayesnet::Node::removeChild (\fBNode\fP * child)"
.PP
Definition at line \fB35\fP of file \fBNode\&.cc\fP\&.
.SS "void bayesnet::Node::removeParent (\fBNode\fP * parent)"
.PP
Definition at line \fB31\fP of file \fBNode\&.cc\fP\&.
.SS "void bayesnet::Node::setNumStates (int numStates)"
.PP
Definition at line \fB55\fP of file \fBNode\&.cc\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for BayesNet from the source code\&.

95
docs/man3/bayesnet_Proposal.3 Normal file
View File

@@ -0,0 +1,95 @@
.TH "bayesnet::Proposal" 3 "Version 1.0.5" "BayesNet" \" -*- nroff -*-
.ad l
.nh
.SH NAME
bayesnet::Proposal
.SH SYNOPSIS
.br
.PP
.PP
Inherited by \fBbayesnet::AODELd\fP, \fBbayesnet::KDBLd\fP, \fBbayesnet::SPODELd\fP, and \fBbayesnet::TANLd\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBProposal\fP (torch::Tensor &pDataset, std::vector< std::string > &features_, std::string &className_)"
.br
.in -1c
.SS "Protected Member Functions"
.in +1c
.ti -1c
.RI "void \fBcheckInput\fP (const torch::Tensor &X, const torch::Tensor &y)"
.br
.ti -1c
.RI "torch::Tensor \fBprepareX\fP (torch::Tensor &X)"
.br
.ti -1c
.RI "map< std::string, std::vector< int > > \fBlocalDiscretizationProposal\fP (const map< std::string, std::vector< int > > &states, \fBNetwork\fP &model)"
.br
.ti -1c
.RI "map< std::string, std::vector< int > > \fBfit_local_discretization\fP (const torch::Tensor &y)"
.br
.in -1c
.SS "Protected Attributes"
.in +1c
.ti -1c
.RI "torch::Tensor \fBXf\fP"
.br
.ti -1c
.RI "torch::Tensor \fBy\fP"
.br
.ti -1c
.RI "map< std::string, mdlp::CPPFImdlp * > \fBdiscretizers\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
Definition at line \fB17\fP of file \fBProposal\&.h\fP\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "bayesnet::Proposal::Proposal (torch::Tensor & pDataset, std::vector< std::string > & features_, std::string & className_)"
.PP
Definition at line \fB10\fP of file \fBProposal\&.cc\fP\&.
.SS "bayesnet::Proposal::~Proposal ()\fR [virtual]\fP"
.PP
Definition at line \fB11\fP of file \fBProposal\&.cc\fP\&.
.SH "Member Function Documentation"
.PP
.SS "void bayesnet::Proposal::checkInput (const torch::Tensor & X, const torch::Tensor & y)\fR [protected]\fP"
.PP
Definition at line \fB17\fP of file \fBProposal\&.cc\fP\&.
.SS "map< std::string, std::vector< int > > bayesnet::Proposal::fit_local_discretization (const torch::Tensor & y)\fR [protected]\fP"
.PP
Definition at line \fB77\fP of file \fBProposal\&.cc\fP\&.
.SS "map< std::string, std::vector< int > > bayesnet::Proposal::localDiscretizationProposal (const map< std::string, std::vector< int > > & states, \fBNetwork\fP & model)\fR [protected]\fP"
.PP
Definition at line \fB26\fP of file \fBProposal\&.cc\fP\&.
.SS "torch::Tensor bayesnet::Proposal::prepareX (torch::Tensor & X)\fR [protected]\fP"
.PP
Definition at line \fB104\fP of file \fBProposal\&.cc\fP\&.
.SH "Member Data Documentation"
.PP
.SS "map<std::string, mdlp::CPPFImdlp*> bayesnet::Proposal::discretizers\fR [protected]\fP"
.PP
Definition at line \fB28\fP of file \fBProposal\&.h\fP\&.
.SS "torch::Tensor bayesnet::Proposal::Xf\fR [protected]\fP"
.PP
Definition at line \fB26\fP of file \fBProposal\&.h\fP\&.
.SS "torch::Tensor bayesnet::Proposal::y\fR [protected]\fP"
.PP
Definition at line \fB27\fP of file \fBProposal\&.h\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for BayesNet from the source code\&.

195
docs/man3/bayesnet_SPODE.3 Normal file
View File

@@ -0,0 +1,195 @@
.TH "bayesnet::SPODE" 3 "Version 1.0.5" "BayesNet" \" -*- nroff -*-
.ad l
.nh
.SH NAME
bayesnet::SPODE
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBbayesnet::Classifier\fP\&.
.PP
Inherited by \fBbayesnet::SPODELd\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBSPODE\fP (int root)"
.br
.ti -1c
.RI "std::vector< std::string > \fBgraph\fP (const std::string &name='SPODE') const override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "\fBClassifier\fP (\fBNetwork\fP model)"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (std::vector< std::vector< int > > &X, std::vector< int > &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &X, torch::Tensor &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states, const torch::Tensor &weights) override"
.br
.ti -1c
.RI "void \fBaddNodes\fP ()"
.br
.ti -1c
.RI "int \fBgetNumberOfNodes\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfEdges\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfStates\fP () const override"
.br
.ti -1c
.RI "int \fBgetClassNumStates\fP () const override"
.br
.ti -1c
.RI "torch::Tensor \fBpredict\fP (torch::Tensor &X) override"
.br
.ti -1c
.RI "std::vector< int > \fBpredict\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "torch::Tensor \fBpredict_proba\fP (torch::Tensor &X) override"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_proba\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "status_t \fBgetStatus\fP () const override"
.br
.ti -1c
.RI "std::string \fBgetVersion\fP () override"
.br
.ti -1c
.RI "float \fBscore\fP (torch::Tensor &X, torch::Tensor &y) override"
.br
.ti -1c
.RI "float \fBscore\fP (std::vector< std::vector< int > > &X, std::vector< int > &y) override"
.br
.ti -1c
.RI "std::vector< std::string > \fBshow\fP () const override"
.br
.ti -1c
.RI "std::vector< std::string > \fBtopological_order\fP () override"
.br
.ti -1c
.RI "std::vector< std::string > \fBgetNotes\fP () const override"
.br
.ti -1c
.RI "std::string \fBdump_cpt\fP () const override"
.br
.ti -1c
.RI "void \fBsetHyperparameters\fP (const nlohmann::json &hyperparameters) override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "std::vector< std::string > & \fBgetValidHyperparameters\fP ()"
.br
.in -1c
.SS "Protected Member Functions"
.in +1c
.ti -1c
.RI "void \fBbuildModel\fP (const torch::Tensor &weights) override"
.br
.in -1c
Protected Member Functions inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "void \fBcheckFitParameters\fP ()"
.br
.ti -1c
.RI "void \fBtrainModel\fP (const torch::Tensor &weights) override"
.br
.ti -1c
.RI "void \fBbuildDataset\fP (torch::Tensor &y)"
.br
.in -1c
.SS "Additional Inherited Members"
Protected Attributes inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "bool \fBfitted\fP"
.br
.ti -1c
.RI "unsigned int \fBm\fP"
.br
.ti -1c
.RI "unsigned int \fBn\fP"
.br
.ti -1c
.RI "\fBNetwork\fP \fBmodel\fP"
.br
.ti -1c
.RI "Metrics \fBmetrics\fP"
.br
.ti -1c
.RI "std::vector< std::string > \fBfeatures\fP"
.br
.ti -1c
.RI "std::string \fBclassName\fP"
.br
.ti -1c
.RI "std::map< std::string, std::vector< int > > \fBstates\fP"
.br
.ti -1c
.RI "torch::Tensor \fBdataset\fP"
.br
.ti -1c
.RI "status_t \fBstatus\fP = NORMAL"
.br
.ti -1c
.RI "std::vector< std::string > \fBnotes\fP"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "std::vector< std::string > \fBvalidHyperparameters\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
Definition at line \fB12\fP of file \fBSPODE\&.h\fP\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "bayesnet::SPODE::SPODE (int root)\fR [explicit]\fP"
.PP
Definition at line \fB11\fP of file \fBSPODE\&.cc\fP\&.
.SH "Member Function Documentation"
.PP
.SS "void bayesnet::SPODE::buildModel (const torch::Tensor & weights)\fR [override]\fP, \fR [protected]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::Classifier\fP\&.
.PP
Definition at line \fB13\fP of file \fBSPODE\&.cc\fP\&.
.SS "std::vector< std::string > bayesnet::SPODE::graph (const std::string & name = \fR'SPODE'\fP) const\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB26\fP of file \fBSPODE\&.cc\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for BayesNet from the source code\&.

268
docs/man3/bayesnet_SPODELd.3 Normal file
View File

@@ -0,0 +1,268 @@
.TH "bayesnet::SPODELd" 3 "Version 1.0.5" "BayesNet" \" -*- nroff -*-
.ad l
.nh
.SH NAME
bayesnet::SPODELd
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBbayesnet::SPODE\fP, and \fBbayesnet::Proposal\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBSPODELd\fP (int root)"
.br
.ti -1c
.RI "\fBSPODELd\fP & \fBfit\fP (torch::Tensor &X, torch::Tensor &y, const std::vector< std::string > &features, const std::string &className, map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBSPODELd\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBSPODELd\fP & \fBcommonFit\fP (const std::vector< std::string > &features, const std::string &className, map< std::string, std::vector< int > > &states)"
.br
.ti -1c
.RI "std::vector< std::string > \fBgraph\fP (const std::string &name='SPODE') const override"
.br
.ti -1c
.RI "torch::Tensor \fBpredict\fP (torch::Tensor &X) override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::SPODE\fP
.in +1c
.ti -1c
.RI "\fBSPODE\fP (int root)"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "\fBClassifier\fP (\fBNetwork\fP model)"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (std::vector< std::vector< int > > &X, std::vector< int > &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &X, torch::Tensor &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states, const torch::Tensor &weights) override"
.br
.ti -1c
.RI "void \fBaddNodes\fP ()"
.br
.ti -1c
.RI "int \fBgetNumberOfNodes\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfEdges\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfStates\fP () const override"
.br
.ti -1c
.RI "int \fBgetClassNumStates\fP () const override"
.br
.ti -1c
.RI "std::vector< int > \fBpredict\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "torch::Tensor \fBpredict_proba\fP (torch::Tensor &X) override"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_proba\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "status_t \fBgetStatus\fP () const override"
.br
.ti -1c
.RI "std::string \fBgetVersion\fP () override"
.br
.ti -1c
.RI "float \fBscore\fP (torch::Tensor &X, torch::Tensor &y) override"
.br
.ti -1c
.RI "float \fBscore\fP (std::vector< std::vector< int > > &X, std::vector< int > &y) override"
.br
.ti -1c
.RI "std::vector< std::string > \fBshow\fP () const override"
.br
.ti -1c
.RI "std::vector< std::string > \fBtopological_order\fP () override"
.br
.ti -1c
.RI "std::vector< std::string > \fBgetNotes\fP () const override"
.br
.ti -1c
.RI "std::string \fBdump_cpt\fP () const override"
.br
.ti -1c
.RI "void \fBsetHyperparameters\fP (const nlohmann::json &hyperparameters) override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "std::vector< std::string > & \fBgetValidHyperparameters\fP ()"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::Proposal\fP
.in +1c
.ti -1c
.RI "\fBProposal\fP (torch::Tensor &pDataset, std::vector< std::string > &features_, std::string &className_)"
.br
.in -1c
.SS "Static Public Member Functions"
.in +1c
.ti -1c
.RI "static std::string \fBversion\fP ()"
.br
.in -1c
.SS "Additional Inherited Members"
Protected Member Functions inherited from \fBbayesnet::SPODE\fP
.in +1c
.ti -1c
.RI "void \fBbuildModel\fP (const torch::Tensor &weights) override"
.br
.in -1c
Protected Member Functions inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "void \fBcheckFitParameters\fP ()"
.br
.ti -1c
.RI "void \fBtrainModel\fP (const torch::Tensor &weights) override"
.br
.ti -1c
.RI "void \fBbuildDataset\fP (torch::Tensor &y)"
.br
.in -1c
Protected Member Functions inherited from \fBbayesnet::Proposal\fP
.in +1c
.ti -1c
.RI "void \fBcheckInput\fP (const torch::Tensor &X, const torch::Tensor &y)"
.br
.ti -1c
.RI "torch::Tensor \fBprepareX\fP (torch::Tensor &X)"
.br
.ti -1c
.RI "map< std::string, std::vector< int > > \fBlocalDiscretizationProposal\fP (const map< std::string, std::vector< int > > &states, \fBNetwork\fP &model)"
.br
.ti -1c
.RI "map< std::string, std::vector< int > > \fBfit_local_discretization\fP (const torch::Tensor &y)"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "bool \fBfitted\fP"
.br
.ti -1c
.RI "unsigned int \fBm\fP"
.br
.ti -1c
.RI "unsigned int \fBn\fP"
.br
.ti -1c
.RI "\fBNetwork\fP \fBmodel\fP"
.br
.ti -1c
.RI "Metrics \fBmetrics\fP"
.br
.ti -1c
.RI "std::vector< std::string > \fBfeatures\fP"
.br
.ti -1c
.RI "std::string \fBclassName\fP"
.br
.ti -1c
.RI "std::map< std::string, std::vector< int > > \fBstates\fP"
.br
.ti -1c
.RI "torch::Tensor \fBdataset\fP"
.br
.ti -1c
.RI "status_t \fBstatus\fP = NORMAL"
.br
.ti -1c
.RI "std::vector< std::string > \fBnotes\fP"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "std::vector< std::string > \fBvalidHyperparameters\fP"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::Proposal\fP
.in +1c
.ti -1c
.RI "torch::Tensor \fBXf\fP"
.br
.ti -1c
.RI "torch::Tensor \fBy\fP"
.br
.ti -1c
.RI "map< std::string, mdlp::CPPFImdlp * > \fBdiscretizers\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
Definition at line \fB13\fP of file \fBSPODELd\&.h\fP\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "bayesnet::SPODELd::SPODELd (int root)\fR [explicit]\fP"
.PP
Definition at line \fB10\fP of file \fBSPODELd\&.cc\fP\&.
.SH "Member Function Documentation"
.PP
.SS "\fBSPODELd\fP & bayesnet::SPODELd::commonFit (const std::vector< std::string > & features, const std::string & className, map< std::string, std::vector< int > > & states)"
.PP
Definition at line \fB29\fP of file \fBSPODELd\&.cc\fP\&.
.SS "\fBSPODELd\fP & bayesnet::SPODELd::fit (torch::Tensor & dataset, const std::vector< std::string > & features, const std::string & className, map< std::string, std::vector< int > > & states)\fR [override]\fP"
.PP
Definition at line \fB19\fP of file \fBSPODELd\&.cc\fP\&.
.SS "\fBSPODELd\fP & bayesnet::SPODELd::fit (torch::Tensor & X, torch::Tensor & y, const std::vector< std::string > & features, const std::string & className, map< std::string, std::vector< int > > & states)\fR [override]\fP"
.PP
Definition at line \fB11\fP of file \fBSPODELd\&.cc\fP\&.
.SS "std::vector< std::string > bayesnet::SPODELd::graph (const std::string & name = \fR'SPODE'\fP) const\fR [override]\fP, \fR [virtual]\fP"
.PP
Reimplemented from \fBbayesnet::SPODE\fP\&.
.PP
Definition at line \fB46\fP of file \fBSPODELd\&.cc\fP\&.
.SS "torch::Tensor bayesnet::SPODELd::predict (torch::Tensor & X)\fR [override]\fP, \fR [virtual]\fP"
.PP
Reimplemented from \fBbayesnet::Classifier\fP\&.
.PP
Definition at line \fB41\fP of file \fBSPODELd\&.cc\fP\&.
.SS "static std::string bayesnet::SPODELd::version ()\fR [inline]\fP, \fR [static]\fP"
.PP
Definition at line \fB22\fP of file \fBSPODELd\&.h\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for BayesNet from the source code\&.

193
docs/man3/bayesnet_SPnDE.3 Normal file
View File

@@ -0,0 +1,193 @@
.TH "bayesnet::SPnDE" 3 "Version 1.0.5" "BayesNet" \" -*- nroff -*-
.ad l
.nh
.SH NAME
bayesnet::SPnDE
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBbayesnet::Classifier\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBSPnDE\fP (std::vector< int > parents)"
.br
.ti -1c
.RI "std::vector< std::string > \fBgraph\fP (const std::string &name='SPnDE') const override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "\fBClassifier\fP (\fBNetwork\fP model)"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (std::vector< std::vector< int > > &X, std::vector< int > &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &X, torch::Tensor &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states, const torch::Tensor &weights) override"
.br
.ti -1c
.RI "void \fBaddNodes\fP ()"
.br
.ti -1c
.RI "int \fBgetNumberOfNodes\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfEdges\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfStates\fP () const override"
.br
.ti -1c
.RI "int \fBgetClassNumStates\fP () const override"
.br
.ti -1c
.RI "torch::Tensor \fBpredict\fP (torch::Tensor &X) override"
.br
.ti -1c
.RI "std::vector< int > \fBpredict\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "torch::Tensor \fBpredict_proba\fP (torch::Tensor &X) override"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_proba\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "status_t \fBgetStatus\fP () const override"
.br
.ti -1c
.RI "std::string \fBgetVersion\fP () override"
.br
.ti -1c
.RI "float \fBscore\fP (torch::Tensor &X, torch::Tensor &y) override"
.br
.ti -1c
.RI "float \fBscore\fP (std::vector< std::vector< int > > &X, std::vector< int > &y) override"
.br
.ti -1c
.RI "std::vector< std::string > \fBshow\fP () const override"
.br
.ti -1c
.RI "std::vector< std::string > \fBtopological_order\fP () override"
.br
.ti -1c
.RI "std::vector< std::string > \fBgetNotes\fP () const override"
.br
.ti -1c
.RI "std::string \fBdump_cpt\fP () const override"
.br
.ti -1c
.RI "void \fBsetHyperparameters\fP (const nlohmann::json &hyperparameters) override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "std::vector< std::string > & \fBgetValidHyperparameters\fP ()"
.br
.in -1c
.SS "Protected Member Functions"
.in +1c
.ti -1c
.RI "void \fBbuildModel\fP (const torch::Tensor &weights) override"
.br
.in -1c
Protected Member Functions inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "void \fBcheckFitParameters\fP ()"
.br
.ti -1c
.RI "void \fBtrainModel\fP (const torch::Tensor &weights) override"
.br
.ti -1c
.RI "void \fBbuildDataset\fP (torch::Tensor &y)"
.br
.in -1c
.SS "Additional Inherited Members"
Protected Attributes inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "bool \fBfitted\fP"
.br
.ti -1c
.RI "unsigned int \fBm\fP"
.br
.ti -1c
.RI "unsigned int \fBn\fP"
.br
.ti -1c
.RI "\fBNetwork\fP \fBmodel\fP"
.br
.ti -1c
.RI "Metrics \fBmetrics\fP"
.br
.ti -1c
.RI "std::vector< std::string > \fBfeatures\fP"
.br
.ti -1c
.RI "std::string \fBclassName\fP"
.br
.ti -1c
.RI "std::map< std::string, std::vector< int > > \fBstates\fP"
.br
.ti -1c
.RI "torch::Tensor \fBdataset\fP"
.br
.ti -1c
.RI "status_t \fBstatus\fP = NORMAL"
.br
.ti -1c
.RI "std::vector< std::string > \fBnotes\fP"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "std::vector< std::string > \fBvalidHyperparameters\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
Definition at line \fB13\fP of file \fBSPnDE\&.h\fP\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "bayesnet::SPnDE::SPnDE (std::vector< int > parents)\fR [explicit]\fP"
.PP
Definition at line \fB11\fP of file \fBSPnDE\&.cc\fP\&.
.SH "Member Function Documentation"
.PP
.SS "void bayesnet::SPnDE::buildModel (const torch::Tensor & weights)\fR [override]\fP, \fR [protected]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::Classifier\fP\&.
.PP
Definition at line \fB13\fP of file \fBSPnDE\&.cc\fP\&.
.SS "std::vector< std::string > bayesnet::SPnDE::graph (const std::string & name = \fR'SPnDE'\fP) const\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB33\fP of file \fBSPnDE\&.cc\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for BayesNet from the source code\&.

192
docs/man3/bayesnet_TAN.3 Normal file
View File

@@ -0,0 +1,192 @@
.TH "bayesnet::TAN" 3 "Version 1.0.5" "BayesNet" \" -*- nroff -*-
.ad l
.nh
.SH NAME
bayesnet::TAN
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBbayesnet::Classifier\fP\&.
.PP
Inherited by \fBbayesnet::TANLd\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "std::vector< std::string > \fBgraph\fP (const std::string &name='TAN') const override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "\fBClassifier\fP (\fBNetwork\fP model)"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (std::vector< std::vector< int > > &X, std::vector< int > &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &X, torch::Tensor &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states, const torch::Tensor &weights) override"
.br
.ti -1c
.RI "void \fBaddNodes\fP ()"
.br
.ti -1c
.RI "int \fBgetNumberOfNodes\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfEdges\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfStates\fP () const override"
.br
.ti -1c
.RI "int \fBgetClassNumStates\fP () const override"
.br
.ti -1c
.RI "torch::Tensor \fBpredict\fP (torch::Tensor &X) override"
.br
.ti -1c
.RI "std::vector< int > \fBpredict\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "torch::Tensor \fBpredict_proba\fP (torch::Tensor &X) override"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_proba\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "status_t \fBgetStatus\fP () const override"
.br
.ti -1c
.RI "std::string \fBgetVersion\fP () override"
.br
.ti -1c
.RI "float \fBscore\fP (torch::Tensor &X, torch::Tensor &y) override"
.br
.ti -1c
.RI "float \fBscore\fP (std::vector< std::vector< int > > &X, std::vector< int > &y) override"
.br
.ti -1c
.RI "std::vector< std::string > \fBshow\fP () const override"
.br
.ti -1c
.RI "std::vector< std::string > \fBtopological_order\fP () override"
.br
.ti -1c
.RI "std::vector< std::string > \fBgetNotes\fP () const override"
.br
.ti -1c
.RI "std::string \fBdump_cpt\fP () const override"
.br
.ti -1c
.RI "void \fBsetHyperparameters\fP (const nlohmann::json &hyperparameters) override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "std::vector< std::string > & \fBgetValidHyperparameters\fP ()"
.br
.in -1c
.SS "Protected Member Functions"
.in +1c
.ti -1c
.RI "void \fBbuildModel\fP (const torch::Tensor &weights) override"
.br
.in -1c
Protected Member Functions inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "void \fBcheckFitParameters\fP ()"
.br
.ti -1c
.RI "void \fBtrainModel\fP (const torch::Tensor &weights) override"
.br
.ti -1c
.RI "void \fBbuildDataset\fP (torch::Tensor &y)"
.br
.in -1c
.SS "Additional Inherited Members"
Protected Attributes inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "bool \fBfitted\fP"
.br
.ti -1c
.RI "unsigned int \fBm\fP"
.br
.ti -1c
.RI "unsigned int \fBn\fP"
.br
.ti -1c
.RI "\fBNetwork\fP \fBmodel\fP"
.br
.ti -1c
.RI "Metrics \fBmetrics\fP"
.br
.ti -1c
.RI "std::vector< std::string > \fBfeatures\fP"
.br
.ti -1c
.RI "std::string \fBclassName\fP"
.br
.ti -1c
.RI "std::map< std::string, std::vector< int > > \fBstates\fP"
.br
.ti -1c
.RI "torch::Tensor \fBdataset\fP"
.br
.ti -1c
.RI "status_t \fBstatus\fP = NORMAL"
.br
.ti -1c
.RI "std::vector< std::string > \fBnotes\fP"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "std::vector< std::string > \fBvalidHyperparameters\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
Definition at line \fB11\fP of file \fBTAN\&.h\fP\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "bayesnet::TAN::TAN ()"
.PP
Definition at line \fB10\fP of file \fBTAN\&.cc\fP\&.
.SH "Member Function Documentation"
.PP
.SS "void bayesnet::TAN::buildModel (const torch::Tensor & weights)\fR [override]\fP, \fR [protected]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::Classifier\fP\&.
.PP
Definition at line \fB12\fP of file \fBTAN\&.cc\fP\&.
.SS "std::vector< std::string > bayesnet::TAN::graph (const std::string & name = \fR'TAN'\fP) const\fR [override]\fP, \fR [virtual]\fP"
.PP
Implements \fBbayesnet::BaseClassifier\fP\&.
.PP
Definition at line \fB41\fP of file \fBTAN\&.cc\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for BayesNet from the source code\&.

244
docs/man3/bayesnet_TANLd.3 Normal file
View File

@@ -0,0 +1,244 @@
.TH "bayesnet::TANLd" 3 "Version 1.0.5" "BayesNet" \" -*- nroff -*-
.ad l
.nh
.SH NAME
bayesnet::TANLd
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBbayesnet::TAN\fP, and \fBbayesnet::Proposal\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBTANLd\fP & \fBfit\fP (torch::Tensor &X, torch::Tensor &y, const std::vector< std::string > &features, const std::string &className, map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "std::vector< std::string > \fBgraph\fP (const std::string &name='TAN') const override"
.br
.ti -1c
.RI "torch::Tensor \fBpredict\fP (torch::Tensor &X) override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "\fBClassifier\fP (\fBNetwork\fP model)"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (std::vector< std::vector< int > > &X, std::vector< int > &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &X, torch::Tensor &y, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states) override"
.br
.ti -1c
.RI "\fBClassifier\fP & \fBfit\fP (torch::Tensor &dataset, const std::vector< std::string > &features, const std::string &className, std::map< std::string, std::vector< int > > &states, const torch::Tensor &weights) override"
.br
.ti -1c
.RI "void \fBaddNodes\fP ()"
.br
.ti -1c
.RI "int \fBgetNumberOfNodes\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfEdges\fP () const override"
.br
.ti -1c
.RI "int \fBgetNumberOfStates\fP () const override"
.br
.ti -1c
.RI "int \fBgetClassNumStates\fP () const override"
.br
.ti -1c
.RI "std::vector< int > \fBpredict\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "torch::Tensor \fBpredict_proba\fP (torch::Tensor &X) override"
.br
.ti -1c
.RI "std::vector< std::vector< double > > \fBpredict_proba\fP (std::vector< std::vector< int > > &X) override"
.br
.ti -1c
.RI "status_t \fBgetStatus\fP () const override"
.br
.ti -1c
.RI "std::string \fBgetVersion\fP () override"
.br
.ti -1c
.RI "float \fBscore\fP (torch::Tensor &X, torch::Tensor &y) override"
.br
.ti -1c
.RI "float \fBscore\fP (std::vector< std::vector< int > > &X, std::vector< int > &y) override"
.br
.ti -1c
.RI "std::vector< std::string > \fBshow\fP () const override"
.br
.ti -1c
.RI "std::vector< std::string > \fBtopological_order\fP () override"
.br
.ti -1c
.RI "std::vector< std::string > \fBgetNotes\fP () const override"
.br
.ti -1c
.RI "std::string \fBdump_cpt\fP () const override"
.br
.ti -1c
.RI "void \fBsetHyperparameters\fP (const nlohmann::json &hyperparameters) override"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "std::vector< std::string > & \fBgetValidHyperparameters\fP ()"
.br
.in -1c
Public Member Functions inherited from \fBbayesnet::Proposal\fP
.in +1c
.ti -1c
.RI "\fBProposal\fP (torch::Tensor &pDataset, std::vector< std::string > &features_, std::string &className_)"
.br
.in -1c
.SS "Static Public Member Functions"
.in +1c
.ti -1c
.RI "static std::string \fBversion\fP ()"
.br
.in -1c
.SS "Additional Inherited Members"
Protected Member Functions inherited from \fBbayesnet::TAN\fP
.in +1c
.ti -1c
.RI "void \fBbuildModel\fP (const torch::Tensor &weights) override"
.br
.in -1c
Protected Member Functions inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "void \fBcheckFitParameters\fP ()"
.br
.ti -1c
.RI "void \fBtrainModel\fP (const torch::Tensor &weights) override"
.br
.ti -1c
.RI "void \fBbuildDataset\fP (torch::Tensor &y)"
.br
.in -1c
Protected Member Functions inherited from \fBbayesnet::Proposal\fP
.in +1c
.ti -1c
.RI "void \fBcheckInput\fP (const torch::Tensor &X, const torch::Tensor &y)"
.br
.ti -1c
.RI "torch::Tensor \fBprepareX\fP (torch::Tensor &X)"
.br
.ti -1c
.RI "map< std::string, std::vector< int > > \fBlocalDiscretizationProposal\fP (const map< std::string, std::vector< int > > &states, \fBNetwork\fP &model)"
.br
.ti -1c
.RI "map< std::string, std::vector< int > > \fBfit_local_discretization\fP (const torch::Tensor &y)"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::Classifier\fP
.in +1c
.ti -1c
.RI "bool \fBfitted\fP"
.br
.ti -1c
.RI "unsigned int \fBm\fP"
.br
.ti -1c
.RI "unsigned int \fBn\fP"
.br
.ti -1c
.RI "\fBNetwork\fP \fBmodel\fP"
.br
.ti -1c
.RI "Metrics \fBmetrics\fP"
.br
.ti -1c
.RI "std::vector< std::string > \fBfeatures\fP"
.br
.ti -1c
.RI "std::string \fBclassName\fP"
.br
.ti -1c
.RI "std::map< std::string, std::vector< int > > \fBstates\fP"
.br
.ti -1c
.RI "torch::Tensor \fBdataset\fP"
.br
.ti -1c
.RI "status_t \fBstatus\fP = NORMAL"
.br
.ti -1c
.RI "std::vector< std::string > \fBnotes\fP"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::BaseClassifier\fP
.in +1c
.ti -1c
.RI "std::vector< std::string > \fBvalidHyperparameters\fP"
.br
.in -1c
Protected Attributes inherited from \fBbayesnet::Proposal\fP
.in +1c
.ti -1c
.RI "torch::Tensor \fBXf\fP"
.br
.ti -1c
.RI "torch::Tensor \fBy\fP"
.br
.ti -1c
.RI "map< std::string, mdlp::CPPFImdlp * > \fBdiscretizers\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
Definition at line \fB13\fP of file \fBTANLd\&.h\fP\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "bayesnet::TANLd::TANLd ()"
.PP
Definition at line \fB10\fP of file \fBTANLd\&.cc\fP\&.
.SH "Member Function Documentation"
.PP
.SS "\fBTANLd\fP & bayesnet::TANLd::fit (torch::Tensor & X, torch::Tensor & y, const std::vector< std::string > & features, const std::string & className, map< std::string, std::vector< int > > & states)\fR [override]\fP"
.PP
Definition at line \fB11\fP of file \fBTANLd\&.cc\fP\&.
.SS "std::vector< std::string > bayesnet::TANLd::graph (const std::string & name = \fR'TAN'\fP) const\fR [override]\fP, \fR [virtual]\fP"
.PP
Reimplemented from \fBbayesnet::TAN\fP\&.
.PP
Definition at line \fB32\fP of file \fBTANLd\&.cc\fP\&.
.SS "torch::Tensor bayesnet::TANLd::predict (torch::Tensor & X)\fR [override]\fP, \fR [virtual]\fP"
.PP
Reimplemented from \fBbayesnet::Classifier\fP\&.
.PP
Definition at line \fB27\fP of file \fBTANLd\&.cc\fP\&.
.SS "static std::string bayesnet::TANLd::version ()\fR [inline]\fP, \fR [static]\fP"
.PP
Definition at line \fB21\fP of file \fBTANLd\&.h\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for BayesNet from the source code\&.