SHOGUN
4.1.0
|
This class implements randomized CART algorithm used in the tree growing process of candidate trees in Random Forests algorithm. The tree growing process is different from the original CART algorithm because of the input attributes which are considered for each node split. In randomized CART, a few (fixed number) attributes are randomly chosen from all available attributes while deciding the best split. This is unlike the original CART where all available attributes are considered while deciding the best split.
Definition at line 48 of file RandomCARTree.h.
Public Types | |
typedef CTreeMachineNode< CARTreeNodeData > | node_t |
typedef CBinaryTreeMachineNode< CARTreeNodeData > | bnode_t |
Public Attributes | |
SGIO * | io |
Parallel * | parallel |
Version * | version |
Parameter * | m_parameters |
Parameter * | m_model_selection_parameters |
Parameter * | m_gradient_parameters |
ParameterMap * | m_parameter_map |
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 Attributes | |
float64_t | m_label_epsilon |
SGVector< bool > | m_nominal |
SGVector< float64_t > | m_weights |
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.
CRandomCARTree | ( | ) |
constructor
Definition at line 36 of file RandomCARTree.cpp.
|
virtual |
destructor
Definition at line 42 of file RandomCARTree.cpp.
apply machine to data if data is not specified apply to the current features
data | (test)data to be classified |
Definition at line 160 of file Machine.cpp.
|
virtualinherited |
apply machine to data in means of binary classification problem
Reimplemented in CKernelMachine, COnlineLinearMachine, CWDSVMOcas, CNeuralNetwork, CLinearMachine, CGaussianProcessClassification, CDomainAdaptationSVMLinear, CPluginEstimate, and CBaggingMachine.
Definition at line 216 of file Machine.cpp.
|
protectedinherited |
uses current subtree to classify/regress data
feats | data to be classified/regressed |
current | root of current subtree |
Definition at line 976 of file CARTree.cpp.
|
virtualinherited |
apply machine to data in means of latent problem
Reimplemented in CLinearLatentMachine.
Definition at line 240 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 195 of file Machine.cpp.
|
virtualinherited |
applies a locked machine on a set of indices for binary problems
Reimplemented in CKernelMachine, and CMultitaskLinearMachine.
Definition at line 246 of file Machine.cpp.
|
virtualinherited |
applies a locked machine on a set of indices for latent problems
Definition at line 274 of file Machine.cpp.
|
virtualinherited |
applies a locked machine on a set of indices for multiclass problems
Definition at line 260 of file Machine.cpp.
|
virtualinherited |
applies a locked machine on a set of indices for regression problems
Reimplemented in CKernelMachine.
Definition at line 253 of file Machine.cpp.
|
virtualinherited |
applies a locked machine on a set of indices for structured problems
Definition at line 267 of file Machine.cpp.
|
virtualinherited |
classify data using Classification Tree
data | data to be classified |
Reimplemented from CMachine.
Definition at line 99 of file CARTree.cpp.
|
virtualinherited |
applies to one vector
Reimplemented in CKernelMachine, CRelaxedTree, CWDSVMOcas, COnlineLinearMachine, CLinearMachine, CMultitaskLinearMachine, CMulticlassMachine, CKNN, CDistanceMachine, CMultitaskLogisticRegression, CMultitaskLeastSquaresRegression, CScatterSVM, CGaussianNaiveBayes, CPluginEstimate, and CFeatureBlockLogisticRegression.
|
virtualinherited |
Get regression labels using Regression Tree
data | data whose regression output is needed |
Reimplemented from CMachine.
Definition at line 111 of file CARTree.cpp.
|
virtualinherited |
apply machine to data in means of SO classification problem
Reimplemented in CLinearStructuredOutputMachine.
Definition at line 234 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 1244 of file SGObject.cpp.
|
protectedvirtualinherited |
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 285 of file CARTree.cpp.
|
inherited |
clear feature types of various features
Definition at line 197 of file CARTree.cpp.
|
inherited |
clear weights of data points
Definition at line 180 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 1361 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 from CCARTree.
Definition at line 52 of file RandomCARTree.cpp.
|
protectedinherited |
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 1198 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 1305 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 120 of file Machine.cpp.
|
virtualinherited |
Unlocks a locked machine and restores previous state
Reimplemented in CKernelMachine.
Definition at line 151 of file Machine.cpp.
|
virtualinherited |
A deep copy. All the instance variables will also be copied.
Definition at line 200 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 1265 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 1284 of file CARTree.cpp.
|
protectedinherited |
recursively forms base case $ft_1$f tree from $ft_max$f during pruning
node | the root of current subtree |
Definition at line 1335 of file CARTree.cpp.
|
protectedinherited |
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 918 of file CARTree.cpp.
|
protectedinherited |
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 932 of file CARTree.cpp.
|
virtualinherited |
get classifier type
Reimplemented in CLaRank, CDualLibQPBMSOSVM, CNeuralNetwork, CCCSOSVM, CLeastAngleRegression, CLDA, CKernelRidgeRegression, CLibLinearMTL, CBaggingMachine, CLibLinear, CGaussianProcessClassification, CKMeans, CLibSVR, CQDA, CGaussianNaiveBayes, CMCLDA, CLinearRidgeRegression, CKNN, CGaussianProcessRegression, CScatterSVM, CSGDQN, CSVMSGD, CSVMOcas, COnlineSVMSGD, CLeastSquaresRegression, CMKLRegression, CDomainAdaptationSVMLinear, CMKLMulticlass, CWDSVMOcas, CHierarchical, CMKLOneClass, CLibSVM, CStochasticSOSVM, CMKLClassification, CLPBoost, CPerceptron, CAveragedPerceptron, CFWSOSVM, CNewtonSVM, CLPM, CGMNPSVM, CSVMLin, CMulticlassLibSVM, CLibSVMOneClass, CMPDSVM, CGPBTSVM, CGNPPSVM, and CCPLEXSVM.
Definition at line 100 of file Machine.cpp.
int32_t get_feature_subset_size | ( | ) | const |
get number of random features to choose in each node split
Definition at line 72 of file RandomCARTree.h.
|
inherited |
set feature types of various features
Definition at line 192 of file CARTree.cpp.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
virtualinherited |
|
virtualinherited |
get problem type - multiclass classification or regression
Reimplemented from CBaseMulticlassMachine.
|
inherited |
get max allowed tree depth
Definition at line 214 of file CARTree.cpp.
|
inherited |
|
inherited |
|
inherited |
Definition at line 1136 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 1160 of file SGObject.cpp.
|
inherited |
Returns index of model selection parameter with provided index
param_name | name of model selection parameter |
Definition at line 1173 of file SGObject.cpp.
|
virtual |
get name
Reimplemented from CCARTree.
Definition at line 60 of file RandomCARTree.h.
|
inherited |
get number of subsets used for cross validation
Definition at line 203 of file CARTree.cpp.
|
inherited |
get number of machines
Definition at line 27 of file BaseMulticlassMachine.cpp.
|
inherited |
|
inherited |
|
protectedinherited |
modify labels for compute_best_attribute
labels_vec | labels vector |
n_ulabels | stores number of unique labels |
Definition at line 462 of file CARTree.cpp.
|
protectedinherited |
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 944 of file CARTree.cpp.
|
protectedinherited |
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 781 of file CARTree.cpp.
|
protectedinherited |
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 838 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 298 of file SGObject.cpp.
|
virtualinherited |
whether labels supplied are valid for current problem type
lab | labels supplied |
Reimplemented from CBaseMulticlassMachine.
Definition at line 89 of file CARTree.cpp.
|
protectedinherited |
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 958 of file CARTree.cpp.
|
inherited |
maps all parameters of this instance to the provided file version and loads all parameter data from the file into an array, which is sorted (basically calls load_file_parameter(...) for all parameters and puts all results into a sorted array)
file_version | parameter version of the file |
current_version | version from which mapping begins (you want to use Version::get_version_parameter() for this in most cases) |
file | file to load from |
prefix | prefix for members |
Definition at line 705 of file SGObject.cpp.
|
inherited |
loads some specified parameters from a file with a specified version The provided parameter info has a version which is recursively mapped until the file parameter version is reached. Note that there may be possibly multiple parameters in the mapping, therefore, a set of TParameter instances is returned
param_info | information of parameter |
file_version | parameter version of the file, must be <= provided parameter version |
file | file to load from |
prefix | prefix for members |
Definition at line 546 of file SGObject.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 |
param_version | (optional) a parameter version different to (this is mainly for testing, better do not use) |
Definition at line 375 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 1063 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 1058 of file SGObject.cpp.
|
inherited |
Takes a set of TParameter instances (base) with a certain version and a set of target parameter infos and recursively maps the base level wise to the current version using CSGObject::migrate(...). The base is replaced. After this call, the base version containing parameters should be of same version/type as the initial target parameter infos. Note for this to work, the migrate methods and all the internal parameter mappings have to match
param_base | set of TParameter instances that are mapped to the provided target parameter infos |
base_version | version of the parameter base |
target_param_infos | set of SGParamInfo instances that specify the target parameter base |
Definition at line 743 of file SGObject.cpp.
|
protectedvirtualinherited |
creates a new TParameter instance, which contains migrated data from the version that is provided. The provided parameter data base is used for migration, this base is a collection of all parameter data of the previous version. Migration is done FROM the data in param_base TO the provided param info Migration is always one version step. Method has to be implemented in subclasses, if no match is found, base method has to be called.
If there is an element in the param_base which equals the target, a copy of the element is returned. This represents the case when nothing has changed and therefore, the migrate method is not overloaded in a subclass
param_base | set of TParameter instances to use for migration |
target | parameter info for the resulting TParameter |
Definition at line 950 of file SGObject.cpp.
|
protectedvirtualinherited |
This method prepares everything for a one-to-one parameter migration. One to one here means that only ONE element of the parameter base is needed for the migration (the one with the same name as the target). Data is allocated for the target (in the type as provided in the target SGParamInfo), and a corresponding new TParameter instance is written to replacement. The to_migrate pointer points to the single needed TParameter instance needed for migration. If a name change happened, the old name may be specified by old_name. In addition, the m_delete_data flag of to_migrate is set to true. So if you want to migrate data, the only thing to do after this call is converting the data in the m_parameter fields. If unsure how to use - have a look into an example for this. (base_migration_type_conversion.cpp for example)
param_base | set of TParameter instances to use for migration |
target | parameter info for the resulting TParameter |
replacement | (used as output) here the TParameter instance which is returned by migration is created into |
to_migrate | the only source that is used for migration |
old_name | with this parameter, a name change may be specified |
Definition at line 890 of file SGObject.cpp.
|
virtualinherited |
Definition at line 264 of file SGObject.cpp.
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 1112 of file SGObject.cpp.
|
virtualinherited |
prints registered parameters out
prefix | prefix for members |
Definition at line 310 of file SGObject.cpp.
|
protectedinherited |
prune by cross validation
data | training data |
folds | the integer V for V-fold cross validation |
Definition at line 1059 of file CARTree.cpp.
|
protectedinherited |
cost-complexity pruning
tree | the tree to be pruned |
Definition at line 1236 of file CARTree.cpp.
|
inherited |
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 123 of file CARTree.cpp.
|
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 |
param_version | (optional) a parameter version different to (this is mainly for testing, better do not use) |
Definition at line 316 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 1073 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 1068 of file SGObject.cpp.
|
inherited |
void set_feature_subset_size | ( | int32_t | size | ) |
set number of random features to choose in each node split
size | subset size |
Definition at line 46 of file RandomCARTree.cpp.
|
inherited |
set feature types of various features
ft | bool vector true for nominal feature false for continuous feature type |
Definition at line 186 of file CARTree.cpp.
|
inherited |
Definition at line 42 of file SGObject.cpp.
|
inherited |
Definition at line 47 of file SGObject.cpp.
|
inherited |
Definition at line 52 of file SGObject.cpp.
|
inherited |
Definition at line 57 of file SGObject.cpp.
|
inherited |
Definition at line 62 of file SGObject.cpp.
|
inherited |
Definition at line 67 of file SGObject.cpp.
|
inherited |
Definition at line 72 of file SGObject.cpp.
|
inherited |
Definition at line 77 of file SGObject.cpp.
|
inherited |
Definition at line 82 of file SGObject.cpp.
|
inherited |
Definition at line 87 of file SGObject.cpp.
|
inherited |
Definition at line 92 of file SGObject.cpp.
|
inherited |
Definition at line 97 of file SGObject.cpp.
|
inherited |
Definition at line 102 of file SGObject.cpp.
|
inherited |
Definition at line 107 of file SGObject.cpp.
|
inherited |
Definition at line 112 of file SGObject.cpp.
|
inherited |
set generic type to T
|
inherited |
|
inherited |
set the parallel object
parallel | parallel object to use |
Definition at line 243 of file SGObject.cpp.
|
inherited |
set the version object
version | version object to use |
Definition at line 285 of file SGObject.cpp.
|
inherited |
set label epsilon
epsilon | equality range for regression labels |
Definition at line 236 of file CARTree.cpp.
|
virtualinherited |
set labels - automagically switch machine problem type based on type of labels supplied
lab | labels |
Reimplemented from CMachine.
Definition at line 70 of file CARTree.cpp.
|
inherited |
set problem type - multiclass classification or regression
mode | EProblemType PT_MULTICLASS or PT_REGRESSION |
Definition at line 84 of file CARTree.cpp.
|
inherited |
set max allowed tree depth
depth | max allowed tree depth |
Definition at line 219 of file CARTree.cpp.
|
inherited |
set maximum training time
t | maximimum training time |
Definition at line 90 of file Machine.cpp.
|
inherited |
set min allowed node size
nsize | min allowed node size |
Definition at line 230 of file CARTree.cpp.
|
inherited |
set number of subsets for cross validation
folds | number of folds used in cross validation |
Definition at line 208 of file CARTree.cpp.
|
inherited |
|
inherited |
|
virtualinherited |
Setter for store-model-features-after-training flag
store_model | whether model should be stored after training |
Definition at line 115 of file Machine.cpp.
set weights of data points
w | vector of weights |
Definition at line 169 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 194 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, and CMultitaskLinearMachine.
|
protectedinherited |
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 706 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, CSGDQN, and COnlineSVMSGD.
Definition at line 47 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, and CMultitaskLinearMachine.
|
protectedvirtualinherited |
train machine - build CART from training data
data | training data |
Reimplemented from CMachine.
Definition at line 242 of file CARTree.cpp.
|
protectedvirtualinherited |
returns whether machine require labels for training
Reimplemented in COnlineLinearMachine, CHierarchical, CLinearLatentMachine, CVwConditionalProbabilityTree, CConditionalProbabilityTree, and CLibSVMOneClass.
|
inherited |
|
inherited |
unset generic type
this has to be called in classes specializing a template class
Definition at line 305 of file SGObject.cpp.
|
virtualinherited |
Updates the hash of current parameter combination
Definition at line 250 of file SGObject.cpp.
|
staticinherited |
|
inherited |
io
Definition at line 496 of file SGObject.h.
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
inherited |
parameters wrt which we can compute gradients
Definition at line 511 of file SGObject.h.
|
inherited |
Hash of parameter values
Definition at line 517 of file SGObject.h.
|
protectedinherited |
|
protectedinherited |
machines
Definition at line 56 of file BaseMulticlassMachine.h.
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
inherited |
model selection parameters
Definition at line 508 of file SGObject.h.
|
protectedinherited |
|
inherited |
map for different parameter versions
Definition at line 514 of file SGObject.h.
|
inherited |
parameters
Definition at line 505 of file SGObject.h.
|
protectedinherited |
tree root
Definition at line 156 of file TreeMachine.h.
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
staticinherited |
|
staticinherited |
|
inherited |
parallel
Definition at line 499 of file SGObject.h.
|
inherited |
version
Definition at line 502 of file SGObject.h.