|
SHOGUN
4.2.0
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
|
SHOGUN
4.2.0
|
This class implements the Classification And Regression Trees algorithm by Breiman et al for decision tree learning. A CART tree is a binary decision tree that is constructed by splitting a node into two child nodes repeatedly, beginning with the root node that contains the whole dataset.
TREE GROWING PROCESS :
During the tree growing process, we recursively split a node into left child and right child so that the resulting nodes are "purest". We do this until any of the stopping criteria is met. To find the best split, we scan through all possible splits in all predictive attributes. The best split is one that maximises some splitting criterion. For classification tasks, ie. when the dependent attribute is categorical, the Gini index is used. For regression tasks, ie. when the dependent variable is continuous, least squares deviation is used. The algorithm uses two stopping criteria : if node becomes completely "pure", ie. all its members have identical dependent variable, or all of them have identical predictive attributes (independent variables).
.
COST-COMPLEXITY PRUNING :
The maximal tree, \(T_max\) grown during tree growing process is bound to overfit. Hence pruning becomes necessary. Cost-Complexity pruning yields a list of subtrees of varying depths using the complexity normalized resubstitution error, \(R_\alpha(T)\). The resubstitution error R(T) is a measure of how well a decision tree fits the training data. This measure favours larger trees over smaller ones. However, complexity normalized resubstitution error, adds penalty for increased complexity and hence counters overfitting.
\(R_\alpha(T)=R(T)+\alpha \times (numleaves)\)
The best subtree among the list of subtrees can be chosen using cross validation or using best-fit in the test dataset.
cf. https://onlinecourses.science.psu.edu/stat557/node/93
HANDLING MISSING VALUES :
While choosing the best split at a node, missing attribute values are left out. But data vectors with missing values of the best attribute chosen are sent to left child or right child using a surrogate split. A surrogate split is one that imitates the best split as closely as possible. While choosing a surrogate split, all splits alternative to the best split are scaned and the degree of closeness between the two is measured using a metric called predictive measure of association, \(\lambda_{i,j}\).
\(\lambda_{i,j} = \frac{min(P_L,P_R)-(1-P_{L_iL_j}-P_{R_iR_j})}{min(P_L,P_R)}\)
where \(P_L\) and \(P_R\) are the node probabilities for the optimal split of node i into left and right nodes respectively, \(P_{L_iL_j}\) ( \(P_{R_iR_j}\) resp.) is the probability that both (optimal) node i and (surrogate) node j send an observation to the Left (Right resp.).
We use best surrogate split, 2nd best surrogate split and so on until all data points with missing attributes in a node have been sent to left/right child. If all possible surrogate splits are used up but some data points are still to be assigned left/right child, majority rule is used, ie. the data points are assigned the child where majority of data points have gone from the node.
cf. http://pic.dhe.ibm.com/infocenter/spssstat/v20r0m0/index.jsp?topic=%2Fcom.ibm.spss.statistics.help%2Falg_tree-cart.htm
Public Types | |
| typedef CTreeMachineNode < CARTreeNodeData > | node_t |
| typedef CBinaryTreeMachineNode < CARTreeNodeData > | bnode_t |
Public Member Functions | |
| CCARTree () | |
| CCARTree (SGVector< bool > attribute_types, EProblemType prob_type=PT_MULTICLASS) | |
| CCARTree (SGVector< bool > attribute_types, EProblemType prob_type, int32_t num_folds, bool cv_prune) | |
| virtual | ~CCARTree () |
| virtual void | set_labels (CLabels *lab) |
| virtual const char * | get_name () const |
| virtual EProblemType | get_machine_problem_type () const |
| void | set_machine_problem_type (EProblemType mode) |
| virtual bool | is_label_valid (CLabels *lab) const |
| virtual CMulticlassLabels * | apply_multiclass (CFeatures *data=NULL) |
| virtual CRegressionLabels * | apply_regression (CFeatures *data=NULL) |
| void | prune_using_test_dataset (CDenseFeatures< float64_t > *feats, CLabels *gnd_truth, SGVector< float64_t > weights=SGVector< float64_t >()) |
| void | set_weights (SGVector< float64_t > w) |
| SGVector< float64_t > | get_weights () const |
| void | clear_weights () |
| void | set_feature_types (SGVector< bool > ft) |
| SGVector< bool > | get_feature_types () const |
| void | clear_feature_types () |
| int32_t | get_num_folds () const |
| void | set_num_folds (int32_t folds) |
| int32_t | get_max_depth () const |
| void | set_max_depth (int32_t depth) |
| int32_t | get_min_node_size () const |
| void | set_min_node_size (int32_t nsize) |
| void | set_cv_pruning () |
| void | unset_cv_pruning () |
| float64_t | get_label_epsilon () |
| void | set_label_epsilon (float64_t epsilon) |
| void | pre_sort_features (CFeatures *data, SGMatrix< float64_t > &sorted_feats, SGMatrix< index_t > &sorted_indices) |
| void | set_sorted_features (SGMatrix< float64_t > &sorted_feats, SGMatrix< index_t > &sorted_indices) |
| void | set_root (CTreeMachineNode< CARTreeNodeData > *root) |
| CTreeMachineNode < CARTreeNodeData > * | get_root () |
| CTreeMachine * | clone_tree () |
| int32_t | get_num_machines () const |
| virtual bool | train (CFeatures *data=NULL) |
| virtual CLabels * | apply (CFeatures *data=NULL) |
| virtual CBinaryLabels * | apply_binary (CFeatures *data=NULL) |
| virtual CStructuredLabels * | apply_structured (CFeatures *data=NULL) |
| virtual CLatentLabels * | apply_latent (CFeatures *data=NULL) |
| virtual CLabels * | get_labels () |
| void | set_max_train_time (float64_t t) |
| float64_t | get_max_train_time () |
| virtual EMachineType | get_classifier_type () |
| void | set_solver_type (ESolverType st) |
| ESolverType | get_solver_type () |
| virtual void | set_store_model_features (bool store_model) |
| virtual bool | train_locked (SGVector< index_t > indices) |
| virtual float64_t | apply_one (int32_t i) |
| virtual CLabels * | apply_locked (SGVector< index_t > indices) |
| virtual CBinaryLabels * | apply_locked_binary (SGVector< index_t > indices) |
| virtual CRegressionLabels * | apply_locked_regression (SGVector< index_t > indices) |
| virtual CMulticlassLabels * | apply_locked_multiclass (SGVector< index_t > indices) |
| virtual CStructuredLabels * | apply_locked_structured (SGVector< index_t > indices) |
| virtual CLatentLabels * | apply_locked_latent (SGVector< index_t > indices) |
| virtual void | data_lock (CLabels *labs, CFeatures *features) |
| virtual void | post_lock (CLabels *labs, CFeatures *features) |
| virtual void | data_unlock () |
| virtual bool | supports_locking () const |
| bool | is_data_locked () const |
| virtual CSGObject * | shallow_copy () const |
| virtual CSGObject * | deep_copy () const |
| virtual bool | is_generic (EPrimitiveType *generic) const |
| template<class T > | |
| void | set_generic () |
| template<> | |
| void | set_generic () |
| template<> | |
| void | set_generic () |
| template<> | |
| void | set_generic () |
| template<> | |
| void | set_generic () |
| template<> | |
| void | set_generic () |
| template<> | |
| void | set_generic () |
| template<> | |
| void | set_generic () |
| template<> | |
| void | set_generic () |
| template<> | |
| void | set_generic () |
| template<> | |
| void | set_generic () |
| template<> | |
| void | set_generic () |
| template<> | |
| void | set_generic () |
| template<> | |
| void | set_generic () |
| template<> | |
| void | set_generic () |
| template<> | |
| void | set_generic () |
| void | unset_generic () |
| virtual void | print_serializable (const char *prefix="") |
| virtual bool | save_serializable (CSerializableFile *file, const char *prefix="") |
| virtual bool | load_serializable (CSerializableFile *file, const char *prefix="") |
| void | set_global_io (SGIO *io) |
| SGIO * | get_global_io () |
| void | set_global_parallel (Parallel *parallel) |
| Parallel * | get_global_parallel () |
| void | set_global_version (Version *version) |
| Version * | get_global_version () |
| SGStringList< char > | get_modelsel_names () |
| void | print_modsel_params () |
| char * | get_modsel_param_descr (const char *param_name) |
| index_t | get_modsel_param_index (const char *param_name) |
| void | build_gradient_parameter_dictionary (CMap< TParameter *, CSGObject * > *dict) |
| bool | has (const std::string &name) const |
| template<typename T > | |
| bool | has (const Tag< T > &tag) const |
| template<typename T , typename U = void> | |
| bool | has (const std::string &name) const |
| template<typename T > | |
| void | set (const Tag< T > &_tag, const T &value) |
| template<typename T , typename U = void> | |
| void | set (const std::string &name, const T &value) |
| template<typename T > | |
| T | get (const Tag< T > &_tag) const |
| template<typename T , typename U = void> | |
| T | get (const std::string &name) const |
| virtual void | update_parameter_hash () |
| virtual bool | parameter_hash_changed () |
| virtual bool | equals (CSGObject *other, float64_t accuracy=0.0, bool tolerant=false) |
| virtual CSGObject * | clone () |
Public Attributes | |
| SGIO * | io |
| Parallel * | parallel |
| Version * | version |
| Parameter * | m_parameters |
| Parameter * | m_model_selection_parameters |
| Parameter * | m_gradient_parameters |
| uint32_t | m_hash |
Static Public Attributes | |
| static const float64_t | MISSING =CMath::MAX_REAL_NUMBER |
| static const float64_t | MIN_SPLIT_GAIN =1e-7 |
| static const float64_t | EQ_DELTA =1e-7 |
Protected Member Functions | |
| virtual bool | train_machine (CFeatures *data=NULL) |
| virtual CBinaryTreeMachineNode < CARTreeNodeData > * | CARTtrain (CFeatures *data, SGVector< float64_t > weights, CLabels *labels, int32_t level) |
| SGVector< float64_t > | get_unique_labels (SGVector< float64_t > labels_vec, int32_t &n_ulabels) |
| virtual int32_t | compute_best_attribute (const SGMatrix< float64_t > &mat, const SGVector< float64_t > &weights, CLabels *labels, SGVector< float64_t > &left, SGVector< float64_t > &right, SGVector< bool > &is_left_final, int32_t &num_missing, int32_t &count_left, int32_t &count_right, int32_t subset_size=0, const SGVector< int32_t > &active_indices=SGVector< index_t >()) |
| SGVector< bool > | surrogate_split (SGMatrix< float64_t > data, SGVector< float64_t > weights, SGVector< bool > nm_left, int32_t attr) |
| void | handle_missing_vecs_for_continuous_surrogate (SGMatrix< float64_t > m, CDynamicArray< int32_t > *missing_vecs, CDynamicArray< float64_t > *association_index, CDynamicArray< int32_t > *intersect_vecs, SGVector< bool > is_left, SGVector< float64_t > weights, float64_t p, int32_t attr) |
| void | handle_missing_vecs_for_nominal_surrogate (SGMatrix< float64_t > m, CDynamicArray< int32_t > *missing_vecs, CDynamicArray< float64_t > *association_index, CDynamicArray< int32_t > *intersect_vecs, SGVector< bool > is_left, SGVector< float64_t > weights, float64_t p, int32_t attr) |
| float64_t | gain (SGVector< float64_t > wleft, SGVector< float64_t > wright, SGVector< float64_t > wtotal, SGVector< float64_t > labels) |
| float64_t | gain (const SGVector< float64_t > &wleft, const SGVector< float64_t > &wright, const SGVector< float64_t > &wtotal) |
| float64_t | gini_impurity_index (const SGVector< float64_t > &weighted_lab_classes, float64_t &total_weight) |
| float64_t | least_squares_deviation (const SGVector< float64_t > &labels, const SGVector< float64_t > &weights, float64_t &total_weight) |
| CLabels * | apply_from_current_node (CDenseFeatures< float64_t > *feats, bnode_t *current) |
| void | prune_by_cross_validation (CDenseFeatures< float64_t > *data, int32_t folds) |
| float64_t | compute_error (CLabels *labels, CLabels *reference, SGVector< float64_t > weights) |
| CDynamicObjectArray * | prune_tree (CTreeMachine< CARTreeNodeData > *tree) |
| float64_t | find_weakest_alpha (bnode_t *node) |
| void | cut_weakest_link (bnode_t *node, float64_t alpha) |
| void | form_t1 (bnode_t *node) |
| void | init () |
| virtual void | store_model_features () |
| virtual bool | train_require_labels () const |
| virtual void | load_serializable_pre () throw (ShogunException) |
| virtual void | load_serializable_post () throw (ShogunException) |
| virtual void | save_serializable_pre () throw (ShogunException) |
| virtual void | save_serializable_post () throw (ShogunException) |
| template<typename T > | |
| void | register_param (Tag< T > &_tag, const T &value) |
| template<typename T > | |
| void | register_param (const std::string &name, const T &value) |
Protected Attributes | |
| float64_t | m_label_epsilon |
| SGVector< bool > | m_nominal |
| SGVector< float64_t > | m_weights |
| SGMatrix< float64_t > | m_sorted_features |
| SGMatrix< index_t > | m_sorted_indices |
| bool | m_pre_sort |
| bool | m_types_set |
| bool | m_weights_set |
| bool | m_apply_cv_pruning |
| int32_t | m_folds |
| EProblemType | m_mode |
| CDynamicArray< float64_t > * | m_alphas |
| int32_t | m_max_depth |
| int32_t | m_min_node_size |
| CTreeMachineNode < CARTreeNodeData > * | m_root |
| CDynamicObjectArray * | m_machines |
| float64_t | m_max_train_time |
| CLabels * | m_labels |
| ESolverType | m_solver_type |
| bool | m_store_model_features |
| bool | m_data_locked |
|
inherited |
bnode_t type- Tree node with max 2 possible children
Definition at line 55 of file TreeMachine.h.
|
inherited |
node_t type- Tree node with many possible children
Definition at line 52 of file TreeMachine.h.
| CCARTree | ( | ) |
default constructor
Definition at line 43 of file CARTree.cpp.
| CCARTree | ( | SGVector< bool > | attribute_types, |
| EProblemType | prob_type = PT_MULTICLASS |
||
| ) |
constructor
| attribute_types | type of each predictive attribute (true for nominal, false for ordinal/continuous) |
| prob_type | machine problem type - PT_MULTICLASS or PT_REGRESSION |
Definition at line 49 of file CARTree.cpp.
| CCARTree | ( | SGVector< bool > | attribute_types, |
| EProblemType | prob_type, | ||
| int32_t | num_folds, | ||
| bool | cv_prune | ||
| ) |
constructor - to be used while using cross-validation pruning
| attribute_types | type of each predictive attribute (true for nominal, false for ordinal/continuous) |
| prob_type | machine problem type - PT_MULTICLASS or PT_REGRESSION |
| num_folds | number of subsets used in cross-valiation |
| cv_prune | - whether to use cross-validation pruning |
Definition at line 57 of file CARTree.cpp.
|
virtual |
destructor
Definition at line 68 of file CARTree.cpp.
apply machine to data if data is not specified apply to the current features
| data | (test)data to be classified |
Definition at line 152 of file Machine.cpp.
|
virtualinherited |
apply machine to data in means of binary classification problem
Reimplemented in CKernelMachine, COnlineLinearMachine, CNeuralNetwork, CLinearMachine, CGaussianProcessClassification, CDomainAdaptationSVMLinear, CDomainAdaptationSVM, CPluginEstimate, and CBaggingMachine.
Definition at line 208 of file Machine.cpp.
|
protected |
uses current subtree to classify/regress data
| feats | data to be classified/regressed |
| current | root of current subtree |
Definition at line 1103 of file CARTree.cpp.
|
virtualinherited |
apply machine to data in means of latent problem
Reimplemented in CLinearLatentMachine.
Definition at line 232 of file Machine.cpp.
Applies a locked machine on a set of indices. Error if machine is not locked
| indices | index vector (of locked features) that is predicted |
Definition at line 187 of file Machine.cpp.
|
virtualinherited |
applies a locked machine on a set of indices for binary problems
Reimplemented in CKernelMachine.
Definition at line 238 of file Machine.cpp.
|
virtualinherited |
applies a locked machine on a set of indices for latent problems
Definition at line 266 of file Machine.cpp.
|
virtualinherited |
applies a locked machine on a set of indices for multiclass problems
Definition at line 252 of file Machine.cpp.
|
virtualinherited |
applies a locked machine on a set of indices for regression problems
Reimplemented in CKernelMachine.
Definition at line 245 of file Machine.cpp.
|
virtualinherited |
applies a locked machine on a set of indices for structured problems
Definition at line 259 of file Machine.cpp.
|
virtual |
classify data using Classification Tree
| data | data to be classified |
Reimplemented from CMachine.
Definition at line 102 of file CARTree.cpp.
|
virtualinherited |
applies to one vector
Reimplemented in CKernelMachine, CRelaxedTree, COnlineLinearMachine, CLinearMachine, CKNN, CMulticlassMachine, CDistanceMachine, CScatterSVM, CGaussianNaiveBayes, and CPluginEstimate.
|
virtual |
Get regression labels using Regression Tree
| data | data whose regression output is needed |
Reimplemented from CMachine.
Definition at line 116 of file CARTree.cpp.
|
virtualinherited |
apply machine to data in means of SO classification problem
Reimplemented in CLinearStructuredOutputMachine.
Definition at line 226 of file Machine.cpp.
|
inherited |
Builds a dictionary of all parameters in SGObject as well of those of SGObjects that are parameters of this object. Dictionary maps parameters to the objects that own them.
| dict | dictionary of parameters to be built. |
Definition at line 630 of file SGObject.cpp.
|
protectedvirtual |
CARTtrain - recursive CART training method
| data | training data |
| weights | vector of weights of data points |
| labels | labels of data points |
| level | current tree depth |
Definition at line 317 of file CARTree.cpp.
| void clear_feature_types | ( | ) |
clear feature types of various features
Definition at line 202 of file CARTree.cpp.
| void clear_weights | ( | ) |
clear weights of data points
Definition at line 185 of file CARTree.cpp.
|
virtualinherited |
Creates a clone of the current object. This is done via recursively traversing all parameters, which corresponds to a deep copy. Calling equals on the cloned object always returns true although none of the memory of both objects overlaps.
Definition at line 747 of file SGObject.cpp.
|
inherited |
|
protectedvirtual |
computes best attribute for CARTtrain
| mat | data matrix |
| weights | data weights |
| labels_vec | data labels |
| left | stores feature values for left transition |
| right | stores feature values for right transition |
| is_left_final | stores which feature vectors go to the left child |
| num_missing | number of missing attributes |
| count_left | stores number of feature values for left transition |
| count_right | stores number of feature values for right transition |
Reimplemented in CRandomCARTree.
Definition at line 531 of file CARTree.cpp.
|
protected |
computes error in classification/regression for classification it eveluates weight_missclassified/total_weight for regression it evaluates weighted sum of squared error/total_weight
| labels | the labels whose error needs to be calculated |
| reference | actual labels against which test labels are compared |
| weights | weights associated with the labels |
Definition at line 1327 of file CARTree.cpp.
recursively cuts weakest link(s) in a tree
| node | the root of subtree whose weakest link it cuts |
| alpha | alpha value corresponding to weakest link |
Definition at line 1436 of file CARTree.cpp.
Locks the machine on given labels and data. After this call, only train_locked and apply_locked may be called
Only possible if supports_locking() returns true
| labs | labels used for locking |
| features | features used for locking |
Reimplemented in CKernelMachine.
Definition at line 112 of file Machine.cpp.
|
virtualinherited |
Unlocks a locked machine and restores previous state
Reimplemented in CKernelMachine.
Definition at line 143 of file Machine.cpp.
|
virtualinherited |
A deep copy. All the instance variables will also be copied.
Definition at line 231 of file SGObject.cpp.
Recursively compares the current SGObject to another one. Compares all registered numerical parameters, recursion upon complex (SGObject) parameters. Does not compare pointers!
May be overwritten but please do with care! Should not be necessary in most cases.
| other | object to compare with |
| accuracy | accuracy to use for comparison (optional) |
| tolerant | allows linient check on float equality (within accuracy) |
Definition at line 651 of file SGObject.cpp.
recursively finds alpha corresponding to weakest link(s)
| node | the root of subtree whose weakest link it finds |
Definition at line 1415 of file CARTree.cpp.
|
protected |
recursively forms base case $ft_1$f tree from $ft_max$f during pruning
| node | the root of current subtree |
Definition at line 1466 of file CARTree.cpp.
|
protected |
returns gain in regression case
| wleft | left child weight distribution |
| wright | right child weights distribution |
| wtotal | weight distribution in current node |
| labels | regression labels |
Definition at line 1051 of file CARTree.cpp.
|
protected |
returns gain in Gini impurity measure
| wleft | left child label distribution |
| wright | right child label distribution |
| wtotal | label distribution in current node |
Definition at line 1065 of file CARTree.cpp.
|
inherited |
Getter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.
| _tag | name and type information of parameter |
Definition at line 367 of file SGObject.h.
|
inherited |
Getter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.
| name | name of the parameter |
Definition at line 388 of file SGObject.h.
|
virtualinherited |
get classifier type
Reimplemented in CLaRank, CSVMLight, CNeuralNetwork, CCCSOSVM, CLeastAngleRegression, CLDA, CQDA, CLibLinearMTL, CBaggingMachine, CLibLinear, CGaussianProcessClassification, CKernelRidgeRegression, CLibSVR, CKNN, CGaussianNaiveBayes, CSVRLight, CMCLDA, CLinearRidgeRegression, CScatterSVM, CGaussianProcessRegression, CSGDQN, CSVMSGD, COnlineSVMSGD, CLeastSquaresRegression, CMKLRegression, CDomainAdaptationSVMLinear, CMKLMulticlass, CKMeansBase, CHierarchical, CMKLOneClass, CLibSVM, CStochasticSOSVM, CMKLClassification, CDomainAdaptationSVM, CLPBoost, CPerceptron, CAveragedPerceptron, CFWSOSVM, CNewtonSVM, CLPM, CGMNPSVM, CSVMLightOneClass, CSVMLin, CMulticlassLibSVM, CLibSVMOneClass, CMPDSVM, CGNPPSVM, and CCPLEXSVM.
Definition at line 92 of file Machine.cpp.
| SGVector< bool > get_feature_types | ( | ) | const |
set feature types of various features
Definition at line 197 of file CARTree.cpp.
|
inherited |
|
inherited |
|
inherited |
| float64_t get_label_epsilon | ( | ) |
|
virtualinherited |
|
virtual |
get problem type - multiclass classification or regression
Reimplemented from CBaseMulticlassMachine.
| int32_t get_max_depth | ( | ) | const |
get max allowed tree depth
Definition at line 219 of file CARTree.cpp.
|
inherited |
| int32_t get_min_node_size | ( | ) | const |
|
inherited |
Definition at line 531 of file SGObject.cpp.
|
inherited |
Returns description of a given parameter string, if it exists. SG_ERROR otherwise
| param_name | name of the parameter |
Definition at line 555 of file SGObject.cpp.
|
inherited |
Returns index of model selection parameter with provided index
| param_name | name of model selection parameter |
Definition at line 568 of file SGObject.cpp.
|
virtual |
get name
Reimplemented from CTreeMachine< CARTreeNodeData >.
Reimplemented in CRandomCARTree.
| int32_t get_num_folds | ( | ) | const |
get number of subsets used for cross validation
Definition at line 208 of file CARTree.cpp.
|
inherited |
get number of machines
Definition at line 27 of file BaseMulticlassMachine.cpp.
|
inherited |
|
inherited |
|
protected |
modify labels for compute_best_attribute
| labels_vec | labels vector |
| n_ulabels | stores number of unique labels |
Definition at line 507 of file CARTree.cpp.
|
protected |
returns Gini impurity of a node
| weighted_lab_classes | vector of weights associated with various labels |
| total_weight | stores the total weight of all classes |
Definition at line 1077 of file CARTree.cpp.
|
protected |
handles missing values for a chosen continuous surrogate attribute
| m | training data matrix |
| missing_vecs | column indices of vectors with missing attribute in data matrix |
| association_index | stores the final lambda values used to address members of missing_vecs |
| intersect_vecs | column indices of vectors with known values for the best attribute as well as the chosen surrogate |
| is_left | whether a vector goes into left child |
| weights | weights of training data vectors |
| p | min(p_l,p_r) in the lambda formula |
| attr | surrogate attribute chosen for split |
Definition at line 914 of file CARTree.cpp.
|
protected |
handles missing values for a chosen nominal surrogate attribute
| m | training data matrix |
| missing_vecs | column indices of vectors with missing attribute in data matrix |
| association_index | stores the final lambda values used to address members of missing_vecs |
| intersect_vecs | column indices of vectors with known values for the best attribute as well as the chosen surrogate |
| is_left | whether a vector goes into left child |
| weights | weights of training data vectors |
| p | min(p_l,p_r) in the lambda formula |
| attr | surrogate attribute chosen for split |
Definition at line 971 of file CARTree.cpp.
|
inherited |
Checks if object has a class parameter identified by a name.
| name | name of the parameter |
Definition at line 289 of file SGObject.h.
|
inherited |
Checks if object has a class parameter identified by a Tag.
| tag | tag of the parameter containing name and type information |
Definition at line 301 of file SGObject.h.
|
inherited |
Checks if a type exists for a class parameter identified by a name.
| name | name of the parameter |
Definition at line 312 of file SGObject.h.
|
protected |
initializes members of class
Definition at line 1492 of file CARTree.cpp.
|
inherited |
|
virtualinherited |
If the SGSerializable is a class template then TRUE will be returned and GENERIC is set to the type of the generic.
| generic | set to the type of the generic if returning TRUE |
Definition at line 329 of file SGObject.cpp.
|
virtual |
whether labels supplied are valid for current problem type
| lab | labels supplied |
Reimplemented from CBaseMulticlassMachine.
Definition at line 92 of file CARTree.cpp.
|
protected |
returns least squares deviation
| labels | regression labels |
| weights | weights of regression data points |
| total_weight | stores sum of weights in weights vector |
Definition at line 1087 of file CARTree.cpp.
|
virtualinherited |
Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!
| file | where to load from |
| prefix | prefix for members |
Definition at line 402 of file SGObject.cpp.
|
protectedvirtualinherited | |||||||||||||
Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_POST is called.
| ShogunException | will be thrown if an error occurs. |
Reimplemented in CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.
Definition at line 459 of file SGObject.cpp.
|
protectedvirtualinherited | |||||||||||||
Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_PRE is called.
| ShogunException | will be thrown if an error occurs. |
Reimplemented in CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.
Definition at line 454 of file SGObject.cpp.
|
virtualinherited |
Definition at line 295 of file SGObject.cpp.
| void pre_sort_features | ( | CFeatures * | data, |
| SGMatrix< float64_t > & | sorted_feats, | ||
| SGMatrix< index_t > & | sorted_indices | ||
| ) |
Definition at line 297 of file CARTree.cpp.
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 507 of file SGObject.cpp.
|
virtualinherited |
prints registered parameters out
| prefix | prefix for members |
Definition at line 341 of file SGObject.cpp.
|
protected |
prune by cross validation
| data | training data |
| folds | the integer V for V-fold cross validation |
Definition at line 1188 of file CARTree.cpp.
|
protected |
cost-complexity pruning
| tree | the tree to be pruned |
Definition at line 1365 of file CARTree.cpp.
| void prune_using_test_dataset | ( | CDenseFeatures< float64_t > * | feats, |
| CLabels * | gnd_truth, | ||
| SGVector< float64_t > | weights = SGVector<float64_t>() |
||
| ) |
uses test dataset to choose best pruned subtree
| feats | test data to be used |
| gnd_truth | test labels |
| weights | weights of data points |
Definition at line 128 of file CARTree.cpp.
|
protectedinherited |
Registers a class parameter which is identified by a tag. This enables the parameter to be modified by set() and retrieved by get(). Parameters can be registered in the constructor of the class.
| _tag | name and type information of parameter |
| value | value of the parameter |
Definition at line 439 of file SGObject.h.
|
protectedinherited |
Registers a class parameter which is identified by a name. This enables the parameter to be modified by set() and retrieved by get(). Parameters can be registered in the constructor of the class.
| name | name of the parameter |
| value | value of the parameter along with type information |
Definition at line 452 of file SGObject.h.
|
virtualinherited |
Save this object to file.
| file | where to save the object; will be closed during returning if PREFIX is an empty string. |
| prefix | prefix for members |
Definition at line 347 of file SGObject.cpp.
|
protectedvirtualinherited | |||||||||||||
Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_POST is called.
| ShogunException | will be thrown if an error occurs. |
Reimplemented in CKernel.
Definition at line 469 of file SGObject.cpp.
|
protectedvirtualinherited | |||||||||||||
Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_PRE is called.
| ShogunException | will be thrown if an error occurs. |
Reimplemented in CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.
Definition at line 464 of file SGObject.cpp.
|
inherited |
Setter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.
| _tag | name and type information of parameter |
| value | value of the parameter |
Definition at line 328 of file SGObject.h.
|
inherited |
Setter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.
| name | name of the parameter |
| value | value of the parameter along with type information |
Definition at line 354 of file SGObject.h.
| void set_feature_types | ( | SGVector< bool > | ft | ) |
set feature types of various features
| ft | bool vector true for nominal feature false for continuous feature type |
Definition at line 191 of file CARTree.cpp.
|
inherited |
Definition at line 74 of file SGObject.cpp.
|
inherited |
Definition at line 79 of file SGObject.cpp.
|
inherited |
Definition at line 84 of file SGObject.cpp.
|
inherited |
Definition at line 89 of file SGObject.cpp.
|
inherited |
Definition at line 94 of file SGObject.cpp.
|
inherited |
Definition at line 99 of file SGObject.cpp.
|
inherited |
Definition at line 104 of file SGObject.cpp.
|
inherited |
Definition at line 109 of file SGObject.cpp.
|
inherited |
Definition at line 114 of file SGObject.cpp.
|
inherited |
Definition at line 119 of file SGObject.cpp.
|
inherited |
Definition at line 124 of file SGObject.cpp.
|
inherited |
Definition at line 129 of file SGObject.cpp.
|
inherited |
Definition at line 134 of file SGObject.cpp.
|
inherited |
Definition at line 139 of file SGObject.cpp.
|
inherited |
Definition at line 144 of file SGObject.cpp.
|
inherited |
set generic type to T
|
inherited |
|
inherited |
set the parallel object
| parallel | parallel object to use |
Definition at line 274 of file SGObject.cpp.
|
inherited |
set the version object
| version | version object to use |
Definition at line 316 of file SGObject.cpp.
| void set_label_epsilon | ( | float64_t | epsilon | ) |
set label epsilon
| epsilon | equality range for regression labels |
Definition at line 241 of file CARTree.cpp.
|
virtual |
set labels - automagically switch machine problem type based on type of labels supplied
| lab | labels |
Reimplemented from CMachine.
Definition at line 73 of file CARTree.cpp.
| void set_machine_problem_type | ( | EProblemType | mode | ) |
set problem type - multiclass classification or regression
| mode | EProblemType PT_MULTICLASS or PT_REGRESSION |
Definition at line 87 of file CARTree.cpp.
| void set_max_depth | ( | int32_t | depth | ) |
set max allowed tree depth
| depth | max allowed tree depth |
Definition at line 224 of file CARTree.cpp.
|
inherited |
set maximum training time
| t | maximimum training time |
Definition at line 82 of file Machine.cpp.
| void set_min_node_size | ( | int32_t | nsize | ) |
set min allowed node size
| nsize | min allowed node size |
Definition at line 235 of file CARTree.cpp.
| void set_num_folds | ( | int32_t | folds | ) |
set number of subsets for cross validation
| folds | number of folds used in cross validation |
Definition at line 213 of file CARTree.cpp.
|
inherited |
|
inherited |
| void set_sorted_features | ( | SGMatrix< float64_t > & | sorted_feats, |
| SGMatrix< index_t > & | sorted_indices | ||
| ) |
Definition at line 290 of file CARTree.cpp.
|
virtualinherited |
Setter for store-model-features-after-training flag
| store_model | whether model should be stored after training |
Definition at line 107 of file Machine.cpp.
set weights of data points
| w | vector of weights |
Definition at line 174 of file CARTree.cpp.
|
virtualinherited |
A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.
Reimplemented in CGaussianKernel.
Definition at line 225 of file SGObject.cpp.
|
protectedvirtualinherited |
enable unlocked cross-validation - no model features to store
Reimplemented from CMachine.
Definition at line 152 of file TreeMachine.h.
|
virtualinherited |
Reimplemented in CKernelMachine.
|
protected |
handles missing values through surrogate splits
| data | training data matrix |
| weights | vector of weights of data points |
| nm_left | whether a data point is put into left child (available for only data points with non-missing attribute attr) |
| attr | best attribute chosen for split |
Definition at line 839 of file CARTree.cpp.
|
virtualinherited |
train machine
| data | training data (parameter can be avoided if distance or kernel-based classifiers are used and distance/kernels are initialized with train data). If flag is set, model features will be stored after training. |
Reimplemented in CRelaxedTree, CAutoencoder, CLinearMachine, CSGDQN, and COnlineSVMSGD.
Definition at line 39 of file Machine.cpp.
Trains a locked machine on a set of indices. Error if machine is not locked
NOT IMPLEMENTED
| indices | index vector (of locked features) that is used for training |
Reimplemented in CKernelMachine.
|
protectedvirtual |
train machine - build CART from training data
| data | training data |
Reimplemented from CMachine.
Definition at line 247 of file CARTree.cpp.
|
protectedvirtualinherited |
returns whether machine require labels for training
Reimplemented in COnlineLinearMachine, CKMeansBase, CHierarchical, CLinearLatentMachine, CVwConditionalProbabilityTree, CConditionalProbabilityTree, and CLibSVMOneClass.
| void unset_cv_pruning | ( | ) |
|
inherited |
unset generic type
this has to be called in classes specializing a template class
Definition at line 336 of file SGObject.cpp.
|
virtualinherited |
Updates the hash of current parameter combination
Definition at line 281 of file SGObject.cpp.
|
inherited |
io
Definition at line 537 of file SGObject.h.
|
protected |
|
protected |
|
protectedinherited |
|
protected |
|
inherited |
parameters wrt which we can compute gradients
Definition at line 552 of file SGObject.h.
|
inherited |
Hash of parameter values
Definition at line 555 of file SGObject.h.
|
protected |
|
protectedinherited |
machines
Definition at line 56 of file BaseMulticlassMachine.h.
|
protectedinherited |
|
protected |
|
protected |
|
inherited |
model selection parameters
Definition at line 549 of file SGObject.h.
|
protected |
|
inherited |
parameters
Definition at line 546 of file SGObject.h.
|
protected |
|
protectedinherited |
tree root
Definition at line 156 of file TreeMachine.h.
|
protectedinherited |
|
protectedinherited |
|
protected |
|
protected |
|
static |
|
static |
|
inherited |
parallel
Definition at line 540 of file SGObject.h.
|
inherited |
version
Definition at line 543 of file SGObject.h.