![]() |
aGrUM 3.3.2
a C++ library for (probabilistic) graphical models
|
A pack of learning algorithms that can easily be used. More...
#include <BNLearner.h>
Public Types | |
| enum class | ScoreType { AIC , BD , BDeu , BIC , fNML , K2 , LOG2LIKELIHOOD , MDL } |
| an enumeration enabling to select easily the score we wish to use More... | |
| enum class | ParamEstimatorType { ML } |
| an enumeration to select the type of parameter estimation we shall apply More... | |
| enum class | BNLearnerPriorType { NO_prior , SMOOTHING , DIRICHLET_FROM_DATABASE , DIRICHLET_FROM_BAYESNET , BDEU } |
| an enumeration to select the prior More... | |
| enum class | AlgoType { K2 , GREEDY_HILL_CLIMBING , LOCAL_SEARCH_WITH_TABU_LIST , MIIC , PC , FCI , EXTENDED_GREEDY_HILL_CLIMBING , GREEDY_THICK_THINNING } |
| an enumeration to select easily the learning algorithm to use More... | |
| enum class | ApproximationSchemeSTATE : char { Undefined , Continue , Epsilon , Rate , Limit , TimeLimit , Stopped } |
| The different state of an approximation scheme. More... | |
Public Member Functions | |
| BayesNet< GUM_SCALAR > | learnBN () |
| learn a Bayes Net from a file (must have read the db before) | |
| BayesNet< GUM_SCALAR > | learnParameters (const DAG &dag, bool takeIntoAccountScore=true) |
| learns a BN (its parameters) with the structure passed in argument | |
| BayesNet< GUM_SCALAR > | learnParameters (const BayesNet< GUM_SCALAR > &bn, bool takeIntoAccountScore=true) |
| learns a BN (its parameters) with the BN structure passed in argument, EM being initialized by this argument | |
| BayesNet< GUM_SCALAR > | learnParameters (bool take_into_account_score=true) |
| learns a BN (its parameters) when its structure is known | |
| std::string | toString () const |
| std::vector< std::tuple< std::string, std::string, std::string > > | state () const |
| void | copyState (const BNLearner< GUM_SCALAR > &learner) |
| copy the states of the BNLearner | |
| BNLearner< GUM_SCALAR > & | setInitialDAG (const DAG &dag) |
| BNLearner< GUM_SCALAR > & | useEM (const double epsilon, const double noise) |
| use The EM algorithm to learn parameters | |
| BNLearner< GUM_SCALAR > & | useEM (const double epsilon) |
| use The EM algorithm to learn parameters with the default noise (key emNoise of the section learning of gum::Configuration) | |
| BNLearner< GUM_SCALAR > & | useEMWithRateCriterion (const double epsilon, const double noise) |
| use The EM algorithm to learn parameters with the rate stopping criterion | |
| BNLearner< GUM_SCALAR > & | useEMWithRateCriterion (const double epsilon) |
| use The EM algorithm with the rate stopping criterion and the default noise (key emNoise) | |
| BNLearner< GUM_SCALAR > & | useEMWithDiffCriterion (const double epsilon, const double noise) |
| use The EM algorithm to learn parameters with the diff stopping criterion | |
| BNLearner< GUM_SCALAR > & | useEMWithDiffCriterion (const double epsilon) |
| use The EM algorithm with the diff stopping criterion and the default noise (key emNoise) | |
| BNLearner< GUM_SCALAR > & | forbidEM () |
| prevent using the EM algorithm for parameter learning | |
| BNLearner< GUM_SCALAR > & | EMsetEpsilon (const double eps) |
| sets the stopping criterion of EM as being the minimal difference between two consecutive log-likelihoods | |
| BNLearner< GUM_SCALAR > & | EMdisableEpsilon () |
| Disable the min log-likelihood diff stopping criterion. | |
| BNLearner< GUM_SCALAR > & | EMenableEpsilon () |
| Enable the log-likelihood min diff stopping criterion in EM. | |
| BNLearner< GUM_SCALAR > & | EMsetMinEpsilonRate (const double rate) |
| sets the stopping criterion of EM as being the minimal log-likelihood's evolution rate | |
| BNLearner< GUM_SCALAR > & | EMdisableMinEpsilonRate () |
| Disable the log-likelihood evolution rate stopping criterion. | |
| BNLearner< GUM_SCALAR > & | EMenableMinEpsilonRate () |
| Enable the log-likelihood evolution rate stopping criterion. | |
| BNLearner< GUM_SCALAR > & | EMsetMaxIter (const Size max) |
| add a max iteration stopping criterion | |
| BNLearner< GUM_SCALAR > & | EMdisableMaxIter () |
| Disable stopping criterion on max iterations. | |
| BNLearner< GUM_SCALAR > & | EMenableMaxIter () |
| Enable stopping criterion on max iterations. | |
| BNLearner< GUM_SCALAR > & | EMsetMaxTime (const double timeout) |
| add a stopping criterion on timeout | |
| BNLearner< GUM_SCALAR > & | EMdisableMaxTime () |
| Disable EM's timeout stopping criterion. | |
| BNLearner< GUM_SCALAR > & | EMenableMaxTime () |
| enable EM's timeout stopping criterion | |
| BNLearner< GUM_SCALAR > & | EMsetPeriodSize (const Size p) |
| how many samples between 2 stoppings isEnabled | |
| BNLearner< GUM_SCALAR > & | EMsetVerbosity (const bool v) |
| sets or unsets EM's verbosity | |
| BNLearner< GUM_SCALAR > & | useScoreAIC () |
| BNLearner< GUM_SCALAR > & | useScoreBD () |
| BNLearner< GUM_SCALAR > & | useScoreBDeu () |
| BNLearner< GUM_SCALAR > & | useScoreBIC () |
| BNLearner< GUM_SCALAR > & | useScoreK2 () |
| BNLearner< GUM_SCALAR > & | useScoreLog2Likelihood () |
| BNLearner< GUM_SCALAR > & | useNoPrior () |
| BNLearner< GUM_SCALAR > & | useBDeuPrior (double weight) |
| BNLearner< GUM_SCALAR > & | useBDeuPrior () |
| use the BDeu prior with the default weight (key priorWeight of the section learning) | |
| BNLearner< GUM_SCALAR > & | useSmoothingPrior (double weight) |
| BNLearner< GUM_SCALAR > & | useSmoothingPrior () |
| use the smoothing prior with the default weight (key priorWeight) | |
| BNLearner< GUM_SCALAR > & | useDirichletPrior (std::string_view filename, double weight) |
| BNLearner< GUM_SCALAR > & | useDirichletPrior (std::string_view filename) |
| use the Dirichlet prior from a database with the default weight (key priorWeight) | |
| BNLearner< GUM_SCALAR > & | useDirichletPrior (const gum::BayesNet< GUM_SCALAR > &bn, double weight) |
| BNLearner< GUM_SCALAR > & | useDirichletPrior (const gum::BayesNet< GUM_SCALAR > &bn) |
| use the Dirichlet prior from a BN with the default weight (key priorWeight) | |
| BNLearner< GUM_SCALAR > & | useGreedyHillClimbing () |
| BNLearner< GUM_SCALAR > & | useExtendedGreedyHillClimbing () |
| BNLearner< GUM_SCALAR > & | useGreedyThickThinning () |
| BNLearner< GUM_SCALAR > & | setGreedyThickThinningReversals (bool allow) |
| bool | greedyThickThinningReversals () const |
| BNLearner< GUM_SCALAR > & | useLocalSearchWithTabuList (Size tabu_size, Size nb_decrease) |
| BNLearner< GUM_SCALAR > & | useLocalSearchWithTabuList (Size tabu_size) |
| use a local search with tabu list, with the default number of decreasing changes (key tabuNbDecrease of the section learning of gum::Configuration) | |
| BNLearner< GUM_SCALAR > & | useLocalSearchWithTabuList () |
| use a local search with tabu list and the default parameters (keys tabuListSize and tabuNbDecrease) | |
| BNLearner< GUM_SCALAR > & | useK2 (const Sequence< NodeId > &order) |
| BNLearner< GUM_SCALAR > & | useK2 (const std::vector< NodeId > &order) |
| BNLearner< GUM_SCALAR > & | useMIIC () |
| BNLearner< GUM_SCALAR > & | usePC () |
| BNLearner< GUM_SCALAR > & | useFCI () |
| BNLearner< GUM_SCALAR > & | useFCIChi2Test () |
| BNLearner< GUM_SCALAR > & | useFCIG2Test () |
| BNLearner< GUM_SCALAR > & | setFCIAlpha (double alpha) |
| BNLearner< GUM_SCALAR > & | setFCIMaxPathLength (Size max_len) |
| BNLearner< GUM_SCALAR > & | setFCIExhaustiveSepSet (bool exhaustive) |
| bool | fciExhaustiveSepSet () const |
| BNLearner< GUM_SCALAR > & | useChi2Test () |
| BNLearner< GUM_SCALAR > & | useG2Test () |
| BNLearner< GUM_SCALAR > & | setPCAlpha (double alpha) |
| BNLearner< GUM_SCALAR > & | setPCStable (bool stable) |
| BNLearner< GUM_SCALAR > & | setPCMaxCondSetSize (Size max_k) |
| BNLearner< GUM_SCALAR > & | setPCUnshieldedColliderSorted (bool sorted) |
| BNLearner< GUM_SCALAR > & | useNMLCorrection () |
| BNLearner< GUM_SCALAR > & | useMDLCorrection () |
| BNLearner< GUM_SCALAR > & | useNoCorrection () |
| BNLearner< GUM_SCALAR > & | setMaxIndegree (Size max_indegree) |
| BNLearner< GUM_SCALAR > & | setSliceOrder (const NodeProperty< NodeId > &slice_order) |
| BNLearner< GUM_SCALAR > & | setSliceOrder (const std::vector< std::vector< std::string > > &slices) |
| BNLearner< GUM_SCALAR > & | setTotalOrder (const std::vector< std::string > &order) |
| BNLearner< GUM_SCALAR > & | setTotalOrder (const Sequence< NodeId > &order) |
| BNLearner< GUM_SCALAR > & | setForbiddenArcs (const ArcSet &set) |
| BNLearner< GUM_SCALAR > & | addForbiddenArc (const Arc &arc) |
| BNLearner< GUM_SCALAR > & | addForbiddenArc (NodeId tail, NodeId head) |
| BNLearner< GUM_SCALAR > & | addForbiddenArc (std::string_view tail, std::string_view head) |
| BNLearner< GUM_SCALAR > & | eraseForbiddenArc (const Arc &arc) |
| BNLearner< GUM_SCALAR > & | eraseForbiddenArc (NodeId tail, NodeId head) |
| BNLearner< GUM_SCALAR > & | eraseForbiddenArc (std::string_view tail, std::string_view head) |
| BNLearner< GUM_SCALAR > & | addMandatoryArc (const Arc &arc) |
| BNLearner< GUM_SCALAR > & | addMandatoryArc (NodeId tail, NodeId head) |
| BNLearner< GUM_SCALAR > & | addMandatoryArc (std::string_view tail, std::string_view head) |
| BNLearner< GUM_SCALAR > & | eraseMandatoryArc (const Arc &arc) |
| BNLearner< GUM_SCALAR > & | eraseMandatoryArc (NodeId tail, NodeId head) |
| BNLearner< GUM_SCALAR > & | eraseMandatoryArc (std::string_view tail, std::string_view head) |
| BNLearner< GUM_SCALAR > & | addPossibleEdge (const Edge &edge) |
| BNLearner< GUM_SCALAR > & | addPossibleEdge (NodeId tail, NodeId head) |
| BNLearner< GUM_SCALAR > & | addPossibleEdge (std::string_view tail, std::string_view head) |
| BNLearner< GUM_SCALAR > & | erasePossibleEdge (const Edge &edge) |
| BNLearner< GUM_SCALAR > & | erasePossibleEdge (NodeId tail, NodeId head) |
| BNLearner< GUM_SCALAR > & | erasePossibleEdge (std::string_view tail, std::string_view head) |
| BNLearner< GUM_SCALAR > & | setMandatoryArcs (const ArcSet &set) |
| BNLearner< GUM_SCALAR > & | setPossibleEdges (const EdgeSet &set) |
| BNLearner< GUM_SCALAR > & | setPossibleSkeleton (const UndiGraph &skeleton) |
| BNLearner< GUM_SCALAR > & | addNoParentNode (NodeId node) |
| BNLearner< GUM_SCALAR > & | addNoParentNode (std::string_view name) |
| BNLearner< GUM_SCALAR > & | eraseNoParentNode (NodeId node) |
| BNLearner< GUM_SCALAR > & | eraseNoParentNode (std::string_view name) |
| BNLearner< GUM_SCALAR > & | addNoChildrenNode (NodeId node) |
| BNLearner< GUM_SCALAR > & | addNoChildrenNode (std::string_view name) |
| BNLearner< GUM_SCALAR > & | eraseNoChildrenNode (NodeId node) |
| BNLearner< GUM_SCALAR > & | eraseNoChildrenNode (std::string_view name) |
| BNLearner< GUM_SCALAR > & | allowArcAdditions (bool allow) |
| BNLearner< GUM_SCALAR > & | allowArcDeletions (bool allow) |
| BNLearner< GUM_SCALAR > & | allowArcReversals (bool allow) |
| BNLearner< GUM_SCALAR > & | allowArcTriangleDeletions (bool allow) |
| bool | isConstraintBased () const |
| bool | isScoreBased () const |
| Size | EMPeriodSize () const |
| void | unsetTotalOrder () |
| removes the current total ordering constraint, if any | |
Constructors / Destructors | |
| BNLearner (std::string_view filename, const std::vector< std::string > &missingSymbols={"?"}, const bool induceTypes=true) | |
| default constructor | |
| BNLearner (const DatabaseTable &db) | |
| default constructor | |
| BNLearner (std::string_view filename, const gum::BayesNet< GUM_SCALAR > &src, const std::vector< std::string > &missing_symbols={"?"}) | |
| Wrapper for BNLearner (filename,modalities,parse_database) using a bn to find those modalities and nodeids. | |
| BNLearner (const BNLearner &) | |
| copy constructor | |
| BNLearner (BNLearner &&) | |
| move constructor | |
| ~BNLearner () override | |
| destructor | |
Operators | |
| BNLearner & | operator= (const BNLearner &) |
| copy operator | |
| BNLearner & | operator= (BNLearner &&) noexcept |
| move operator | |
Accessors / Modifiers | |
| DAG | learnDAG () |
| learn a structure from a file (must have read the db before) | |
| PDAG | learnPDAG () |
| learn a partial structure from a file (must have read the db before and must have selected miic) | |
| PAG | learnPAG () |
| learn a PAG — only valid when useFCI() has been called | |
| DAG | initialDAG () |
| returns the initial DAG structure | |
| const std::vector< std::string > & | names () const |
| returns the names of the variables in the database | |
| const std::vector< std::size_t > & | domainSizes () const |
| returns the domain sizes of the variables in the database | |
| Size | domainSize (NodeId var) const |
| learn a structure from a file (must have read the db before) | |
| Size | domainSize (std::string_view var) const |
| learn a structure from a file (must have read the db before) | |
| NodeId | idFromName (std::string_view var_name) const |
| returns the node id corresponding to a variable name | |
| const DatabaseTable & | database () const |
| returns the database used by the BNLearner | |
| void | setDatabaseWeight (const double new_weight) |
| assign a weight to all the rows of the learning database so that the sum of their weights is equal to new_weight | |
| void | setRecordWeight (const std::size_t i, const double weight) |
| sets the weight of the ith record of the database | |
| double | recordWeight (const std::size_t i) const |
| returns the weight of the ith record | |
| double | databaseWeight () const |
| returns the weight of the whole database | |
| const std::string & | nameFromId (NodeId id) const |
| returns the variable name corresponding to a given node id | |
| void | useDatabaseRanges (const std::vector< std::pair< std::size_t, std::size_t > > &new_ranges) |
| use a new set of database rows' ranges to perform learning | |
| void | clearDatabaseRanges () |
| reset the ranges to the one range corresponding to the whole database | |
| const std::vector< std::pair< std::size_t, std::size_t > > & | databaseRanges () const |
| returns the current database rows' ranges used for learning | |
| std::pair< std::size_t, std::size_t > | useCrossValidationFold (const std::size_t learning_fold, const std::size_t k_fold) |
| sets the ranges of rows to be used for cross-validation learning | |
| std::pair< double, double > | chi2 (NodeId id1, NodeId id2, const std::vector< NodeId > &knowing={}) |
| Return the <statistic,pvalue> pair for chi2 test in the database. | |
| std::pair< double, double > | chi2 (std::string_view name1, std::string_view name2, const std::vector< std::string > &knowing={}) |
| Return the <statistic,pvalue> pair for the BNLearner. | |
| std::pair< double, double > | G2 (NodeId id1, NodeId id2, const std::vector< NodeId > &knowing={}) |
| Return the <statistic,pvalue> pair for for G2 test in the database. | |
| std::pair< double, double > | G2 (std::string_view name1, std::string_view name2, const std::vector< std::string > &knowing={}) |
| Return the <statistic,pvalue> pair for for G2 test in the database. | |
| double | logLikelihood (const std::vector< NodeId > &vars, const std::vector< NodeId > &knowing={}) |
| Return the loglikelihood of vars in the base, conditioned by knowing for the BNLearner. | |
| double | logLikelihood (const std::vector< std::string > &vars, const std::vector< std::string > &knowing={}) |
| Return the loglikelihood of vars in the base, conditioned by knowing for the BNLearner. | |
| double | mutualInformation (NodeId id1, NodeId id2, const std::vector< NodeId > &knowing={}) |
| Return the mutual information of id1 and id2 in the base, conditioned by knowing for the BNLearner. | |
| double | mutualInformation (std::string_view var1, std::string_view var2, const std::vector< std::string > &knowing={}) |
| Return the mutual information of var1 and var2 in the base, conditioned by knowing for the BNLearner. | |
| double | correctedMutualInformation (NodeId id1, NodeId id2, const std::vector< NodeId > &knowing={}) |
| Return the mutual information of id1 and id2 in the base, conditioned by knowing for the BNLearner. | |
| double | correctedMutualInformation (std::string_view var1, std::string_view var2, const std::vector< std::string > &knowing={}) |
| Return the mutual information of var1 and var2 in the base, conditioned by knowing for the BNLearner. | |
| double | score (NodeId vars, const std::vector< NodeId > &knowing={}) |
| Return the value of the score currently in use by the BNLearner of a variable given a set of other variables. | |
| double | score (std::string_view vars, const std::vector< std::string > &knowing={}) |
| Return the value of the score currently in use by the BNLearner of a variable given a set of other variables The score used is the one currently selected in the BNLearner. | |
| std::vector< double > | rawPseudoCount (const std::vector< NodeId > &vars) |
| Return the pseudo-counts of NodeIds vars in the base in a raw array. | |
| std::vector< double > | rawPseudoCount (const std::vector< std::string > &vars) |
| Return the pseudoconts of vars in the base in a raw array. | |
| Size | nbCols () const |
| Size | nbRows () const |
| bool | isUsingEM () const |
| indicates whether we use EM for parameter learning | |
| EMApproximationScheme & | EM () |
| returns the EM parameter learning approximation scheme if EM is enabled | |
| ApproximationSchemeSTATE | EMState () const |
| returns the state of the last EM algorithm executed | |
| std::string | EMStateMessage () const |
| returns the state of the EM algorithm | |
| bool | hasMissingValues () const |
| returns true if the learner's database has missing values | |
Score selection | |
| void | useScorefNML () |
| indicate that we wish to use a fNML score | |
| void | useScoreMDL () |
| indicate that we wish to use a MDL score | |
a prior selection / parameterization | |
| std::string | checkScorePriorCompatibility () const |
| checks whether the current score and prior are compatible | |
MIIC parameterization and specific results | |
| std::vector< Arc > | latentVariables () const |
| get the list of arcs hiding latent variables | |
Accessors / Modifiers for adding constraints on learning | |
| void | unsetSliceOrder () |
| removes the slice order constraint | |
Multithreading | |
| void | setNumberOfThreads (Size nb) override |
| sets the number max of threads that can be used | |
redistribute signals AND implementation of interface | |
| void | setCurrentApproximationScheme (const ApproximationScheme *approximationScheme) |
| {@ /// distribute signals | |
| void | distributeProgress (const ApproximationScheme *approximationScheme, Size pourcent, double error, double time) |
| {@ /// distribute signals | |
| void | distributeStop (const ApproximationScheme *approximationScheme, std::string_view message) |
| distribute signals | |
| void | setEpsilon (double eps) override |
| Given that we approximate f(t), stopping criterion on |f(t+1)-f(t)| If the criterion was disabled it will be enabled. | |
| double | epsilon () const override |
| Get the value of epsilon. | |
| void | disableEpsilon () override |
| Disable stopping criterion on epsilon. | |
| void | enableEpsilon () override |
| Enable stopping criterion on epsilon. | |
| bool | isEnabledEpsilon () const override |
| void | setMinEpsilonRate (double rate) override |
| Given that we approximate f(t), stopping criterion on d/dt(|f(t+1)-f(t)|) If the criterion was disabled it will be enabled. | |
| double | minEpsilonRate () const override |
| Get the value of the minimal epsilon rate. | |
| void | disableMinEpsilonRate () override |
| Disable stopping criterion on epsilon rate. | |
| void | enableMinEpsilonRate () override |
| Enable stopping criterion on epsilon rate. | |
| bool | isEnabledMinEpsilonRate () const override |
| void | setMaxIter (Size max) override |
| stopping criterion on number of iterationsIf the criterion was disabled it will be enabled | |
| Size | maxIter () const override |
| void | disableMaxIter () override |
| Disable stopping criterion on max iterations. | |
| void | enableMaxIter () override |
| Enable stopping criterion on max iterations. | |
| bool | isEnabledMaxIter () const override |
| void | setMaxTime (double timeout) override |
| stopping criterion on timeout If the criterion was disabled it will be enabled | |
| double | maxTime () const override |
| returns the timeout (in seconds) | |
| double | currentTime () const override |
| get the current running time in second (double) | |
| void | disableMaxTime () override |
| Disable stopping criterion on timeout. | |
| void | enableMaxTime () override |
| stopping criterion on timeout If the criterion was disabled it will be enabled | |
| bool | isEnabledMaxTime () const override |
| void | setPeriodSize (Size p) override |
| how many samples between 2 stopping isEnableds | |
| Size | periodSize () const override |
| how many samples between 2 stopping isEnableds | |
| void | setVerbosity (bool v) override |
| verbosity | |
| bool | verbosity () const override |
| verbosity | |
| ApproximationSchemeSTATE | stateApproximationScheme () const override |
| history | |
| Size | nbrIterations () const override |
| const std::vector< double > & | history () const override |
EM approximation scheme for parameter learning | |
| double | EMEpsilon () const |
| Get the value of EM's min diff epsilon. | |
| bool | EMisEnabledEpsilon () const |
| return true if EM's stopping criterion is the log-likelihood min diff | |
| double | EMMinEpsilonRate () const |
| Get the value of the minimal log-likelihood evolution rate of EM. | |
| bool | EMisEnabledMinEpsilonRate () const |
| Size | EMMaxIter () const |
| return the max number of iterations criterion | |
| bool | EMisEnabledMaxIter () const |
| double | EMMaxTime () const |
| @brief returns EM's timeout (in milliseconds) | |
| double | EMCurrentTime () const |
| get the current running time in second (double) | |
| bool | EMisEnabledMaxTime () const |
| bool | EMVerbosity () const |
| returns the EM's verbosity status | |
| ApproximationSchemeSTATE | EMStateApproximationScheme () const |
| get the current state of EM | |
| Size | EMnbrIterations () const |
| returns the number of iterations performed by the last EM execution | |
| const std::vector< double > & | EMHistory () const |
| returns the history of the last EM execution | |
Getters and setters | |
| std::string | messageApproximationScheme () const |
| Returns the approximation scheme message. | |
Accessors/Modifiers | |
| Size | getNumberOfThreads () const override |
| returns the current max number of threads used by the class containing this ThreadNumberManager | |
| bool | isGumNumberOfThreadsOverriden () const override |
| indicates whether the class containing this ThreadNumberManager set its own number of threads | |
Static Public Member Functions | |
Learning algorithm selection | |
| static AlgoType | preferredAlgo () |
| the algorithm used by the learners when none is selected explicitly | |
Public Attributes | |
| Signaler< Size, double, double > | onProgress |
| Progression, error and time. | |
| Signaler< std::string_view > | onStop |
| Criteria messageApproximationScheme. | |
Protected Types | |
| enum class | IndepTestType { Chi2 , G2 } |
| independence test type for PC More... | |
Protected Member Functions | |
| void | createPrior_ () override |
| create the prior used for learning | |
| PAG | learnPAG_ () |
| PDAG | learnPDAG_ () |
| void | _setPriorWeight_ (double weight) |
| sets the prior weight | |
| void | createScore_ () |
| create the score used for learning | |
| ParamEstimator * | createParamEstimator_ (const DBRowGeneratorParser &parser, bool take_into_account_score=true) |
| create the parameter estimator used for learning | |
| DAG | learnDag_ () |
| returns the DAG learnt | |
| MixedGraph | prepareMiic_ () |
| prepares the initial graph for miic | |
| MixedGraph | preparePC_ () |
| prepares the initial graph and independence test for PC | |
| MixedGraph | prepareFCI_ () |
| prepares the initial graph and independence test for FCI | |
| PriorType | getPriorType_ () const |
| returns the type (as a string) of a given prior | |
| void | createCorrectedMutualInformation_ () |
| create the Corrected Mutual Information instance for Miic | |
Static Protected Member Functions | |
| static DatabaseTable | readFile_ (std::string_view filename, const std::vector< std::string > &missing_symbols) |
| reads a file and returns a databaseVectInRam | |
| static void | isCSVFileName_ (std::string_view filename) |
| checks whether the extension of a CSV filename is correct | |
Protected Attributes | |
| bool | inducedTypes_ {false} |
| the policy for typing variables | |
| ScoreType | scoreType_ {ScoreType::BDeu} |
| the score selected for learning | |
| Score * | score_ {nullptr} |
| the score used | |
| ParamEstimatorType | paramEstimatorType_ {ParamEstimatorType::ML} |
| the type of the parameter estimator | |
| bool | useEM_ {false} |
| a Boolean indicating whether we should use EM for parameter learning or not | |
| CorrectedMutualInformation * | mutualInfo_ {nullptr} |
| the selected correction for miic | |
| BNLearnerPriorType | priorType_ {BNLearnerPriorType::NO_prior} |
| the a priorselected for the score and parameters | |
| Prior * | prior_ {nullptr} |
| the prior used | |
| NoPrior * | noPrior_ {nullptr} |
| double | priorWeight_ {1.0f} |
| the weight of the prior. It is always written by the useXxxPrior() methods, which read learning.priorWeight when no weight is given. | |
| StructuralConstraintSliceOrder | constraintSliceOrder_ |
| the constraint for 2TBNs | |
| StructuralConstraintTotalOrder | constraintTotalOrder_ |
| the total order ing constraint | |
| StructuralConstraintIndegree | constraintIndegree_ |
| the constraint for indegrees | |
| StructuralConstraintTabuList | constraintTabuList_ |
| the constraint for tabu lists | |
| StructuralConstraintForbiddenArcs | constraintForbiddenArcs_ |
| the constraint on forbidden arcs | |
| StructuralConstraintPossibleEdges | constraintPossibleEdges_ |
| the constraint on possible Edges | |
| StructuralConstraintMandatoryArcs | constraintMandatoryArcs_ |
| the constraint on mandatory arcs | |
| StructuralConstraintNoParentNodes | constraintNoParentNodes_ |
| the constraint on no parent nodes | |
| StructuralConstraintNoChildrenNodes | constraintNoChildrenNodes_ |
| the constraint on no children nodes | |
| AlgoType | selectedAlgo_ {preferredAlgo()} |
| the learning algorithm ; it is initialized from the configuration, see preferredAlgo() | |
| bool | allowArcAdditions_ {true} |
| whether we allow or not arc additions during learning | |
| bool | allowArcDeletions_ {true} |
| whether we allow or not arc deletions during learning | |
| bool | allowArcReversals_ {true} |
| whether we allow or not arc reversals during learning | |
| bool | allowArcTriangleDeletions_ {true} |
| whether we allow or not arc deletions during learning | |
| K2 | algoK2_ |
| the K2 algorithm | |
| Miic | algoMiic_ |
| the Constraint MIIC algorithm | |
| CorrectedMutualInformation::KModeTypes | kmodeMiic_ |
| the penalty used in MIIC | |
| gum::learning::PC | algoPC_ |
| the PC algorithm | |
| IndepTestType | indepTestTypePC_ {IndepTestType::Chi2} |
| IndependenceTest * | indepTestPC_ {nullptr} |
| owned independence test object for PC (rebuilt before each learn call) | |
| double | alphaPc_ {gum::config().typed< double >("learning", "alpha")} |
| PC parameters the threshold of the tests ; it is initialized from the key learning.alpha. | |
| bool | stablePc_ {true} |
| Size | maxCondSetSizePc_ {Size(-1)} |
| bool | sortedUCPc_ {false} |
| gum::learning::FCI | algoFCI_ |
| the FCI algorithm | |
| IndepTestType | indepTestTypeFCI_ {IndepTestType::Chi2} |
| independence test type for FCI (reuses IndepTestType defined above) | |
| IndependenceTest * | indepTestFCI_ {nullptr} |
| owned independence test object for FCI (rebuilt before each learn call) | |
| double | alphaFci_ {gum::config().typed< double >("learning", "alpha")} |
| FCI parameters the threshold of the tests ; it is initialized from the key learning.alpha. | |
| Size | maxPathLengthFci_ {Size(-1)} |
| bool | exhaustiveSepSetFci_ {false} |
| DAG2BNLearner | dag2BN_ |
| the parametric EM | |
| GreedyHillClimbing | greedyHillClimbing_ |
| the greedy hill climbing algorithm | |
| GreedyHillClimbing | extendedGreedyHillClimbing_ |
| the extended greedy hill climbing | |
| GreedyThickThinning | greedyThickThinning_ |
| the greedy thick-thinning algorithm | |
| LocalSearchWithTabuList | localSearchWithTabuList_ |
| the local search with tabu list algorithm | |
| Database | scoreDatabase_ |
| the database to be used by the scores and parameter estimators | |
| std::vector< std::pair< std::size_t, std::size_t > > | ranges_ |
| the set of rows' ranges within the database in which learning is done | |
| Database * | priorDatabase_ {nullptr} |
| the database used by the Dirichlet a priori | |
| std::string | priorDbname_ |
| the filename for the Dirichlet a priori, if any | |
| DAG | initialDag_ |
| an initial DAG given to learners | |
| std::string | filename_ {"-"} |
| the filename database | |
| Size | tabuListSize_ {100} |
| Size | nbDecreasingChanges_ {2} |
| const ApproximationScheme * | currentAlgorithm_ {nullptr} |
Private Member Functions | |
| NodeProperty< Sequence< std::string > > | _labelsFromBN_ (std::string_view filename, const BayesNet< GUM_SCALAR > &src) |
| read the first line of a file to find column names | |
| void | _checkDAGCompatibility_ (const DAG &dag) |
| check that the database contains the nodes of the dag, else raise an exception | |
| BayesNet< GUM_SCALAR > | _learnParameters_ (const DAG &dag, bool takeIntoAccountScore) |
| learns a BN (its parameters) with the structure passed in argument using a single pass estimation (not EM) | |
| std::pair< std::shared_ptr< ParamEstimator >, std::shared_ptr< ParamEstimator > > | _initializeEMParameterLearning_ (const DAG &dag, bool takeIntoAccountScore) |
| initializes EM and returns a pair containing, first, a bootstrap estimator and, second, the EM estimator | |
| BayesNet< GUM_SCALAR > | _learnParametersWithEM_ (const DAG &dag, bool takeIntoAccountScore) |
| learns a BN (its parameters) with the structure passed in argument using the EM algorithm initialized by the BNLearner | |
| BayesNet< GUM_SCALAR > | _learnParametersWithEM_ (const BayesNet< GUM_SCALAR > &bn, bool takeIntoAccountScore) |
| learns a BN (its parameters) with the structure passed in argument using the EM algorithm initialized by the Bayes net passed in argument | |
Private Attributes | |
| BayesNet< GUM_SCALAR > | _prior_bn_ |
| Size | _nb_threads_ {0} |
| the max number of threads used by the class | |
A pack of learning algorithms that can easily be used.
The pack currently contains K2, GreedyHillClimbing and LocalSearchWithTabuList
Definition at line 73 of file BNLearner.h.
|
stronginherited |
an enumeration to select easily the learning algorithm to use
| Enumerator | |
|---|---|
| K2 | |
| GREEDY_HILL_CLIMBING | |
| LOCAL_SEARCH_WITH_TABU_LIST | |
| MIIC | |
| PC | |
| FCI | |
| EXTENDED_GREEDY_HILL_CLIMBING | |
| GREEDY_THICK_THINNING | |
Definition at line 126 of file IBNLearner.h.
|
stronginherited |
The different state of an approximation scheme.
| Enumerator | |
|---|---|
| Undefined | |
| Continue | |
| Epsilon | |
| Rate | |
| Limit | |
| TimeLimit | |
| Stopped | |
Definition at line 87 of file IApproximationSchemeConfiguration.h.
|
stronginherited |
an enumeration to select the prior
| Enumerator | |
|---|---|
| NO_prior | |
| SMOOTHING | |
| DIRICHLET_FROM_DATABASE | |
| DIRICHLET_FROM_BAYESNET | |
| BDEU | |
Definition at line 117 of file IBNLearner.h.
|
strongprotectedinherited |
independence test type for PC
| Enumerator | |
|---|---|
| Chi2 | |
| G2 | |
Definition at line 1249 of file IBNLearner.h.
|
stronginherited |
an enumeration to select the type of parameter estimation we shall apply
| Enumerator | |
|---|---|
| ML | |
Definition at line 114 of file IBNLearner.h.
|
stronginherited |
an enumeration enabling to select easily the score we wish to use
| Enumerator | |
|---|---|
| AIC | |
| BD | |
| BDeu | |
| BIC | |
| fNML | |
| K2 | |
| LOG2LIKELIHOOD | |
| MDL | |
Definition at line 110 of file IBNLearner.h.
| gum::learning::BNLearner< GUM_SCALAR >::BNLearner | ( | std::string_view | filename, |
| const std::vector< std::string > & | missingSymbols = {"?"}, | ||
| const bool | induceTypes = true ) |
default constructor
read the database file for the score / parameter estimation and var names
| filename | the name of a CSV file containing the dataset |
| missingSymbols | the set of symbols in the CSV that should be interpreted as missing values |
| induceTypes | By default, all the values in the dataset are interpreted as "labels", i.e., as categorical values. But if some columns of the dataset have only numerical values, it would certainly be better to tag them as corresponding to integer, range or continuous variables. By setting induceTypes to true, this is precisely what the BNLearner will do. |
Referenced by BNLearner(), BNLearner(), addForbiddenArc(), addForbiddenArc(), addForbiddenArc(), addMandatoryArc(), addMandatoryArc(), addMandatoryArc(), addNoChildrenNode(), addNoChildrenNode(), addNoParentNode(), addNoParentNode(), addPossibleEdge(), addPossibleEdge(), addPossibleEdge(), allowArcAdditions(), allowArcDeletions(), allowArcReversals(), allowArcTriangleDeletions(), copyState(), EMdisableEpsilon(), EMdisableMaxIter(), EMdisableMaxTime(), EMdisableMinEpsilonRate(), EMenableEpsilon(), EMenableMaxIter(), EMenableMaxTime(), EMenableMinEpsilonRate(), EMsetEpsilon(), EMsetMaxIter(), EMsetMaxTime(), EMsetMinEpsilonRate(), EMsetPeriodSize(), EMsetVerbosity(), eraseForbiddenArc(), eraseForbiddenArc(), eraseForbiddenArc(), eraseMandatoryArc(), eraseMandatoryArc(), eraseMandatoryArc(), eraseNoChildrenNode(), eraseNoChildrenNode(), eraseNoParentNode(), eraseNoParentNode(), erasePossibleEdge(), erasePossibleEdge(), erasePossibleEdge(), forbidEM(), operator=(), operator=(), setFCIAlpha(), setFCIExhaustiveSepSet(), setFCIMaxPathLength(), setForbiddenArcs(), setGreedyThickThinningReversals(), setInitialDAG(), setMandatoryArcs(), setMaxIndegree(), setPCAlpha(), setPCMaxCondSetSize(), setPCStable(), setPCUnshieldedColliderSorted(), setPossibleEdges(), setPossibleSkeleton(), setSliceOrder(), setSliceOrder(), setTotalOrder(), setTotalOrder(), useBDeuPrior(), useBDeuPrior(), useChi2Test(), useDirichletPrior(), useDirichletPrior(), useDirichletPrior(), useDirichletPrior(), useEM(), useEM(), useEMWithDiffCriterion(), useEMWithDiffCriterion(), useEMWithRateCriterion(), useEMWithRateCriterion(), useExtendedGreedyHillClimbing(), useFCI(), useFCIChi2Test(), useFCIG2Test(), useG2Test(), useGreedyHillClimbing(), useGreedyThickThinning(), useK2(), useK2(), useLocalSearchWithTabuList(), useLocalSearchWithTabuList(), useLocalSearchWithTabuList(), useMDLCorrection(), useMIIC(), useNMLCorrection(), useNoCorrection(), useNoPrior(), usePC(), useScoreAIC(), useScoreBD(), useScoreBDeu(), useScoreBIC(), useScoreK2(), useScoreLog2Likelihood(), useSmoothingPrior(), and useSmoothingPrior().
| gum::learning::BNLearner< GUM_SCALAR >::BNLearner | ( | const DatabaseTable & | db | ) |
default constructor
read the database file for the score / parameter estimation and var names
| db | an already initialized database table that is used to fill the Database |
| gum::learning::BNLearner< GUM_SCALAR >::BNLearner | ( | std::string_view | filename, |
| const gum::BayesNet< GUM_SCALAR > & | src, | ||
| const std::vector< std::string > & | missing_symbols = {"?"} ) |
Wrapper for BNLearner (filename,modalities,parse_database) using a bn to find those modalities and nodeids.
| gum::learning::BNLearner< GUM_SCALAR >::BNLearner | ( | const BNLearner< GUM_SCALAR > & | ) |
| gum::learning::BNLearner< GUM_SCALAR >::BNLearner | ( | BNLearner< GUM_SCALAR > && | ) |
|
override |
destructor
|
private |
check that the database contains the nodes of the dag, else raise an exception
| MissingVariableInDatabase | if a variable of the BN is not found in the database. |
References _checkDAGCompatibility_().
Referenced by _checkDAGCompatibility_().
|
private |
initializes EM and returns a pair containing, first, a bootstrap estimator and, second, the EM estimator
| dag | the graphical structure of the BN learnt by EM |
| takeIntoAccountScore | The dag passed in argument may have been learnt from a structure learning. In this case, if the score used to learn the structure has an implicit prior (like K2 which has a 1-smoothing prior), it is important to also take into account this implicit prior for parameter learning. By default, if a score exists, we will learn parameters by taking into account the prior specified by methods usePriorXXX () + the implicit prior of the score, else we just take into account the prior specified by usePriorXXX () |
References _initializeEMParameterLearning_().
Referenced by _initializeEMParameterLearning_().
|
private |
read the first line of a file to find column names
References _labelsFromBN_().
Referenced by _labelsFromBN_().
|
private |
learns a BN (its parameters) with the structure passed in argument using a single pass estimation (not EM)
| dag | the structure of the Bayesian network |
| takeIntoAccountScore | The dag passed in argument may have been learnt from a structure learning. In this case, if the score used to learn the structure has an implicit prior (like K2 which has a 1-smoothing prior), it is important to also take into account this implicit prior for parameter learning. By default, if a score exists, we will learn parameters by taking into account the prior specified by methods usePriorXXX () + the implicit prior of the score, else we just take into account the prior specified by usePriorXXX () |
| MissingVariableInDatabase | if a variable of the BN is not found in the database. |
| MissingValueInDatabase | if the database contains some missing values |
References _learnParameters_().
Referenced by _learnParameters_().
|
private |
learns a BN (its parameters) with the structure passed in argument using the EM algorithm initialized by the Bayes net passed in argument
| bn | the Bayesian network used to specify the graphical structure of the returned Bayes net and to initialize its CPTs before running EM. When a CPT is filled exclusively with only zeroes, then this one is initialized by the BNLearner using a specific estimator that does not take into account the missing values in the database |
| takeIntoAccountScore | The dag passed in argument may have been learnt from a structure learning. In this case, if the score used to learn the structure has an implicit prior (like K2 which has a 1-smoothing prior), it is important to also take into account this implicit prior for parameter learning. By default, if a score exists, we will learn parameters by taking into account the prior specified by methods usePriorXXX () + the implicit prior of the score, else we just take into account the prior specified by usePriorXXX () |
| MissingVariableInDatabase | if a variable of the BN is not found in the database. |
References _learnParametersWithEM_().
|
private |
learns a BN (its parameters) with the structure passed in argument using the EM algorithm initialized by the BNLearner
| dag | the structure of the Bayesian network |
| takeIntoAccountScore | The dag passed in argument may have been learnt from a structure learning. In this case, if the score used to learn the structure has an implicit prior (like K2 which has a 1-smoothing prior), it is important to also take into account this implicit prior for parameter learning. By default, if a score exists, we will learn parameters by taking into account the prior specified by methods usePriorXXX () + the implicit prior of the score, else we just take into account the prior specified by usePriorXXX () |
| MissingVariableInDatabase | if a variable of the BN is not found in the database. |
References _learnParametersWithEM_().
Referenced by _learnParametersWithEM_(), and _learnParametersWithEM_().
|
protectedinherited |
sets the prior weight
Definition at line 675 of file IBNLearner_inl.h.
References checkScorePriorCompatibility(), GUM_ERROR, and priorWeight_.
Referenced by useBDeuPrior(), useDirichletPrior(), and useSmoothingPrior().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::addForbiddenArc | ( | const Arc & | arc | ) |
References BNLearner(), and addForbiddenArc().
Referenced by addForbiddenArc(), addForbiddenArc(), and addForbiddenArc().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::addForbiddenArc | ( | NodeId | tail, |
| NodeId | head ) |
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::addForbiddenArc | ( | std::string_view | tail, |
| std::string_view | head ) |
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::addMandatoryArc | ( | const Arc & | arc | ) |
References BNLearner(), and addMandatoryArc().
Referenced by addMandatoryArc(), addMandatoryArc(), and addMandatoryArc().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::addMandatoryArc | ( | NodeId | tail, |
| NodeId | head ) |
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::addMandatoryArc | ( | std::string_view | tail, |
| std::string_view | head ) |
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::addNoChildrenNode | ( | NodeId | node | ) |
References BNLearner(), and addNoChildrenNode().
Referenced by addNoChildrenNode(), and addNoChildrenNode().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::addNoChildrenNode | ( | std::string_view | name | ) |
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::addNoParentNode | ( | NodeId | node | ) |
References BNLearner(), and addNoParentNode().
Referenced by addNoParentNode(), and addNoParentNode().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::addNoParentNode | ( | std::string_view | name | ) |
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::addPossibleEdge | ( | const Edge & | edge | ) |
References BNLearner(), and addPossibleEdge().
Referenced by addPossibleEdge(), addPossibleEdge(), and addPossibleEdge().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::addPossibleEdge | ( | NodeId | tail, |
| NodeId | head ) |
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::addPossibleEdge | ( | std::string_view | tail, |
| std::string_view | head ) |
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::allowArcAdditions | ( | bool | allow | ) |
References BNLearner(), and allowArcAdditions().
Referenced by allowArcAdditions().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::allowArcDeletions | ( | bool | allow | ) |
References BNLearner(), and allowArcDeletions().
Referenced by allowArcDeletions().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::allowArcReversals | ( | bool | allow | ) |
References BNLearner(), and allowArcReversals().
Referenced by allowArcReversals().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::allowArcTriangleDeletions | ( | bool | allow | ) |
References BNLearner(), and allowArcTriangleDeletions().
Referenced by allowArcTriangleDeletions().
|
inherited |
checks whether the current score and prior are compatible
Definition at line 1300 of file IBNLearner.cpp.
References getPriorType_(), isConstraintBased(), gum::learning::ScoreAIC::isPriorCompatible(), gum::learning::ScoreBD::isPriorCompatible(), gum::learning::ScoreBDeu::isPriorCompatible(), gum::learning::ScoreBIC::isPriorCompatible(), gum::learning::ScorefNML::isPriorCompatible(), gum::learning::ScoreK2::isPriorCompatible(), gum::learning::ScoreLog2Likelihood::isPriorCompatible(), priorWeight_, and scoreType_.
Referenced by _setPriorWeight_(), useBDeuPrior(), useDirichletPrior(), useNoPrior(), useScoreAIC(), useScoreBD(), useScoreBDeu(), useScoreBIC(), useScorefNML(), useScoreK2(), useScoreLog2Likelihood(), useScoreMDL(), and useSmoothingPrior().
|
inherited |
Return the <statistic,pvalue> pair for chi2 test in the database.
| id1 | first variable |
| id2 | second variable |
| knowing | list of observed variables |
Definition at line 1368 of file IBNLearner.cpp.
References createPrior_(), databaseRanges(), gum::learning::IBNLearner::Database::parser(), prior_, scoreDatabase_, and gum::learning::IndepTestChi2::statistics().
Referenced by chi2().
|
inherited |
Return the <statistic,pvalue> pair for the BNLearner.
| id1 | first variable |
| id2 | second variable |
| knowing | list of observed variables |
Definition at line 1375 of file IBNLearner.cpp.
References chi2(), and idFromName().
|
inherited |
reset the ranges to the one range corresponding to the whole database
Definition at line 775 of file IBNLearner_inl.h.
References ranges_.
| void gum::learning::BNLearner< GUM_SCALAR >::copyState | ( | const BNLearner< GUM_SCALAR > & | learner | ) |
copy the states of the BNLearner
References BNLearner(), and copyState().
Referenced by copyState().
|
inherited |
Return the mutual information of id1 and id2 in the base, conditioned by knowing for the BNLearner.
| id1 | nodeId |
| id2 | nodeId |
| knowing | an optional vector of conditioning NodeIds |
Definition at line 1433 of file IBNLearner.cpp.
References createPrior_(), databaseRanges(), GUM_ERROR, kmodeMiic_, gum::learning::IBNLearner::Database::parser(), prior_, gum::learning::CorrectedMutualInformation::score(), scoreDatabase_, gum::learning::CorrectedMutualInformation::useMDL(), gum::learning::CorrectedMutualInformation::useNML(), gum::learning::CorrectedMutualInformation::useNoCorr(), and gum::learning::IBNLearner::Database::weight().
Referenced by correctedMutualInformation().
|
inherited |
Return the mutual information of var1 and var2 in the base, conditioned by knowing for the BNLearner.
| var1 | name of a row |
| var2 | name of a row |
| knowing | an optional vector of conditioning rows |
Definition at line 1458 of file IBNLearner.cpp.
References correctedMutualInformation(), and idFromName().
|
protectedinherited |
create the Corrected Mutual Information instance for Miic
Definition at line 996 of file IBNLearner.cpp.
References gum::learning::CorrectedMutualInformation::CorrectedMutualInformation(), GUM_ERROR, kmodeMiic_, mutualInfo_, gum::learning::IBNLearner::Database::nodeId2Columns(), noPrior_, gum::learning::IBNLearner::Database::parser(), ranges_, scoreDatabase_, gum::learning::CorrectedMutualInformation::useMDL(), gum::learning::CorrectedMutualInformation::useNML(), and gum::learning::CorrectedMutualInformation::useNoCorr().
Referenced by createPrior_(), and prepareMiic_().
|
protectedinherited |
create the parameter estimator used for learning
Definition at line 589 of file IBNLearner.cpp.
References gum::learning::ParamEstimatorML::ParamEstimatorML(), gum::ThreadNumberManager::getNumberOfThreads(), GUM_ERROR, gum::learning::Score::internalPrior(), gum::ThreadNumberManager::isGumNumberOfThreadsOverriden(), ML, gum::learning::IBNLearner::Database::nodeId2Columns(), noPrior_, paramEstimatorType_, prior_, ranges_, score_, scoreDatabase_, gum::learning::ParamEstimator::setNumberOfThreads(), and gum::learning::ParamEstimator::setRanges().
Referenced by createPrior_().
|
overrideprotectedvirtual |
create the prior used for learning
Implements gum::learning::IBNLearner.
References createPrior_().
Referenced by createPrior_().
|
protectedinherited |
create the score used for learning
Definition at line 516 of file IBNLearner.cpp.
References gum::learning::ScoreAIC::ScoreAIC(), gum::learning::ScoreBD::ScoreBD(), gum::learning::ScoreBDeu::ScoreBDeu(), gum::learning::ScoreBIC::ScoreBIC(), gum::learning::ScorefNML::ScorefNML(), gum::learning::ScoreK2::ScoreK2(), gum::learning::ScoreLog2Likelihood::ScoreLog2Likelihood(), AIC, BD, BDeu, BIC, fNML, gum::ThreadNumberManager::getNumberOfThreads(), GUM_ERROR, gum::ThreadNumberManager::isGumNumberOfThreadsOverriden(), K2, LOG2LIKELIHOOD, MDL, gum::learning::IBNLearner::Database::nodeId2Columns(), gum::learning::IBNLearner::Database::parser(), prior_, ranges_, score_, scoreDatabase_, scoreType_, and gum::learning::Score::setNumberOfThreads().
Referenced by createPrior_(), learnDAG(), and score().
|
overridevirtualinherited |
get the current running time in second (double)
Implements gum::IApproximationSchemeConfiguration.
Definition at line 936 of file IBNLearner_inl.h.
References currentAlgorithm_, gum::ApproximationScheme::currentTime(), and GUM_ERROR.
Referenced by createPrior_().
|
inherited |
returns the database used by the BNLearner
Definition at line 778 of file IBNLearner_inl.h.
References gum::learning::IBNLearner::Database::databaseTable(), and scoreDatabase_.
Referenced by readFile_().
|
inherited |
returns the current database rows' ranges used for learning
Definition at line 770 of file IBNLearner_inl.h.
References ranges_.
Referenced by chi2(), correctedMutualInformation(), G2(), logLikelihood(), mutualInformation(), and rawPseudoCount().
|
inherited |
returns the weight of the whole database
Definition at line 162 of file IBNLearner_inl.h.
References scoreDatabase_, and gum::learning::IBNLearner::Database::weight().
|
overridevirtualinherited |
Disable stopping criterion on epsilon.
Implements gum::IApproximationSchemeConfiguration.
Definition at line 843 of file IBNLearner_inl.h.
References algoK2_, gum::learning::K2::approximationScheme(), dag2BN_, gum::ApproximationScheme::disableEpsilon(), greedyHillClimbing_, and localSearchWithTabuList_.
Referenced by createPrior_().
|
overridevirtualinherited |
Disable stopping criterion on max iterations.
Implements gum::IApproximationSchemeConfiguration.
Definition at line 905 of file IBNLearner_inl.h.
References algoK2_, gum::learning::K2::approximationScheme(), dag2BN_, gum::ApproximationScheme::disableMaxIter(), greedyHillClimbing_, and localSearchWithTabuList_.
Referenced by createPrior_().
|
overridevirtualinherited |
Disable stopping criterion on timeout.
Implements gum::IApproximationSchemeConfiguration.
Definition at line 941 of file IBNLearner_inl.h.
References algoK2_, gum::learning::K2::approximationScheme(), dag2BN_, gum::ApproximationScheme::disableMaxTime(), greedyHillClimbing_, and localSearchWithTabuList_.
Referenced by createPrior_().
|
overridevirtualinherited |
Disable stopping criterion on epsilon rate.
Implements gum::IApproximationSchemeConfiguration.
Definition at line 874 of file IBNLearner_inl.h.
References algoK2_, gum::learning::K2::approximationScheme(), dag2BN_, gum::ApproximationScheme::disableMinEpsilonRate(), greedyHillClimbing_, and localSearchWithTabuList_.
Referenced by createPrior_().
|
inherited |
{@ /// distribute signals
Definition at line 817 of file IBNLearner_inl.h.
References GUM_EMIT3, gum::__sig__::BasicSignaler< Args... >::hasListener(), gum::IApproximationSchemeConfiguration::onProgress, and setCurrentApproximationScheme().
Referenced by createPrior_(), and gum::learning::BNLearnerListener::whenProgress().
|
inherited |
distribute signals
Definition at line 825 of file IBNLearner_inl.h.
References GUM_EMIT1, gum::__sig__::BasicSignaler< Args... >::hasListener(), gum::IApproximationSchemeConfiguration::onStop, and setCurrentApproximationScheme().
Referenced by createPrior_(), and gum::learning::BNLearnerListener::whenStop().
learn a structure from a file (must have read the db before)
Definition at line 761 of file IBNLearner_inl.h.
References gum::learning::IBNLearner::Database::domainSizes(), and scoreDatabase_.
|
inherited |
learn a structure from a file (must have read the db before)
Definition at line 764 of file IBNLearner_inl.h.
References gum::learning::IBNLearner::Database::domainSizes(), idFromName(), and scoreDatabase_.
|
inherited |
returns the domain sizes of the variables in the database
Definition at line 756 of file IBNLearner_inl.h.
References gum::learning::IBNLearner::Database::domainSizes(), and scoreDatabase_.
|
inherited |
returns the EM parameter learning approximation scheme if EM is enabled
returns the EM parameter learning approximation scheme
| NotFound | is raised if EM() is called while the EM algorithm has not been enabled by useEM(), useEMWithDiffCriterion() or useEMWithRateCriterion(). |
Definition at line 467 of file IBNLearner_inl.h.
|
inherited |
get the current running time in second (double)
Definition at line 1038 of file IBNLearner_inl.h.
References gum::ApproximationScheme::currentTime(), and dag2BN_.
Referenced by createPrior_().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::EMdisableEpsilon | ( | ) |
Disable the min log-likelihood diff stopping criterion.
References BNLearner(), and EMdisableEpsilon().
Referenced by EMdisableEpsilon().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::EMdisableMaxIter | ( | ) |
Disable stopping criterion on max iterations.
References BNLearner(), and EMdisableMaxIter().
Referenced by EMdisableMaxIter().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::EMdisableMaxTime | ( | ) |
Disable EM's timeout stopping criterion.
References BNLearner(), and EMdisableMaxTime().
Referenced by EMdisableMaxTime().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::EMdisableMinEpsilonRate | ( | ) |
Disable the log-likelihood evolution rate stopping criterion.
References BNLearner(), and EMdisableMinEpsilonRate().
Referenced by EMdisableMinEpsilonRate().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::EMenableEpsilon | ( | ) |
Enable the log-likelihood min diff stopping criterion in EM.
References BNLearner(), and EMenableEpsilon().
Referenced by EMenableEpsilon().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::EMenableMaxIter | ( | ) |
Enable stopping criterion on max iterations.
References BNLearner(), and EMenableMaxIter().
Referenced by EMenableMaxIter().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::EMenableMaxTime | ( | ) |
enable EM's timeout stopping criterion
References BNLearner(), and EMenableMaxTime().
Referenced by EMenableMaxTime().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::EMenableMinEpsilonRate | ( | ) |
Enable the log-likelihood evolution rate stopping criterion.
References BNLearner(), and EMenableMinEpsilonRate().
Referenced by EMenableMinEpsilonRate().
|
inherited |
Get the value of EM's min diff epsilon.
Get the value of EM's min diff epsilon
Definition at line 1004 of file IBNLearner_inl.h.
References dag2BN_, and gum::ApproximationScheme::epsilon().
Referenced by createPrior_().
|
inherited |
returns the history of the last EM execution
Definition at line 1061 of file IBNLearner_inl.h.
References dag2BN_, and gum::ApproximationScheme::history().
Referenced by createPrior_().
|
inherited |
return true if EM's stopping criterion is the log-likelihood min diff
Definition at line 1010 of file IBNLearner_inl.h.
References dag2BN_, and gum::ApproximationScheme::isEnabledEpsilon().
Referenced by createPrior_().
|
inherited |
Definition at line 1032 of file IBNLearner_inl.h.
References dag2BN_, and gum::ApproximationScheme::isEnabledMaxIter().
Referenced by createPrior_().
|
inherited |
Definition at line 1044 of file IBNLearner_inl.h.
References dag2BN_, and gum::ApproximationScheme::isEnabledMaxTime().
Referenced by createPrior_().
|
inherited |
Definition at line 1020 of file IBNLearner_inl.h.
References dag2BN_, and gum::ApproximationScheme::isEnabledMinEpsilonRate().
Referenced by createPrior_().
|
inherited |
return the max number of iterations criterion
Definition at line 1026 of file IBNLearner_inl.h.
References dag2BN_, and gum::ApproximationScheme::maxIter().
Referenced by createPrior_().
|
inherited |
@brief returns EM's timeout (in milliseconds)
Definition at line 1036 of file IBNLearner_inl.h.
References dag2BN_, and gum::ApproximationScheme::maxTime().
Referenced by createPrior_().
|
inherited |
Get the value of the minimal log-likelihood evolution rate of EM.
Definition at line 1014 of file IBNLearner_inl.h.
References dag2BN_, and gum::ApproximationScheme::minEpsilonRate().
Referenced by createPrior_().
|
inherited |
returns the number of iterations performed by the last EM execution
Definition at line 1059 of file IBNLearner_inl.h.
References dag2BN_, and gum::ApproximationScheme::nbrIterations().
Referenced by createPrior_().
| INLINE Size gum::learning::IBNLearner::EMPeriodSize | ( | ) | const |
Definition at line 1611 of file IBNLearner_inl.h.
Referenced by EMsetPeriodSize().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::EMsetEpsilon | ( | const double | eps | ) |
sets the stopping criterion of EM as being the minimal difference between two consecutive log-likelihoods
| eps | the log-likelihood difference below which EM stops its iterations |
| OutOfBounds | if eps <= 0 |
References BNLearner(), and EMsetEpsilon().
Referenced by EMsetEpsilon().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::EMsetMaxIter | ( | const Size | max | ) |
add a max iteration stopping criterion
| max | the max number of iterations that EM is allowed to perform |
| OutOfBounds | if max<=1 |
References BNLearner(), and EMsetMaxIter().
Referenced by EMsetMaxIter().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::EMsetMaxTime | ( | const double | timeout | ) |
add a stopping criterion on timeout
| timeout | the timeout in milliseconds |
| OutOfBounds | if timeout<=0.0 |
References BNLearner(), and EMsetMaxTime().
Referenced by EMsetMaxTime().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::EMsetMinEpsilonRate | ( | const double | rate | ) |
sets the stopping criterion of EM as being the minimal log-likelihood's evolution rate
| rate | the log-likelihood evolution rate below which EM stops its iterations |
| OutOfBounds | if rate<=0 |
References BNLearner(), and EMsetMinEpsilonRate().
Referenced by EMsetMinEpsilonRate().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::EMsetPeriodSize | ( | const Size | p | ) |
how many samples between 2 stoppings isEnabled
| OutOfBounds | if p<1 |
References BNLearner(), gum::learning::IBNLearner::IBNLearner(), EMPeriodSize(), and EMsetPeriodSize().
Referenced by EMsetPeriodSize().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::EMsetVerbosity | ( | const bool | v | ) |
sets or unsets EM's verbosity
References BNLearner(), and EMsetVerbosity().
Referenced by EMsetVerbosity().
|
inherited |
returns the state of the last EM algorithm executed
Definition at line 473 of file IBNLearner_inl.h.
References dag2BN_, gum::ApproximationScheme::stateApproximationScheme(), gum::IApproximationSchemeConfiguration::Undefined, and useEM_.
|
inherited |
get the current state of EM
Definition at line 1055 of file IBNLearner_inl.h.
References dag2BN_, and gum::ApproximationScheme::stateApproximationScheme().
Referenced by createPrior_().
|
inherited |
returns the state of the EM algorithm
Definition at line 479 of file IBNLearner_inl.h.
References dag2BN_, gum::IApproximationSchemeConfiguration::messageApproximationScheme(), and useEM_.
|
inherited |
returns the EM's verbosity status
Definition at line 1052 of file IBNLearner_inl.h.
References dag2BN_, and gum::ApproximationScheme::verbosity().
Referenced by createPrior_().
|
overridevirtualinherited |
Enable stopping criterion on epsilon.
Implements gum::IApproximationSchemeConfiguration.
Definition at line 850 of file IBNLearner_inl.h.
References algoK2_, gum::learning::K2::approximationScheme(), dag2BN_, gum::ApproximationScheme::enableEpsilon(), greedyHillClimbing_, and localSearchWithTabuList_.
Referenced by createPrior_().
|
overridevirtualinherited |
Enable stopping criterion on max iterations.
Implements gum::IApproximationSchemeConfiguration.
Definition at line 912 of file IBNLearner_inl.h.
References algoK2_, gum::learning::K2::approximationScheme(), dag2BN_, gum::ApproximationScheme::enableMaxIter(), greedyHillClimbing_, and localSearchWithTabuList_.
Referenced by createPrior_().
|
overridevirtualinherited |
stopping criterion on timeout If the criterion was disabled it will be enabled
| OutOfBounds | if timeout<=0.0 timeout is time in second (double). |
Implements gum::IApproximationSchemeConfiguration.
Definition at line 948 of file IBNLearner_inl.h.
References algoK2_, gum::learning::K2::approximationScheme(), dag2BN_, gum::ApproximationScheme::enableMaxTime(), greedyHillClimbing_, and localSearchWithTabuList_.
Referenced by createPrior_().
|
overridevirtualinherited |
Enable stopping criterion on epsilon rate.
Implements gum::IApproximationSchemeConfiguration.
Definition at line 881 of file IBNLearner_inl.h.
References algoK2_, gum::learning::K2::approximationScheme(), dag2BN_, gum::ApproximationScheme::enableMinEpsilonRate(), greedyHillClimbing_, and localSearchWithTabuList_.
Referenced by createPrior_().
|
overridevirtualinherited |
Get the value of epsilon.
Implements gum::IApproximationSchemeConfiguration.
Definition at line 838 of file IBNLearner_inl.h.
References currentAlgorithm_, gum::ApproximationScheme::epsilon(), and GUM_ERROR.
Referenced by createPrior_(), gum::learning::BNLearner< GUM_SCALAR >::useEM(), gum::learning::BNLearner< GUM_SCALAR >::useEM(), useEM(), useEM(), gum::learning::BNLearner< GUM_SCALAR >::useEMWithDiffCriterion(), gum::learning::BNLearner< GUM_SCALAR >::useEMWithDiffCriterion(), useEMWithDiffCriterion(), useEMWithDiffCriterion(), gum::learning::BNLearner< GUM_SCALAR >::useEMWithRateCriterion(), gum::learning::BNLearner< GUM_SCALAR >::useEMWithRateCriterion(), useEMWithRateCriterion(), and useEMWithRateCriterion().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::eraseForbiddenArc | ( | const Arc & | arc | ) |
References BNLearner(), and eraseForbiddenArc().
Referenced by eraseForbiddenArc(), eraseForbiddenArc(), and eraseForbiddenArc().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::eraseForbiddenArc | ( | NodeId | tail, |
| NodeId | head ) |
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::eraseForbiddenArc | ( | std::string_view | tail, |
| std::string_view | head ) |
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::eraseMandatoryArc | ( | const Arc & | arc | ) |
References BNLearner(), and eraseMandatoryArc().
Referenced by eraseMandatoryArc(), eraseMandatoryArc(), and eraseMandatoryArc().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::eraseMandatoryArc | ( | NodeId | tail, |
| NodeId | head ) |
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::eraseMandatoryArc | ( | std::string_view | tail, |
| std::string_view | head ) |
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::eraseNoChildrenNode | ( | NodeId | node | ) |
References BNLearner(), and eraseNoChildrenNode().
Referenced by eraseNoChildrenNode(), and eraseNoChildrenNode().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::eraseNoChildrenNode | ( | std::string_view | name | ) |
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::eraseNoParentNode | ( | NodeId | node | ) |
References BNLearner(), and eraseNoParentNode().
Referenced by eraseNoParentNode(), and eraseNoParentNode().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::eraseNoParentNode | ( | std::string_view | name | ) |
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::erasePossibleEdge | ( | const Edge & | edge | ) |
References BNLearner(), and erasePossibleEdge().
Referenced by erasePossibleEdge(), erasePossibleEdge(), and erasePossibleEdge().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::erasePossibleEdge | ( | NodeId | tail, |
| NodeId | head ) |
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::erasePossibleEdge | ( | std::string_view | tail, |
| std::string_view | head ) |
| bool gum::learning::BNLearner< GUM_SCALAR >::fciExhaustiveSepSet | ( | ) | const |
References fciExhaustiveSepSet().
Referenced by fciExhaustiveSepSet().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::forbidEM | ( | ) |
prevent using the EM algorithm for parameter learning
References BNLearner(), and forbidEM().
Referenced by forbidEM().
|
inherited |
Return the <statistic,pvalue> pair for for G2 test in the database.
| id1 | first variable |
| id2 | second variable |
| knowing | list of observed variables |
Definition at line 1387 of file IBNLearner.cpp.
References createPrior_(), databaseRanges(), gum::learning::IBNLearner::Database::parser(), prior_, scoreDatabase_, and gum::learning::IndepTestG2::statistics().
Referenced by G2().
|
inherited |
Return the <statistic,pvalue> pair for for G2 test in the database.
| id1 | first variable |
| id2 | second variable |
| knowing | list of observed variables |
Definition at line 1393 of file IBNLearner.cpp.
References G2(), and idFromName().
|
nodiscardoverridevirtualinherited |
returns the current max number of threads used by the class containing this ThreadNumberManager
Implements gum::IThreadNumberManager.
Referenced by gum::learning::IBNLearner::createParamEstimator_(), gum::learning::IBNLearner::createScore_(), gum::credal::InferenceEngine< GUM_SCALAR >::dispatchMarginalsToThreads_(), gum::credal::CNLoopyPropagation< GUM_SCALAR >::enum_combi_(), gum::credal::CNLoopyPropagation< GUM_SCALAR >::enum_combi_(), gum::credal::MultipleInferenceEngine< GUM_SCALAR, BNInferenceEngine >::expFusion_(), gum::ScheduledInference::operator=(), gum::ScheduledInference::operator=(), gum::ScheduledInference::scheduler(), and gum::credal::MultipleInferenceEngine< GUM_SCALAR, BNInferenceEngine >::verticesFusion_().
|
protectedinherited |
returns the type (as a string) of a given prior
Definition at line 735 of file IBNLearner_inl.h.
References gum::learning::BDeuPriorType, gum::learning::DirichletPriorType, GUM_ERROR, gum::learning::NoPriorType, priorType_, and gum::learning::SmoothingPriorType.
Referenced by checkScorePriorCompatibility(), and createPrior_().
| bool gum::learning::BNLearner< GUM_SCALAR >::greedyThickThinningReversals | ( | ) | const |
References greedyThickThinningReversals().
Referenced by greedyThickThinningReversals().
|
inherited |
returns true if the learner's database has missing values
Definition at line 498 of file IBNLearner_inl.h.
References gum::learning::IBNLearner::Database::databaseTable(), gum::learning::IDatabaseTable< T_DATA >::hasMissingValues(), and scoreDatabase_.
Referenced by rawPseudoCount().
|
overridevirtualinherited |
| OperationNotAllowed | if scheme not performed or verbosity=false |
Implements gum::IApproximationSchemeConfiguration.
Definition at line 995 of file IBNLearner_inl.h.
References currentAlgorithm_, GUM_ERROR, and gum::ApproximationScheme::history().
Referenced by createPrior_().
|
inherited |
returns the node id corresponding to a variable name
| MissingVariableInDatabase | if a variable of the BN is not found in the database. |
Definition at line 137 of file IBNLearner_inl.h.
References gum::learning::IBNLearner::Database::idFromName(), and scoreDatabase_.
Referenced by addForbiddenArc(), addMandatoryArc(), addNoChildrenNode(), addNoParentNode(), addPossibleEdge(), chi2(), correctedMutualInformation(), domainSize(), eraseForbiddenArc(), eraseMandatoryArc(), eraseNoChildrenNode(), eraseNoParentNode(), erasePossibleEdge(), G2(), logLikelihood(), mutualInformation(), rawPseudoCount(), score(), setSliceOrder(), and setTotalOrder().
|
inherited |
returns the initial DAG structure
Definition at line 167 of file IBNLearner_inl.h.
References initialDag_.
| bool gum::learning::BNLearner< GUM_SCALAR >::isConstraintBased | ( | ) | const |
References isConstraintBased().
Referenced by isConstraintBased().
|
staticprotectedinherited |
checks whether the extension of a CSV filename is correct
Definition at line 474 of file IBNLearner.cpp.
References GUM_ERROR.
Referenced by gum::learning::IBNLearner::Database::Database(), gum::learning::IBNLearner::Database::Database(), and readFile_().
|
overridevirtualinherited |
Implements gum::IApproximationSchemeConfiguration.
Definition at line 857 of file IBNLearner_inl.h.
References currentAlgorithm_, GUM_ERROR, and gum::ApproximationScheme::isEnabledEpsilon().
Referenced by createPrior_().
|
overridevirtualinherited |
Implements gum::IApproximationSchemeConfiguration.
Definition at line 919 of file IBNLearner_inl.h.
References currentAlgorithm_, GUM_ERROR, and gum::ApproximationScheme::isEnabledMaxIter().
Referenced by createPrior_().
|
overridevirtualinherited |
Implements gum::IApproximationSchemeConfiguration.
Definition at line 955 of file IBNLearner_inl.h.
References currentAlgorithm_, GUM_ERROR, and gum::ApproximationScheme::isEnabledMaxTime().
Referenced by createPrior_().
|
overridevirtualinherited |
Implements gum::IApproximationSchemeConfiguration.
Definition at line 888 of file IBNLearner_inl.h.
References currentAlgorithm_, GUM_ERROR, and gum::ApproximationScheme::isEnabledMinEpsilonRate().
Referenced by createPrior_().
|
nodiscardoverridevirtualinherited |
indicates whether the class containing this ThreadNumberManager set its own number of threads
Implements gum::IThreadNumberManager.
Referenced by gum::learning::IBNLearner::createParamEstimator_(), gum::learning::IBNLearner::createScore_(), gum::ScheduledInference::operator=(), and gum::ScheduledInference::operator=().
| bool gum::learning::BNLearner< GUM_SCALAR >::isScoreBased | ( | ) | const |
References isScoreBased().
Referenced by isScoreBased().
|
inherited |
indicates whether we use EM for parameter learning
Definition at line 464 of file IBNLearner_inl.h.
References useEM_.
|
inherited |
get the list of arcs hiding latent variables
| OperationNotAllowed | when MIIC is not the selected algorithm |
Definition at line 346 of file IBNLearner_inl.h.
References algoMiic_, and gum::learning::ConstraintBasedLearning::latentVariables().
| BayesNet< GUM_SCALAR > gum::learning::BNLearner< GUM_SCALAR >::learnBN | ( | ) |
|
inherited |
learn a structure from a file (must have read the db before)
Definition at line 986 of file IBNLearner.cpp.
References createPrior_(), createScore_(), gum::learning::IBNLearner::Database::databaseTable(), learnDag_(), scoreDatabase_, and gum::learning::IDatabaseTable< T_DATA >::variableName().
|
protectedinherited |
returns the DAG learnt
Definition at line 1015 of file IBNLearner.cpp.
References gum::DAG::addArc(), gum::NodeGraphPart::addNodeWithId(), algoFCI_, algoK2_, algoMiic_, algoPC_, allowArcAdditions_, allowArcDeletions_, allowArcReversals_, allowArcTriangleDeletions_, gum::learning::K2::approximationScheme(), gum::learning::StructuralConstraintForbiddenArcs::arcs(), gum::learning::StructuralConstraintMandatoryArcs::arcs(), constraintForbiddenArcs_, constraintIndegree_, constraintMandatoryArcs_, constraintNoChildrenNodes_, constraintNoParentNodes_, constraintPossibleEdges_, constraintSliceOrder_, constraintTabuList_, constraintTotalOrder_, gum::learning::IBNLearner::Database::databaseTable(), DIRICHLET_FROM_DATABASE, gum::ArcGraphPart::eraseArc(), gum::NodeGraphPart::exists(), EXTENDED_GREEDY_HILL_CLIMBING, extendedGreedyHillClimbing_, FCI, GREEDY_HILL_CLIMBING, GREEDY_THICK_THINNING, greedyHillClimbing_, greedyThickThinning_, GUM_ERROR, gum::learning::IDatabaseTable< T_DATA >::hasMissingValues(), initialDag_, K2, gum::learning::ConstraintBasedLearning::learnDAG(), gum::learning::GreedyHillClimbing::learnStructure(), gum::learning::GreedyThickThinning::learnStructure(), gum::learning::K2::learnStructure(), gum::learning::LocalSearchWithTabuList::learnStructure(), LOCAL_SEARCH_WITH_TABU_LIST, localSearchWithTabuList_, MIIC, mutualInfo_, gum::learning::K2::order(), PC, gum::SequenceImplementation< Key, std::is_scalar< Key >::value >::pos(), prepareFCI_(), prepareMiic_(), preparePC_(), priorDatabase_, priorType_, score_, scoreDatabase_, selectedAlgo_, gum::learning::Miic::setMutualInformation(), gum::learning::GraphChangesSelector4DiGraph< INVARIABLE_CONSTRAINT_TYPE, VARIABLE_CONSTRAINT_TYPE >::useArcAdditions(), gum::learning::GraphChangesSelector4DiGraph< INVARIABLE_CONSTRAINT_TYPE, VARIABLE_CONSTRAINT_TYPE >::useArcDeletions(), gum::learning::GraphChangesSelector4DiGraph< INVARIABLE_CONSTRAINT_TYPE, VARIABLE_CONSTRAINT_TYPE >::useArcReversals(), and gum::learning::GraphChangesSelector4DiGraph< INVARIABLE_CONSTRAINT_TYPE, VARIABLE_CONSTRAINT_TYPE >::useArcTriangleDeletions().
Referenced by createPrior_(), and learnDAG().
|
inherited |
learn a PAG — only valid when useFCI() has been called
| OperationNotAllowed | when FCI is not the selected algorithm |
Definition at line 978 of file IBNLearner.cpp.
References gum::learning::IBNLearner::Database::databaseTable(), learnPAG_(), scoreDatabase_, and gum::learning::IDatabaseTable< T_DATA >::variableName().
|
protectedinherited |
Definition at line 964 of file IBNLearner.cpp.
References algoFCI_, gum::learning::IBNLearner::Database::databaseTable(), FCI, GUM_ERROR, gum::learning::IDatabaseTable< T_DATA >::hasMissingValues(), gum::learning::FCI::learnPAG(), prepareFCI_(), scoreDatabase_, and selectedAlgo_.
Referenced by learnPAG().
| BayesNet< GUM_SCALAR > gum::learning::BNLearner< GUM_SCALAR >::learnParameters | ( | bool | take_into_account_score = true | ) |
learns a BN (its parameters) when its structure is known
| take_into_account_score | The dag of the BN which was passed in argument to the BNLearner may have been learnt from a structure learning. In this case, if the score used to learn the structure has an implicit prior (like K2 which has a 1-smoothing prior), it is important to also take into account this implicit prior for parameter learning. By default, if a score exists, we will learn parameters by taking into account the prior specified by methods usePriorXXX () + the implicit prior of the score, else we just take into account the prior specified by usePriorXXX () |
| MissingVariableInDatabase | if a variable of the BN is not found in the database. |
| UnknownLabelInDatabase | if a label is found in the databast that do not correpond to the variable. |
| OperationNotAllowed | if EM is used but neither the min log-likelihood difference nor the min log-likelihood evolution rate have been selected as stopping criteria |
References learnParameters().
| BayesNet< GUM_SCALAR > gum::learning::BNLearner< GUM_SCALAR >::learnParameters | ( | const BayesNet< GUM_SCALAR > & | bn, |
| bool | takeIntoAccountScore = true ) |
learns a BN (its parameters) with the BN structure passed in argument, EM being initialized by this argument
| bn | the Bayesian network used to specify the graphical structure of the returned Bayes net and to initialize its CPTs before running EM. When a CPT is filled exclusively with only zeroes, then this one is initialized by the BNLearner using a specific estimator that does not take into account the missing values in the database |
| takeIntoAccountScore | The dag passed in argument may have been learnt from a structure learning. In this case, if the score used to learn the structure has an implicit prior (like K2 which has a 1-smoothing prior), it is important to also take into account this implicit prior for parameter learning. By default, if a score exists, we will learn parameters by taking into account the prior specified by methods usePriorXXX () + the implicit prior of the score, else we just take into account the prior specified by usePriorXXX () |
| MissingVariableInDatabase | if a variable of the BN is not found in the database. |
| OperationNotAllowed | if EM is used but no EM stopping criterion has been selected. |
References learnParameters().
| BayesNet< GUM_SCALAR > gum::learning::BNLearner< GUM_SCALAR >::learnParameters | ( | const DAG & | dag, |
| bool | takeIntoAccountScore = true ) |
learns a BN (its parameters) with the structure passed in argument
| dag | the structure of the Bayesian network |
| takeIntoAccountScore | The dag passed in argument may have been learnt from a structure learning. In this case, if the score used to learn the structure has an implicit prior (like K2 which has a 1-smoothing prior), it is important to also take into account this implicit prior for parameter learning. By default, if a score exists, we will learn parameters by taking into account the prior specified by methods usePriorXXX () + the implicit prior of the score, else we just take into account the prior specified by usePriorXXX () |
| MissingVariableInDatabase | if a variable of the BN is not found in the database. |
| MissingValueInDatabase | if the database contains some missing values and EM is not used for the learning. |
| OperationNotAllowed | if EM is used but no EM stopping criterion has been selected. |
References learnParameters().
Referenced by learnParameters(), learnParameters(), and learnParameters().
|
inherited |
learn a partial structure from a file (must have read the db before and must have selected miic)
Definition at line 956 of file IBNLearner.cpp.
References gum::learning::IBNLearner::Database::databaseTable(), learnPDAG_(), scoreDatabase_, and gum::learning::IDatabaseTable< T_DATA >::variableName().
|
protectedinherited |
Definition at line 923 of file IBNLearner.cpp.
References algoFCI_, algoMiic_, algoPC_, gum::learning::IBNLearner::Database::databaseTable(), FCI, GUM_ERROR, gum::learning::IDatabaseTable< T_DATA >::hasMissingValues(), gum::learning::ConstraintBasedLearning::learnPDAG(), MIIC, mutualInfo_, PC, prepareFCI_(), prepareMiic_(), preparePC_(), scoreDatabase_, selectedAlgo_, and gum::learning::Miic::setMutualInformation().
Referenced by learnPDAG().
|
inherited |
Return the loglikelihood of vars in the base, conditioned by knowing for the BNLearner.
| vars | a vector of NodeIds |
| knowing | an optional vector of conditioning NodeIds |
Definition at line 1404 of file IBNLearner.cpp.
References gum::learning::IdCondSet::IdCondSet(), createPrior_(), databaseRanges(), gum::learning::IBNLearner::Database::parser(), prior_, gum::learning::ScoreLog2Likelihood::score(), and scoreDatabase_.
Referenced by logLikelihood().
|
inherited |
Return the loglikelihood of vars in the base, conditioned by knowing for the BNLearner.
| vars | a vector of name of rows |
| knowing | an optional vector of conditioning rows |
Definition at line 1420 of file IBNLearner.cpp.
References idFromName(), and logLikelihood().
|
overridevirtualinherited |
Implements gum::IApproximationSchemeConfiguration.
Definition at line 900 of file IBNLearner_inl.h.
References currentAlgorithm_, GUM_ERROR, and gum::ApproximationScheme::maxIter().
Referenced by createPrior_().
|
overridevirtualinherited |
returns the timeout (in seconds)
Implements gum::IApproximationSchemeConfiguration.
Definition at line 931 of file IBNLearner_inl.h.
References currentAlgorithm_, GUM_ERROR, and gum::ApproximationScheme::maxTime().
Referenced by createPrior_().
|
inherited |
Returns the approximation scheme message.
Definition at line 64 of file IApproximationSchemeConfiguration.cpp.
References Continue, Epsilon, epsilon(), Limit, maxIter(), maxTime(), minEpsilonRate(), Rate, stateApproximationScheme(), Stopped, TimeLimit, and Undefined.
Referenced by gum::ApproximationScheme::continueApproximationScheme(), gum::learning::IBNLearner::EMStateMessage(), and gum::credal::InferenceEngine< GUM_SCALAR >::getApproximationSchemeMsg().
|
overridevirtualinherited |
Get the value of the minimal epsilon rate.
Implements gum::IApproximationSchemeConfiguration.
Definition at line 869 of file IBNLearner_inl.h.
References currentAlgorithm_, GUM_ERROR, and gum::ApproximationScheme::minEpsilonRate().
Referenced by createPrior_().
|
inherited |
Return the mutual information of id1 and id2 in the base, conditioned by knowing for the BNLearner.
| id1 | nodeId |
| id2 | nodeId |
| knowing | an optional vector of conditioning NodeIds |
Definition at line 1470 of file IBNLearner.cpp.
References gum::learning::NoPrior::NoPrior(), databaseRanges(), gum::learning::IBNLearner::Database::databaseTable(), gum::learning::IBNLearner::Database::nodeId2Columns(), gum::learning::IBNLearner::Database::parser(), gum::learning::CorrectedMutualInformation::score(), scoreDatabase_, gum::learning::CorrectedMutualInformation::useNoCorr(), and gum::learning::IBNLearner::Database::weight().
Referenced by mutualInformation().
|
inherited |
Return the mutual information of var1 and var2 in the base, conditioned by knowing for the BNLearner.
| var1 | name of a row |
| var2 | name of a row |
| knowing | an optional vector of conditioning rows |
Definition at line 1481 of file IBNLearner.cpp.
References idFromName(), and mutualInformation().
|
inherited |
returns the variable name corresponding to a given node id
Definition at line 142 of file IBNLearner_inl.h.
References gum::learning::IBNLearner::Database::nameFromId(), and scoreDatabase_.
|
inherited |
returns the names of the variables in the database
Definition at line 751 of file IBNLearner_inl.h.
References gum::learning::IBNLearner::Database::names(), and scoreDatabase_.
|
inherited |
Definition at line 782 of file IBNLearner_inl.h.
References gum::learning::IBNLearner::Database::domainSizes(), and scoreDatabase_.
|
overridevirtualinherited |
| OperationNotAllowed | if scheme not performed |
Implements gum::IApproximationSchemeConfiguration.
Definition at line 990 of file IBNLearner_inl.h.
References currentAlgorithm_, GUM_ERROR, and gum::ApproximationScheme::nbrIterations().
Referenced by createPrior_().
|
inherited |
Definition at line 784 of file IBNLearner_inl.h.
References gum::learning::IBNLearner::Database::databaseTable(), scoreDatabase_, and gum::learning::IDatabaseTable< T_DATA >::size().
|
noexcept |
| BNLearner & gum::learning::BNLearner< GUM_SCALAR >::operator= | ( | const BNLearner< GUM_SCALAR > & | ) |
|
overridevirtualinherited |
how many samples between 2 stopping isEnableds
| OutOfBounds | if p<1 |
Implements gum::IApproximationSchemeConfiguration.
Definition at line 967 of file IBNLearner_inl.h.
References currentAlgorithm_, GUM_ERROR, and gum::ApproximationScheme::periodSize().
Referenced by createPrior_().
|
staticinherited |
the algorithm used by the learners when none is selected explicitly
It is read from the configuration key "learning" / "BNLearnerPreferredAlgo". A learner takes it when it is constructed and does not follow later changes of the configuration. K2 cannot be the preferred algorithm since it requires an order.
| InvalidArgument | if the configured name is not a known algorithm |
Definition at line 910 of file IBNLearner.cpp.
References gum::config(), EXTENDED_GREEDY_HILL_CLIMBING, FCI, GREEDY_HILL_CLIMBING, GREEDY_THICK_THINNING, GUM_ERROR, LOCAL_SEARCH_WITH_TABU_LIST, MIIC, PC, and gum::Configuration::typed().
|
protectedinherited |
prepares the initial graph and independence test for FCI
Definition at line 820 of file IBNLearner.cpp.
References gum::learning::IndepTestChi2::IndepTestChi2(), gum::learning::IndepTestG2::IndepTestG2(), gum::DAG::addArc(), gum::DiGraph::addArc(), gum::UndiGraph::addEdge(), gum::NodeGraphPart::addNodeWithId(), algoFCI_, alphaFci_, gum::learning::StructuralConstraintForbiddenArcs::arcs(), gum::learning::StructuralConstraintMandatoryArcs::arcs(), Chi2, constraintForbiddenArcs_, constraintIndegree_, constraintMandatoryArcs_, constraintNoChildrenNodes_, constraintNoParentNodes_, constraintPossibleEdges_, constraintSliceOrder_, constraintTotalOrder_, gum::learning::IBNLearner::Database::databaseTable(), gum::learning::StructuralConstraintPossibleEdges::edges(), gum::Set< Key >::empty(), exhaustiveSepSetFci_, indepTestFCI_, indepTestTypeFCI_, gum::learning::StructuralConstraintIndegree::maxIndegree(), maxPathLengthFci_, gum::learning::IBNLearner::Database::nodeId2Columns(), gum::learning::StructuralConstraintNoChildrenNodes::nodes(), gum::learning::StructuralConstraintNoParentNodes::nodes(), gum::NodeGraphPart::nodes(), noPrior_, gum::learning::IBNLearner::Database::parser(), ranges_, scoreDatabase_, gum::learning::CIBasedLearning::setAlpha(), gum::learning::CIBasedLearning::setExhaustiveSepSet(), gum::learning::ConstraintBasedLearning::setForbiddenGraph(), gum::learning::CIBasedLearning::setIndependenceTest(), gum::learning::ConstraintBasedLearning::setMandatoryGraph(), gum::learning::ConstraintBasedLearning::setMaxIndegree(), gum::learning::FCI::setMaxPathLength(), gum::learning::StructuralConstraintSliceOrder::sliceOrder(), and gum::learning::StructuralConstraintTotalOrder::totalOrder().
Referenced by createPrior_(), learnDag_(), learnPAG_(), and learnPDAG_().
|
protectedinherited |
prepares the initial graph for miic
Definition at line 628 of file IBNLearner.cpp.
References gum::DAG::addArc(), gum::DiGraph::addArc(), gum::learning::ConstraintBasedLearning::addConstraints(), gum::UndiGraph::addEdge(), gum::NodeGraphPart::addNodeWithId(), algoMiic_, gum::learning::StructuralConstraintForbiddenArcs::arcs(), gum::learning::StructuralConstraintMandatoryArcs::arcs(), constraintForbiddenArcs_, constraintIndegree_, constraintMandatoryArcs_, constraintNoChildrenNodes_, constraintNoParentNodes_, constraintPossibleEdges_, constraintSliceOrder_, constraintTotalOrder_, createCorrectedMutualInformation_(), gum::learning::IBNLearner::Database::databaseTable(), gum::learning::StructuralConstraintPossibleEdges::edges(), gum::Set< Key >::empty(), gum::learning::StructuralConstraintIndegree::maxIndegree(), gum::learning::StructuralConstraintNoChildrenNodes::nodes(), gum::learning::StructuralConstraintNoParentNodes::nodes(), gum::NodeGraphPart::nodes(), scoreDatabase_, gum::learning::ConstraintBasedLearning::setForbiddenGraph(), gum::learning::ConstraintBasedLearning::setMandatoryGraph(), gum::learning::ConstraintBasedLearning::setMaxIndegree(), gum::learning::StructuralConstraintSliceOrder::sliceOrder(), and gum::learning::StructuralConstraintTotalOrder::totalOrder().
Referenced by createPrior_(), learnDag_(), and learnPDAG_().
|
protectedinherited |
prepares the initial graph and independence test for PC
Definition at line 727 of file IBNLearner.cpp.
References gum::learning::IndepTestChi2::IndepTestChi2(), gum::learning::IndepTestG2::IndepTestG2(), gum::DAG::addArc(), gum::DiGraph::addArc(), gum::UndiGraph::addEdge(), gum::NodeGraphPart::addNodeWithId(), algoPC_, alphaPc_, gum::learning::StructuralConstraintForbiddenArcs::arcs(), gum::learning::StructuralConstraintMandatoryArcs::arcs(), Chi2, constraintForbiddenArcs_, constraintIndegree_, constraintMandatoryArcs_, constraintNoChildrenNodes_, constraintNoParentNodes_, constraintPossibleEdges_, constraintSliceOrder_, constraintTotalOrder_, gum::learning::IBNLearner::Database::databaseTable(), gum::learning::StructuralConstraintPossibleEdges::edges(), gum::Set< Key >::empty(), indepTestPC_, indepTestTypePC_, maxCondSetSizePc_, gum::learning::StructuralConstraintIndegree::maxIndegree(), gum::learning::IBNLearner::Database::nodeId2Columns(), gum::learning::StructuralConstraintNoChildrenNodes::nodes(), gum::learning::StructuralConstraintNoParentNodes::nodes(), gum::NodeGraphPart::nodes(), noPrior_, gum::learning::IBNLearner::Database::parser(), ranges_, scoreDatabase_, gum::learning::CIBasedLearning::setAlpha(), gum::learning::ConstraintBasedLearning::setForbiddenGraph(), gum::learning::CIBasedLearning::setIndependenceTest(), gum::learning::ConstraintBasedLearning::setMandatoryGraph(), gum::learning::CIBasedLearning::setMaxCondSetSize(), gum::learning::ConstraintBasedLearning::setMaxIndegree(), gum::learning::CIBasedLearning::setStable(), gum::learning::CIBasedLearning::setUCPriority(), gum::learning::StructuralConstraintSliceOrder::sliceOrder(), gum::learning::CIBasedLearning::Sorted, sortedUCPc_, stablePc_, gum::learning::CIBasedLearning::Standard, and gum::learning::StructuralConstraintTotalOrder::totalOrder().
Referenced by createPrior_(), learnDag_(), and learnPDAG_().
|
inherited |
Return the pseudo-counts of NodeIds vars in the base in a raw array.
| vars | a vector of |
Definition at line 1511 of file IBNLearner.cpp.
References createPrior_(), databaseRanges(), gum::learning::PseudoCount::get(), GUM_ERROR, hasMissingValues(), gum::learning::IBNLearner::Database::parser(), prior_, scoreDatabase_, and gum::Tensor< double >.
Referenced by rawPseudoCount().
|
inherited |
Return the pseudoconts of vars in the base in a raw array.
| vars | a vector of name |
Definition at line 1526 of file IBNLearner.cpp.
References idFromName(), and rawPseudoCount().
|
staticprotectedinherited |
reads a file and returns a databaseVectInRam
Definition at line 491 of file IBNLearner.cpp.
References database(), gum::learning::IDBInitializer::fillDatabase(), gum::learning::DBTranslatorSet::insertTranslator(), isCSVFileName_(), gum::learning::DatabaseTable::reorder(), gum::learning::DatabaseTable::setVariableNames(), and gum::learning::IDBInitializer::variableNames().
Referenced by gum::learning::IBNLearner::Database::Database().
|
inherited |
returns the weight of the ith record
| OutOfBounds | if i is outside the set of indices of the records |
Definition at line 157 of file IBNLearner_inl.h.
References scoreDatabase_, and gum::learning::IBNLearner::Database::weight().
|
inherited |
Return the value of the score currently in use by the BNLearner of a variable given a set of other variables.
| var | the NodeId of the LHS variable |
| knowing | an optional vector of conditioning variables, specified by their NodeIds |
Definition at line 1493 of file IBNLearner.cpp.
References createPrior_(), createScore_(), gum::learning::Score::score(), and score_.
Referenced by score(), and useDatabaseRanges().
|
inherited |
Return the value of the score currently in use by the BNLearner of a variable given a set of other variables The score used is the one currently selected in the BNLearner.
| var | the name of the variable |
| knowing | an optional vector of conditioning variables, specified by their names |
Definition at line 1500 of file IBNLearner.cpp.
References idFromName(), and score().
|
inherited |
{@ /// distribute signals
Definition at line 813 of file IBNLearner_inl.h.
References currentAlgorithm_.
Referenced by gum::learning::BNLearnerListener::BNLearnerListener(), createPrior_(), distributeProgress(), and distributeStop().
|
inherited |
assign a weight to all the rows of the learning database so that the sum of their weights is equal to new_weight
assign new weight to the rows of the learning database
Definition at line 147 of file IBNLearner_inl.h.
References scoreDatabase_, and gum::learning::IBNLearner::Database::setDatabaseWeight().
|
overridevirtualinherited |
Given that we approximate f(t), stopping criterion on |f(t+1)-f(t)| If the criterion was disabled it will be enabled.
| OutOfBounds | if eps<0 |
Implements gum::IApproximationSchemeConfiguration.
Definition at line 831 of file IBNLearner_inl.h.
References algoK2_, gum::learning::K2::approximationScheme(), dag2BN_, greedyHillClimbing_, localSearchWithTabuList_, gum::ApproximationScheme::setEpsilon(), and gum::learning::EMApproximationScheme::setEpsilon().
Referenced by createPrior_().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::setFCIAlpha | ( | double | alpha | ) |
References BNLearner(), and setFCIAlpha().
Referenced by setFCIAlpha().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::setFCIExhaustiveSepSet | ( | bool | exhaustive | ) |
References BNLearner(), and setFCIExhaustiveSepSet().
Referenced by setFCIExhaustiveSepSet().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::setFCIMaxPathLength | ( | Size | max_len | ) |
References BNLearner(), and setFCIMaxPathLength().
Referenced by setFCIMaxPathLength().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::setForbiddenArcs | ( | const ArcSet & | set | ) |
References BNLearner(), and setForbiddenArcs().
Referenced by setForbiddenArcs().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::setGreedyThickThinningReversals | ( | bool | allow | ) |
References BNLearner(), and setGreedyThickThinningReversals().
Referenced by setGreedyThickThinningReversals().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::setInitialDAG | ( | const DAG & | dag | ) |
References BNLearner(), and setInitialDAG().
Referenced by setInitialDAG().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::setMandatoryArcs | ( | const ArcSet & | set | ) |
References BNLearner(), and setMandatoryArcs().
Referenced by setMandatoryArcs().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::setMaxIndegree | ( | Size | max_indegree | ) |
References BNLearner(), and setMaxIndegree().
Referenced by setMaxIndegree().
|
overridevirtualinherited |
stopping criterion on number of iterationsIf the criterion was disabled it will be enabled
| max | The maximum number of iterations |
| OutOfBounds | if max<=1 |
Implements gum::IApproximationSchemeConfiguration.
Definition at line 893 of file IBNLearner_inl.h.
References algoK2_, gum::learning::K2::approximationScheme(), dag2BN_, greedyHillClimbing_, localSearchWithTabuList_, and gum::ApproximationScheme::setMaxIter().
Referenced by createPrior_().
|
overridevirtualinherited |
stopping criterion on timeout If the criterion was disabled it will be enabled
| OutOfBounds | if timeout<=0.0 timeout is time in second (double). |
Implements gum::IApproximationSchemeConfiguration.
Definition at line 924 of file IBNLearner_inl.h.
References algoK2_, gum::learning::K2::approximationScheme(), dag2BN_, greedyHillClimbing_, localSearchWithTabuList_, and gum::ApproximationScheme::setMaxTime().
Referenced by createPrior_().
|
overridevirtualinherited |
Given that we approximate f(t), stopping criterion on d/dt(|f(t+1)-f(t)|) If the criterion was disabled it will be enabled.
| OutOfBounds | if rate<0 |
Implements gum::IApproximationSchemeConfiguration.
Definition at line 862 of file IBNLearner_inl.h.
References algoK2_, gum::learning::K2::approximationScheme(), dag2BN_, greedyHillClimbing_, localSearchWithTabuList_, gum::ApproximationScheme::setMinEpsilonRate(), and gum::learning::EMApproximationScheme::setMinEpsilonRate().
Referenced by createPrior_().
|
overridevirtualinherited |
sets the number max of threads that can be used
| nb | the number max of threads to be used. If this number is set to 0, then it is defaulted to aGrUM's max number of threads |
Implements gum::IThreadNumberManager.
Definition at line 787 of file IBNLearner_inl.h.
References score_, gum::learning::Score::setNumberOfThreads(), and gum::ThreadNumberManager::setNumberOfThreads().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::setPCAlpha | ( | double | alpha | ) |
References BNLearner(), and setPCAlpha().
Referenced by setPCAlpha().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::setPCMaxCondSetSize | ( | Size | max_k | ) |
References BNLearner(), and setPCMaxCondSetSize().
Referenced by setPCMaxCondSetSize().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::setPCStable | ( | bool | stable | ) |
References BNLearner(), and setPCStable().
Referenced by setPCStable().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::setPCUnshieldedColliderSorted | ( | bool | sorted | ) |
References BNLearner(), and setPCUnshieldedColliderSorted().
Referenced by setPCUnshieldedColliderSorted().
|
overridevirtualinherited |
how many samples between 2 stopping isEnableds
| OutOfBounds | if p<1 |
Implements gum::IApproximationSchemeConfiguration.
Definition at line 960 of file IBNLearner_inl.h.
References algoK2_, gum::learning::K2::approximationScheme(), dag2BN_, greedyHillClimbing_, localSearchWithTabuList_, and gum::ApproximationScheme::setPeriodSize().
Referenced by createPrior_().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::setPossibleEdges | ( | const EdgeSet & | set | ) |
References BNLearner(), and setPossibleEdges().
Referenced by setPossibleEdges().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::setPossibleSkeleton | ( | const UndiGraph & | skeleton | ) |
References BNLearner(), and setPossibleSkeleton().
Referenced by setPossibleSkeleton().
|
inherited |
sets the weight of the ith record of the database
assign new weight to the ith row of the learning database
| OutOfBounds | if i is outside the set of indices of the records or if the weight is negative |
Definition at line 152 of file IBNLearner_inl.h.
References scoreDatabase_, and gum::learning::IBNLearner::Database::setWeight().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::setSliceOrder | ( | const NodeProperty< NodeId > & | slice_order | ) |
References BNLearner(), and setSliceOrder().
Referenced by setSliceOrder(), and setSliceOrder().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::setSliceOrder | ( | const std::vector< std::vector< std::string > > & | slices | ) |
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::setTotalOrder | ( | const Sequence< NodeId > & | order | ) |
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::setTotalOrder | ( | const std::vector< std::string > & | order | ) |
References BNLearner(), and setTotalOrder().
Referenced by setTotalOrder(), and setTotalOrder().
|
overridevirtualinherited |
verbosity
Implements gum::IApproximationSchemeConfiguration.
Definition at line 972 of file IBNLearner_inl.h.
References algoK2_, gum::learning::K2::approximationScheme(), dag2BN_, greedyHillClimbing_, localSearchWithTabuList_, and gum::ApproximationScheme::setVerbosity().
Referenced by createPrior_().
| std::vector< std::tuple< std::string, std::string, std::string > > gum::learning::BNLearner< GUM_SCALAR >::state | ( | ) | const |
|
overridevirtualinherited |
history
Implements gum::IApproximationSchemeConfiguration.
Definition at line 985 of file IBNLearner_inl.h.
References currentAlgorithm_, GUM_ERROR, and gum::ApproximationScheme::stateApproximationScheme().
Referenced by createPrior_().
| std::string gum::learning::BNLearner< GUM_SCALAR >::toString | ( | ) | const |
References toString().
Referenced by toString().
|
inherited |
removes the slice order constraint
The methd is useful if you had previously added a slice order constraint and you do not want to use it anymore
Definition at line 655 of file IBNLearner_inl.h.
References setSliceOrder().
|
inherited |
removes the current total ordering constraint, if any
Definition at line 672 of file IBNLearner_inl.h.
References setTotalOrder().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useBDeuPrior | ( | ) |
use the BDeu prior with the default weight (key priorWeight of the section learning)
References BNLearner(), and useBDeuPrior().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useBDeuPrior | ( | double | weight | ) |
References BNLearner(), and useBDeuPrior().
Referenced by useBDeuPrior(), and useBDeuPrior().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useChi2Test | ( | ) |
References BNLearner(), and useChi2Test().
Referenced by useChi2Test().
|
inherited |
sets the ranges of rows to be used for cross-validation learning
When applied on (x,k), the method indicates to the subsequent learnings that they should be performed on the xth fold in a k-fold cross-validation context. For instance, if a database has 1000 rows, and if we perform a 10-fold cross-validation, then, the first learning fold (learning_fold=0) corresponds to rows interval [100,1000) and the test dataset corresponds to [0,100). The second learning fold (learning_fold=1) is [0,100) U [200,1000) and the corresponding test dataset is [100,200).
| learning_fold | a number indicating the set of rows used for learning. If N denotes the size of the database, and k_fold represents the number of folds in the cross validation, then the set of rows used for testing is [learning_fold * N / k_fold, (learning_fold+1) * N / k_fold) and the learning database is the complement in the database |
| k_fold | the value of "k" in k-fold cross validation |
| OutOfBounds | is raised if k_fold is equal to 0 or learning_fold is greater than or eqal to k_fold, or if k_fold is greater than or equal to the size of the database. |
Definition at line 1329 of file IBNLearner.cpp.
References gum::learning::IBNLearner::Database::databaseTable(), GUM_ERROR, gum::learning::IDatabaseTable< T_DATA >::nbRows(), ranges_, and scoreDatabase_.
|
inherited |
use a new set of database rows' ranges to perform learning
| ranges | a set of pairs {(X1,Y1),...,(Xn,Yn)} of database's rows indices. The subsequent learnings are then performed only on the union of the rows [Xi,Yi), i in {1,...,n}. This is useful, e.g, when performing cross validation tasks, in which part of the database should be ignored. An empty set of ranges is equivalent to an interval [X,Y) ranging over the whole database. |
Definition at line 1536 of file IBNLearner.cpp.
References noPrior_, gum::learning::IBNLearner::Database::parser(), gum::learning::Score::ranges(), ranges_, score(), scoreDatabase_, and gum::learning::Score::setRanges().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useDirichletPrior | ( | const gum::BayesNet< GUM_SCALAR > & | bn | ) |
use the Dirichlet prior from a BN with the default weight (key priorWeight)
References BNLearner(), and useDirichletPrior().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useDirichletPrior | ( | const gum::BayesNet< GUM_SCALAR > & | bn, |
| double | weight ) |
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useDirichletPrior | ( | std::string_view | filename | ) |
use the Dirichlet prior from a database with the default weight (key priorWeight)
References BNLearner(), and useDirichletPrior().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useDirichletPrior | ( | std::string_view | filename, |
| double | weight ) |
References BNLearner(), and useDirichletPrior().
Referenced by useDirichletPrior(), useDirichletPrior(), useDirichletPrior(), and useDirichletPrior().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useEM | ( | const double | epsilon | ) |
use The EM algorithm to learn parameters with the default noise (key emNoise of the section learning of gum::Configuration)
References BNLearner(), gum::learning::IBNLearner::epsilon(), and useEM().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useEM | ( | const double | epsilon, |
| const double | noise ) |
use The EM algorithm to learn parameters
This is essentially an alias for Method useEMWithRateCriterion().
| epsilon | sets the approximation stopping criterion: EM stops whenever the absolute value of the relative difference between two consecutive log-likelihoods drops below epsilon. Note that epsilon=0 is considered as a directive to not use EM. However, if you wish to forbid the use of EM, prefer executing Method forbidEM() rather than useEM(0) as it is more unequivocal. |
| noise | When EM starts, it initializes all the CPTs of the Bayes net. EM adds a noise to these CPTs by mixing their values with some random noise. The formula used is, up to some normalizing constant: new_cpt = (1-noise) * cpt + noise * random_cpt(). Of course, noise must belong to interval [0,1]. |
| OutOfBounds | is raised if epsilon is strictly negative or if noise does not belong to interval [0,1]. |
References BNLearner(), gum::learning::IBNLearner::epsilon(), and useEM().
Referenced by useEM(), and useEM().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useEMWithDiffCriterion | ( | const double | epsilon | ) |
use The EM algorithm with the diff stopping criterion and the default noise (key emNoise)
References BNLearner(), gum::learning::IBNLearner::epsilon(), and useEMWithDiffCriterion().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useEMWithDiffCriterion | ( | const double | epsilon, |
| const double | noise ) |
use The EM algorithm to learn parameters with the diff stopping criterion
| epsilon | epsilon sets the approximation stopping criterion: EM stops whenever the difference between two consecutive log-likelihoods drops below epsilon. Note that, for using EM, epsilon should be strictly positive. |
| noise | When EM starts, it initializes all the CPTs of the Bayes net. EM adds a noise to these CPTs by mixing their values with some random noise. The formula used is, up to some normalizing constant: new_cpt = (1-noise) * cpt + noise * random_cpt(). Of course, noise must belong to interval [0,1]. |
| OutOfBounds | is raised if epsilon is not strictly positive or if noise does not belong to interval [0,1]. |
References BNLearner(), gum::learning::IBNLearner::epsilon(), and useEMWithDiffCriterion().
Referenced by useEMWithDiffCriterion(), and useEMWithDiffCriterion().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useEMWithRateCriterion | ( | const double | epsilon | ) |
use The EM algorithm with the rate stopping criterion and the default noise (key emNoise)
References BNLearner(), gum::learning::IBNLearner::epsilon(), and useEMWithRateCriterion().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useEMWithRateCriterion | ( | const double | epsilon, |
| const double | noise ) |
use The EM algorithm to learn parameters with the rate stopping criterion
| epsilon | epsilon sets the approximation stopping criterion: EM stops whenever the absolute value of the relative difference between two consecutive log-likelihoods drops below epsilon. Note that, for using EM, epsilon should be strictly positive. |
| max_nb_iter | the maximum number of EM iterations allowed. If equal to 0, this stopping criterion is unused. |
| noise | When EM starts, it initializes all the CPTs of the Bayes net. EM adds a noise to these CPTs by mixing their values with some random noise. The formula used is, up to some normalizing constant: new_cpt = (1-noise) * cpt + noise * random_cpt(). Of course, noise must belong to interval [0,1]. |
| OutOfBounds | is raised if epsilon is not strictly positive or if noise does not belong to interval [0,1]. |
References BNLearner(), gum::learning::IBNLearner::epsilon(), and useEMWithRateCriterion().
Referenced by useEMWithRateCriterion(), and useEMWithRateCriterion().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useExtendedGreedyHillClimbing | ( | ) |
References BNLearner(), and useExtendedGreedyHillClimbing().
Referenced by useExtendedGreedyHillClimbing().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useFCI | ( | ) |
References BNLearner(), and useFCI().
Referenced by useFCI().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useFCIChi2Test | ( | ) |
References BNLearner(), and useFCIChi2Test().
Referenced by useFCIChi2Test().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useFCIG2Test | ( | ) |
References BNLearner(), and useFCIG2Test().
Referenced by useFCIG2Test().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useG2Test | ( | ) |
References BNLearner(), and useG2Test().
Referenced by useG2Test().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useGreedyHillClimbing | ( | ) |
References BNLearner(), and useGreedyHillClimbing().
Referenced by useGreedyHillClimbing().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useGreedyThickThinning | ( | ) |
References BNLearner(), and useGreedyThickThinning().
Referenced by useGreedyThickThinning().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useK2 | ( | const Sequence< NodeId > & | order | ) |
References BNLearner(), and useK2().
Referenced by useK2(), and useK2().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useK2 | ( | const std::vector< NodeId > & | order | ) |
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useLocalSearchWithTabuList | ( | ) |
use a local search with tabu list and the default parameters (keys tabuListSize and tabuNbDecrease)
References BNLearner(), and useLocalSearchWithTabuList().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useLocalSearchWithTabuList | ( | Size | tabu_size | ) |
use a local search with tabu list, with the default number of decreasing changes (key tabuNbDecrease of the section learning of gum::Configuration)
References BNLearner(), and useLocalSearchWithTabuList().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useLocalSearchWithTabuList | ( | Size | tabu_size, |
| Size | nb_decrease ) |
References BNLearner(), and useLocalSearchWithTabuList().
Referenced by useLocalSearchWithTabuList(), useLocalSearchWithTabuList(), and useLocalSearchWithTabuList().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useMDLCorrection | ( | ) |
References BNLearner(), and useMDLCorrection().
Referenced by useMDLCorrection().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useMIIC | ( | ) |
References BNLearner(), and useMIIC().
Referenced by useMIIC().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useNMLCorrection | ( | ) |
References BNLearner(), and useNMLCorrection().
Referenced by useNMLCorrection().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useNoCorrection | ( | ) |
References BNLearner(), and useNoCorrection().
Referenced by useNoCorrection().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useNoPrior | ( | ) |
References BNLearner(), and useNoPrior().
Referenced by useNoPrior().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::usePC | ( | ) |
References BNLearner(), and usePC().
Referenced by usePC().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useScoreAIC | ( | ) |
References BNLearner(), and useScoreAIC().
Referenced by useScoreAIC().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useScoreBD | ( | ) |
References BNLearner(), and useScoreBD().
Referenced by useScoreBD().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useScoreBDeu | ( | ) |
References BNLearner(), and useScoreBDeu().
Referenced by useScoreBDeu().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useScoreBIC | ( | ) |
References BNLearner(), and useScoreBIC().
Referenced by useScoreBIC().
|
inherited |
indicate that we wish to use a fNML score
Definition at line 194 of file IBNLearner_inl.h.
References checkScorePriorCompatibility(), fNML, and scoreType_.
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useScoreK2 | ( | ) |
References BNLearner(), and useScoreK2().
Referenced by useScoreK2().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useScoreLog2Likelihood | ( | ) |
References BNLearner(), and useScoreLog2Likelihood().
Referenced by useScoreLog2Likelihood().
|
inherited |
indicate that we wish to use a MDL score
Definition at line 212 of file IBNLearner_inl.h.
References checkScorePriorCompatibility(), MDL, and scoreType_.
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useSmoothingPrior | ( | ) |
use the smoothing prior with the default weight (key priorWeight)
References BNLearner(), and useSmoothingPrior().
| BNLearner< GUM_SCALAR > & gum::learning::BNLearner< GUM_SCALAR >::useSmoothingPrior | ( | double | weight | ) |
References BNLearner(), and useSmoothingPrior().
Referenced by useSmoothingPrior(), and useSmoothingPrior().
|
overridevirtualinherited |
verbosity
Implements gum::IApproximationSchemeConfiguration.
Definition at line 979 of file IBNLearner_inl.h.
References currentAlgorithm_, GUM_ERROR, and gum::ApproximationScheme::verbosity().
Referenced by createPrior_().
|
privateinherited |
the max number of threads used by the class
Definition at line 126 of file threadNumberManager.h.
|
private |
Definition at line 569 of file BNLearner.h.
|
protectedinherited |
the FCI algorithm
Definition at line 1263 of file IBNLearner.h.
Referenced by learnDag_(), learnPAG_(), learnPDAG_(), and prepareFCI_().
|
protectedinherited |
the K2 algorithm
Definition at line 1236 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), disableEpsilon(), disableMaxIter(), disableMaxTime(), disableMinEpsilonRate(), enableEpsilon(), enableMaxIter(), enableMaxTime(), enableMinEpsilonRate(), learnDag_(), operator=(), operator=(), setEpsilon(), setMaxIter(), setMaxTime(), setMinEpsilonRate(), setPeriodSize(), setVerbosity(), useK2(), and useK2().
|
protectedinherited |
the Constraint MIIC algorithm
Definition at line 1239 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), latentVariables(), learnDag_(), learnPDAG_(), operator=(), operator=(), and prepareMiic_().
|
protectedinherited |
the PC algorithm
Definition at line 1246 of file IBNLearner.h.
Referenced by learnDag_(), learnPDAG_(), and preparePC_().
|
protectedinherited |
whether we allow or not arc additions during learning
Definition at line 1224 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), allowArcAdditions(), learnDag_(), operator=(), and operator=().
|
protectedinherited |
whether we allow or not arc deletions during learning
Definition at line 1227 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), allowArcDeletions(), learnDag_(), operator=(), and operator=().
|
protectedinherited |
whether we allow or not arc reversals during learning
Definition at line 1230 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), allowArcReversals(), learnDag_(), operator=(), and operator=().
|
protectedinherited |
whether we allow or not arc deletions during learning
Definition at line 1233 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), allowArcTriangleDeletions(), learnDag_(), operator=(), and operator=().
|
protectedinherited |
FCI parameters the threshold of the tests ; it is initialized from the key learning.alpha.
Definition at line 1273 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), operator=(), operator=(), prepareFCI_(), and setFCIAlpha().
|
protectedinherited |
PC parameters the threshold of the tests ; it is initialized from the key learning.alpha.
Definition at line 1257 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), operator=(), operator=(), preparePC_(), and setPCAlpha().
|
protectedinherited |
the constraint on forbidden arcs
Definition at line 1206 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), addForbiddenArc(), eraseForbiddenArc(), learnDag_(), operator=(), operator=(), prepareFCI_(), prepareMiic_(), preparePC_(), and setForbiddenArcs().
|
protectedinherited |
the constraint for indegrees
Definition at line 1200 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), learnDag_(), operator=(), operator=(), prepareFCI_(), prepareMiic_(), preparePC_(), and setMaxIndegree().
|
protectedinherited |
the constraint on mandatory arcs
Definition at line 1212 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), addMandatoryArc(), eraseMandatoryArc(), learnDag_(), operator=(), operator=(), prepareFCI_(), prepareMiic_(), preparePC_(), and setMandatoryArcs().
|
protectedinherited |
the constraint on no children nodes
Definition at line 1218 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), addNoChildrenNode(), eraseNoChildrenNode(), learnDag_(), operator=(), operator=(), prepareFCI_(), prepareMiic_(), and preparePC_().
|
protectedinherited |
the constraint on no parent nodes
Definition at line 1215 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), addNoParentNode(), eraseNoParentNode(), learnDag_(), operator=(), operator=(), prepareFCI_(), prepareMiic_(), and preparePC_().
|
protectedinherited |
the constraint on possible Edges
Definition at line 1209 of file IBNLearner.h.
Referenced by addPossibleEdge(), erasePossibleEdge(), learnDag_(), prepareFCI_(), prepareMiic_(), preparePC_(), and setPossibleEdges().
|
protectedinherited |
the constraint for 2TBNs
Definition at line 1194 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), learnDag_(), operator=(), operator=(), prepareFCI_(), prepareMiic_(), preparePC_(), and setSliceOrder().
|
protectedinherited |
the constraint for tabu lists
Definition at line 1203 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), learnDag_(), operator=(), operator=(), and useLocalSearchWithTabuList().
|
protectedinherited |
the total order ing constraint
Definition at line 1197 of file IBNLearner.h.
Referenced by learnDag_(), prepareFCI_(), prepareMiic_(), preparePC_(), and setTotalOrder().
|
protectedinherited |
Definition at line 1317 of file IBNLearner.h.
Referenced by currentTime(), epsilon(), history(), isEnabledEpsilon(), isEnabledMaxIter(), isEnabledMaxTime(), isEnabledMinEpsilonRate(), maxIter(), maxTime(), minEpsilonRate(), nbrIterations(), operator=(), operator=(), periodSize(), setCurrentApproximationScheme(), stateApproximationScheme(), and verbosity().
|
protectedinherited |
the parametric EM
Definition at line 1278 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), disableEpsilon(), disableMaxIter(), disableMaxTime(), disableMinEpsilonRate(), EM(), EMCurrentTime(), EMdisableEpsilon(), EMdisableMaxIter(), EMdisableMaxTime(), EMdisableMinEpsilonRate(), EMenableEpsilon(), EMenableMaxIter(), EMenableMaxTime(), EMenableMinEpsilonRate(), EMEpsilon(), EMHistory(), EMisEnabledEpsilon(), EMisEnabledMaxIter(), EMisEnabledMaxTime(), EMisEnabledMinEpsilonRate(), EMMaxIter(), EMMaxTime(), EMMinEpsilonRate(), EMnbrIterations(), EMPeriodSize(), EMsetEpsilon(), EMsetMaxIter(), EMsetMaxTime(), EMsetMinEpsilonRate(), EMsetPeriodSize(), EMsetVerbosity(), EMState(), EMStateApproximationScheme(), EMStateMessage(), EMVerbosity(), enableEpsilon(), enableMaxIter(), enableMaxTime(), enableMinEpsilonRate(), operator=(), operator=(), setEpsilon(), setMaxIter(), setMaxTime(), setMinEpsilonRate(), setPeriodSize(), setVerbosity(), useEM(), and useEMWithDiffCriterion().
|
protectedinherited |
Definition at line 1275 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), fciExhaustiveSepSet(), operator=(), operator=(), prepareFCI_(), and setFCIExhaustiveSepSet().
|
protectedinherited |
the extended greedy hill climbing
Definition at line 1284 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), learnDag_(), operator=(), and operator=().
|
protectedinherited |
the filename database
Definition at line 1308 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), IBNLearner(), IBNLearner(), operator=(), and operator=().
|
protectedinherited |
the greedy hill climbing algorithm
Definition at line 1281 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), disableEpsilon(), disableMaxIter(), disableMaxTime(), disableMinEpsilonRate(), enableEpsilon(), enableMaxIter(), enableMaxTime(), enableMinEpsilonRate(), learnDag_(), operator=(), operator=(), setEpsilon(), setMaxIter(), setMaxTime(), setMinEpsilonRate(), setPeriodSize(), and setVerbosity().
|
protectedinherited |
the greedy thick-thinning algorithm
Definition at line 1287 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), greedyThickThinningReversals(), learnDag_(), operator=(), operator=(), and setGreedyThickThinningReversals().
|
protectedinherited |
owned independence test object for FCI (rebuilt before each learn call)
Definition at line 1269 of file IBNLearner.h.
Referenced by ~IBNLearner(), and prepareFCI_().
|
protectedinherited |
owned independence test object for PC (rebuilt before each learn call)
Definition at line 1253 of file IBNLearner.h.
Referenced by ~IBNLearner(), and preparePC_().
|
protectedinherited |
independence test type for FCI (reuses IndepTestType defined above)
Definition at line 1266 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), operator=(), operator=(), prepareFCI_(), useFCIChi2Test(), and useFCIG2Test().
|
protectedinherited |
Definition at line 1250 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), operator=(), operator=(), preparePC_(), useChi2Test(), and useG2Test().
|
protectedinherited |
the policy for typing variables
Definition at line 1164 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), IBNLearner(), and IBNLearner().
|
protectedinherited |
an initial DAG given to learners
Definition at line 1305 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), initialDAG(), learnDag_(), operator=(), operator=(), and setInitialDAG().
|
protectedinherited |
the penalty used in MIIC
Definition at line 1242 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), correctedMutualInformation(), createCorrectedMutualInformation_(), operator=(), operator=(), useMDLCorrection(), useNMLCorrection(), and useNoCorrection().
|
protectedinherited |
the local search with tabu list algorithm
Definition at line 1290 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), disableEpsilon(), disableMaxIter(), disableMaxTime(), disableMinEpsilonRate(), enableEpsilon(), enableMaxIter(), enableMaxTime(), enableMinEpsilonRate(), learnDag_(), operator=(), operator=(), setEpsilon(), setMaxIter(), setMaxTime(), setMinEpsilonRate(), setPeriodSize(), setVerbosity(), and useLocalSearchWithTabuList().
Definition at line 1259 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), operator=(), operator=(), preparePC_(), and setPCMaxCondSetSize().
Definition at line 1274 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), operator=(), operator=(), prepareFCI_(), and setFCIMaxPathLength().
|
protectedinherited |
the selected correction for miic
Definition at line 1179 of file IBNLearner.h.
Referenced by ~IBNLearner(), createCorrectedMutualInformation_(), learnDag_(), learnPDAG_(), operator=(), and operator=().
|
protectedinherited |
Definition at line 1314 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), operator=(), operator=(), and useLocalSearchWithTabuList().
|
protectedinherited |
Definition at line 1187 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), IBNLearner(), IBNLearner(), IBNLearner(), ~IBNLearner(), createCorrectedMutualInformation_(), createParamEstimator_(), prepareFCI_(), preparePC_(), and useDatabaseRanges().
Progression, error and time.
Definition at line 81 of file IApproximationSchemeConfiguration.h.
Referenced by gum::ApproximationScheme::continueApproximationScheme(), gum::learning::IBNLearner::distributeProgress(), gum::learning::Miic::initiation_(), gum::learning::Miic::iteration_(), and gum::learning::Miic::orientationMiic_().
|
inherited |
Criteria messageApproximationScheme.
Definition at line 84 of file IApproximationSchemeConfiguration.h.
Referenced by gum::learning::IBNLearner::distributeStop().
|
protectedinherited |
the type of the parameter estimator
Definition at line 1173 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), createParamEstimator_(), operator=(), and operator=().
|
protectedinherited |
the prior used
Definition at line 1185 of file IBNLearner.h.
Referenced by ~IBNLearner(), chi2(), correctedMutualInformation(), createParamEstimator_(), createScore_(), G2(), logLikelihood(), operator=(), operator=(), and rawPseudoCount().
|
protectedinherited |
the database used by the Dirichlet a priori
Definition at line 1299 of file IBNLearner.h.
Referenced by ~IBNLearner(), learnDag_(), operator=(), and operator=().
|
protectedinherited |
the filename for the Dirichlet a priori, if any
Definition at line 1302 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), operator=(), operator=(), and useDirichletPrior().
|
protectedinherited |
the a priorselected for the score and parameters
Definition at line 1182 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), getPriorType_(), learnDag_(), operator=(), operator=(), useBDeuPrior(), useDirichletPrior(), useNoPrior(), and useSmoothingPrior().
|
protectedinherited |
the weight of the prior. It is always written by the useXxxPrior() methods, which read learning.priorWeight when no weight is given.
Definition at line 1191 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), _setPriorWeight_(), checkScorePriorCompatibility(), operator=(), and operator=().
|
protectedinherited |
the set of rows' ranges within the database in which learning is done
Definition at line 1296 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), clearDatabaseRanges(), createCorrectedMutualInformation_(), createParamEstimator_(), createScore_(), databaseRanges(), operator=(), operator=(), prepareFCI_(), preparePC_(), useCrossValidationFold(), and useDatabaseRanges().
|
protectedinherited |
the score used
Definition at line 1170 of file IBNLearner.h.
Referenced by ~IBNLearner(), createParamEstimator_(), createScore_(), learnDag_(), operator=(), operator=(), score(), and setNumberOfThreads().
|
protectedinherited |
the database to be used by the scores and parameter estimators
Definition at line 1293 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), IBNLearner(), IBNLearner(), IBNLearner(), chi2(), correctedMutualInformation(), createCorrectedMutualInformation_(), createParamEstimator_(), createScore_(), database(), databaseWeight(), domainSize(), domainSize(), domainSizes(), G2(), hasMissingValues(), idFromName(), learnDAG(), learnDag_(), learnPAG(), learnPAG_(), learnPDAG(), learnPDAG_(), logLikelihood(), mutualInformation(), nameFromId(), names(), nbCols(), nbRows(), operator=(), operator=(), prepareFCI_(), prepareMiic_(), preparePC_(), rawPseudoCount(), recordWeight(), setDatabaseWeight(), setRecordWeight(), useCrossValidationFold(), and useDatabaseRanges().
|
protectedinherited |
the score selected for learning
Definition at line 1167 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), checkScorePriorCompatibility(), createScore_(), operator=(), operator=(), useScoreAIC(), useScoreBD(), useScoreBDeu(), useScoreBIC(), useScorefNML(), useScoreK2(), useScoreLog2Likelihood(), and useScoreMDL().
|
protectedinherited |
the learning algorithm ; it is initialized from the configuration, see preferredAlgo()
Definition at line 1221 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), fciExhaustiveSepSet(), isConstraintBased(), learnDag_(), learnPAG_(), learnPDAG_(), operator=(), operator=(), setFCIAlpha(), setFCIExhaustiveSepSet(), setFCIMaxPathLength(), setPCAlpha(), setPCMaxCondSetSize(), setPCStable(), setPCUnshieldedColliderSorted(), useChi2Test(), useExtendedGreedyHillClimbing(), useFCI(), useFCIChi2Test(), useFCIG2Test(), useG2Test(), useGreedyHillClimbing(), useGreedyThickThinning(), useK2(), useK2(), useLocalSearchWithTabuList(), useMIIC(), and usePC().
|
protectedinherited |
Definition at line 1260 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), operator=(), operator=(), preparePC_(), and setPCUnshieldedColliderSorted().
|
protectedinherited |
Definition at line 1258 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), operator=(), operator=(), preparePC_(), and setPCStable().
|
protectedinherited |
Definition at line 1313 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), operator=(), operator=(), and useLocalSearchWithTabuList().
|
protectedinherited |
a Boolean indicating whether we should use EM for parameter learning or not
Definition at line 1176 of file IBNLearner.h.
Referenced by IBNLearner(), IBNLearner(), EM(), EMState(), EMStateMessage(), forbidEM(), isUsingEM(), operator=(), operator=(), useEM(), and useEMWithDiffCriterion().