|
SHOGUN
4.2.0
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
|
SHOGUN
4.2.0
|
Conditional Probability Tree using Vowpal Wabbit for base machine.
Definition at line 40 of file VwConditionalProbabilityTree.h.
Public Types | |
| typedef CTreeMachineNode < VwConditionalProbabilityTreeNodeData > | node_t |
| typedef CBinaryTreeMachineNode < VwConditionalProbabilityTreeNodeData > | bnode_t |
Public Member Functions | |
| CVwConditionalProbabilityTree (int32_t num_passes=1) | |
| virtual | ~CVwConditionalProbabilityTree () |
| virtual const char * | get_name () const |
| void | set_num_passes (int32_t num_passes) |
| int32_t | get_num_passes () const |
| void | set_features (CStreamingVwFeatures *feats) |
| virtual CMulticlassLabels * | apply_multiclass (CFeatures *data=NULL) |
| virtual int32_t | apply_multiclass_example (VwExample *ex) |
| void | set_root (CTreeMachineNode< VwConditionalProbabilityTreeNodeData > *root) |
| CTreeMachineNode < VwConditionalProbabilityTreeNodeData > * | get_root () |
| CTreeMachine * | clone_tree () |
| int32_t | get_num_machines () const |
| virtual EProblemType | get_machine_problem_type () const |
| virtual bool | is_label_valid (CLabels *lab) const |
| virtual bool | train (CFeatures *data=NULL) |
| virtual CLabels * | apply (CFeatures *data=NULL) |
| virtual CBinaryLabels * | apply_binary (CFeatures *data=NULL) |
| virtual CRegressionLabels * | apply_regression (CFeatures *data=NULL) |
| virtual CStructuredLabels * | apply_structured (CFeatures *data=NULL) |
| virtual CLatentLabels * | apply_latent (CFeatures *data=NULL) |
| virtual void | set_labels (CLabels *lab) |
| 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 |
Protected Member Functions | |
| virtual bool | train_require_labels () const |
| virtual bool | train_machine (CFeatures *data) |
| void | train_example (VwExample *ex) |
| void | train_path (VwExample *ex, bnode_t *node) |
| float64_t | train_node (VwExample *ex, bnode_t *node) |
| int32_t | create_machine (VwExample *ex) |
| virtual bool | which_subtree (bnode_t *node, VwExample *ex)=0 |
| void | compute_conditional_probabilities (VwExample *ex) |
| float64_t | accumulate_conditional_probability (bnode_t *leaf) |
| virtual void | store_model_features () |
| 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 | |
| int32_t | m_num_passes |
| number of passes for online training More... | |
| std::map< int32_t, bnode_t * > | m_leaves |
| class => leaf mapping More... | |
| CStreamingVwFeatures * | m_feats |
| online features More... | |
| CTreeMachineNode < VwConditionalProbabilityTreeNodeData > * | 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.
| CVwConditionalProbabilityTree | ( | int32_t | num_passes = 1 | ) |
constructor
Definition at line 45 of file VwConditionalProbabilityTree.h.
|
virtual |
destructor
Definition at line 51 of file VwConditionalProbabilityTree.h.
accumulate along the path to the root the conditional probability for a particular leaf node.
Definition at line 77 of file VwConditionalProbabilityTree.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.
|
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 |
apply machine to data in means of multiclass classification problem
Reimplemented from CMachine.
Definition at line 19 of file VwConditionalProbabilityTree.cpp.
|
virtual |
apply machine one single example
Definition at line 44 of file VwConditionalProbabilityTree.cpp.
|
virtualinherited |
applies to one vector
Reimplemented in CKernelMachine, CRelaxedTree, COnlineLinearMachine, CLinearMachine, CKNN, CMulticlassMachine, CDistanceMachine, CScatterSVM, CGaussianNaiveBayes, and CPluginEstimate.
|
virtualinherited |
apply machine to data in means of regression problem
Reimplemented in CKernelMachine, COnlineLinearMachine, CNeuralNetwork, CLinearMachine, CCHAIDTree, CStochasticGBMachine, CCARTree, CGaussianProcessRegression, and CBaggingMachine.
Definition at line 214 of file Machine.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.
|
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 |
|
protected |
compute conditional probabilities for ex along the whole tree for predicting
Definition at line 57 of file VwConditionalProbabilityTree.cpp.
|
protected |
create a new VW machine for a node
| ex | the VwExample instance for training the new machine |
Definition at line 224 of file VwConditionalProbabilityTree.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.
|
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.
|
inherited |
|
inherited |
|
inherited |
|
virtualinherited |
|
virtualinherited |
get problem type
Reimplemented from CMachine.
Reimplemented in CCHAIDTree, and CCARTree.
Definition at line 32 of file BaseMulticlassMachine.cpp.
|
inherited |
|
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< VwConditionalProbabilityTreeNodeData >.
Definition at line 54 of file VwConditionalProbabilityTree.h.
|
inherited |
get number of machines
Definition at line 27 of file BaseMulticlassMachine.cpp.
| int32_t get_num_passes | ( | ) | const |
get number of passes
Definition at line 63 of file VwConditionalProbabilityTree.h.
|
inherited |
|
inherited |
|
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.
|
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.
|
virtualinherited |
check whether the labels is valid.
| lab | the labels being checked, guaranteed to be non-NULL |
Reimplemented from CMachine.
Reimplemented in CCARTree, and CCHAIDTree.
Definition at line 37 of file BaseMulticlassMachine.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.
|
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.
|
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_features | ( | CStreamingVwFeatures * | feats | ) |
|
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.
|
virtualinherited |
set labels
| lab | labels |
Reimplemented in CNeuralNetwork, CGaussianProcessMachine, CCARTree, CStructuredOutputMachine, CRelaxedTree, and CMulticlassMachine.
Definition at line 65 of file Machine.cpp.
|
inherited |
set maximum training time
| t | maximimum training time |
Definition at line 82 of file Machine.cpp.
| void set_num_passes | ( | int32_t | num_passes | ) |
set number of passes
Definition at line 57 of file VwConditionalProbabilityTree.h.
|
inherited |
|
inherited |
|
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.
|
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.
|
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.
|
protected |
train on a single example (online learning)
| ex | VwExample instance |
Definition at line 132 of file VwConditionalProbabilityTree.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
| data | training data |
Reimplemented from CMachine.
Definition at line 95 of file VwConditionalProbabilityTree.cpp.
train a single node
| ex | VwExample instance of the training example |
| node | the node |
Definition at line 213 of file VwConditionalProbabilityTree.cpp.
train on a path from a node up to the root
| ex | VwExample instance of the training example |
| node | the leaf node |
Definition at line 194 of file VwConditionalProbabilityTree.cpp.
|
protectedvirtual |
the labels will be embedded in the streaming features
Reimplemented from CMachine.
Definition at line 85 of file VwConditionalProbabilityTree.h.
|
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.
decide which subtree to go, when training the tree structure.
| node | the node being decided |
| ex | the example being decided |
|
inherited |
io
Definition at line 537 of file SGObject.h.
|
protectedinherited |
|
protected |
online features
Definition at line 135 of file VwConditionalProbabilityTree.h.
|
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 |
class => leaf mapping
Definition at line 134 of file VwConditionalProbabilityTree.h.
|
protectedinherited |
machines
Definition at line 56 of file BaseMulticlassMachine.h.
|
protectedinherited |
|
inherited |
model selection parameters
Definition at line 549 of file SGObject.h.
|
protected |
number of passes for online training
Definition at line 133 of file VwConditionalProbabilityTree.h.
|
inherited |
parameters
Definition at line 546 of file SGObject.h.
|
protectedinherited |
tree root
Definition at line 156 of file TreeMachine.h.
|
protectedinherited |
|
protectedinherited |
|
inherited |
parallel
Definition at line 540 of file SGObject.h.
|
inherited |
version
Definition at line 543 of file SGObject.h.