SHOGUN
4.2.0
|
Class MCLDA implements multiclass Linear Discriminant Analysis.
MCLDA learns a linear classifier and requires examples to be CDenseFeatures. The learned linear classification rule is optimal under the assumption that the classes are gaussian distributed with equal co-variance
Public Member Functions | |
CMCLDA (float64_t tolerance=1e-4, bool store_cov=false) | |
CMCLDA (CDenseFeatures< float64_t > *traindat, CLabels *trainlab, float64_t tolerance=1e-4, bool store_cov=false) | |
virtual | ~CMCLDA () |
virtual CMulticlassLabels * | apply_multiclass (CFeatures *data=NULL) |
void | set_tolerance (float64_t tolerance) |
bool | get_tolerance () |
virtual EMachineType | get_classifier_type () |
virtual void | set_features (CDotFeatures *feat) |
virtual CDotFeatures * | get_features () |
virtual const char * | get_name () const |
SGVector< float64_t > | get_mean (int32_t c) const |
SGMatrix< float64_t > | get_cov () const |
virtual void | set_labels (CLabels *lab) |
bool | set_machine (int32_t num, CMachine *machine) |
CMachine * | get_machine (int32_t num) const |
virtual CBinaryLabels * | get_submachine_outputs (int32_t i) |
virtual float64_t | get_submachine_output (int32_t i, int32_t num) |
virtual CMultilabelLabels * | apply_multilabel_output (CFeatures *data=NULL, int32_t n_outputs=5) |
virtual float64_t | apply_one (int32_t vec_idx) |
CMulticlassStrategy * | get_multiclass_strategy () const |
CRejectionStrategy * | get_rejection_strategy () const |
void | set_rejection_strategy (CRejectionStrategy *rejection_strategy) |
EProbHeuristicType | get_prob_heuris () |
void | set_prob_heuris (EProbHeuristicType prob_heuris) |
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 CLabels * | get_labels () |
void | set_max_train_time (float64_t t) |
float64_t | get_max_train_time () |
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 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_machine (CFeatures *data=NULL) |
void | init_strategy () |
void | clear_machines () |
virtual bool | init_machine_for_train (CFeatures *data) |
virtual bool | init_machines_for_apply (CFeatures *data) |
virtual bool | is_ready () |
virtual CMachine * | get_machine_from_trained (CMachine *machine) |
virtual int32_t | get_num_rhs_vectors () |
virtual void | add_machine_subset (SGVector< index_t > subset) |
virtual void | remove_machine_subset () |
virtual bool | is_acceptable_machine (CMachine *machine) |
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 | |
CMulticlassStrategy * | m_multiclass_strategy |
CMachine * | m_machine |
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 |
CMCLDA | ( | CDenseFeatures< float64_t > * | traindat, |
CLabels * | trainlab, | ||
float64_t | tolerance = 1e-4 , |
||
bool | store_cov = false |
||
) |
set subset to the features of the machine, deletes old one
subset | subset indices to set |
Implements CMulticlassMachine.
Definition at line 68 of file NativeMulticlassMachine.h.
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 CMCLDA to data
data | (test) data to be classified |
Reimplemented from CMulticlassMachine.
|
virtualinherited |
classify all examples with multiple output
Definition at line 195 of file MulticlassMachine.cpp.
|
virtualinherited |
classify one example
vec_idx |
Reimplemented from CMachine.
Reimplemented in CScatterSVM, and CGaussianNaiveBayes.
Definition at line 283 of file MulticlassMachine.cpp.
|
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.
|
protectedinherited |
clear machines
Definition at line 47 of file NativeMulticlassMachine.h.
|
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.
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.
|
virtual |
|
virtual |
|
inherited |
|
inherited |
|
inherited |
|
virtualinherited |
|
inherited |
get machine
num | index of machine to get |
Definition at line 74 of file MulticlassMachine.h.
obtain machine from trained one
Implements CMulticlassMachine.
Definition at line 59 of file NativeMulticlassMachine.h.
|
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.
|
inherited |
get the type of multiclass'ness
Definition at line 114 of file MulticlassMachine.h.
|
virtual |
|
inherited |
get number of machines
Definition at line 27 of file BaseMulticlassMachine.cpp.
|
protectedvirtualinherited |
get num rhs vectors
Implements CMulticlassMachine.
Definition at line 62 of file NativeMulticlassMachine.h.
|
inherited |
get prob output heuristic of multiclass strategy
Definition at line 145 of file MulticlassMachine.h.
|
inherited |
returns rejection strategy
Definition at line 124 of file MulticlassMachine.h.
|
inherited |
|
virtualinherited |
get output of i-th submachine for num-th vector
i | number of submachine |
num | number of feature vector |
Definition at line 80 of file MulticlassMachine.cpp.
|
virtualinherited |
get outputs of i-th submachine
i | number of submachine |
Reimplemented in CDomainAdaptationMulticlassLibLinear.
Definition at line 71 of file MulticlassMachine.cpp.
bool get_tolerance | ( | ) |
|
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.
|
protectedvirtualinherited |
abstract init machine for training method
Implements CMulticlassMachine.
Definition at line 50 of file NativeMulticlassMachine.h.
|
protectedvirtualinherited |
abstract init machines for applying method
Implements CMulticlassMachine.
Definition at line 53 of file NativeMulticlassMachine.h.
|
protectedinherited |
init strategy
Definition at line 44 of file NativeMulticlassMachine.h.
|
protectedvirtualinherited |
whether the machine is acceptable in set_machine
Reimplemented from CMulticlassMachine.
Definition at line 74 of file NativeMulticlassMachine.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.
|
protectedvirtualinherited |
check whether machine is ready
Implements CMulticlassMachine.
Definition at line 56 of file NativeMulticlassMachine.h.
|
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.
|
protectedvirtualinherited |
deletes any subset set to the features of the machine
Implements CMulticlassMachine.
Definition at line 71 of file NativeMulticlassMachine.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.
|
virtual |
|
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 from CMachine.
Definition at line 52 of file MulticlassMachine.cpp.
|
inherited |
set machine
num | index of machine |
machine | machine to set |
Definition at line 59 of file MulticlassMachine.h.
|
inherited |
set maximum training time
t | maximimum training time |
Definition at line 82 of file Machine.cpp.
|
inherited |
set prob output heuristic of multiclass strategy
prob_heuris | type of probability heuristic |
Definition at line 153 of file MulticlassMachine.h.
|
inherited |
sets rejection strategy
rejection_strategy | rejection strategy to be set |
Definition at line 133 of file MulticlassMachine.h.
|
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.
void set_tolerance | ( | float64_t | tolerance | ) |
|
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 |
Stores feature data of underlying model. After this method has been called, it is possible to change the machine's feature data and call apply(), which is then performed on the training feature data that is part of the machine's model.
Base method, has to be implemented in order to allow cross-validation and model selection.
NOT IMPLEMENTED! Has to be done in subclasses
Reimplemented in CKernelMachine, CKNN, CLinearMachine, CLinearMulticlassMachine, CKMeansBase, CTreeMachine< T >, CTreeMachine< ConditionalProbabilityTreeNodeData >, CTreeMachine< RelaxedTreeNodeData >, CTreeMachine< id3TreeNodeData >, CTreeMachine< VwConditionalProbabilityTreeNodeData >, CTreeMachine< CARTreeNodeData >, CTreeMachine< C45TreeNodeData >, CTreeMachine< CHAIDTreeNodeData >, CTreeMachine< NbodyTreeNodeData >, CGaussianProcessMachine, CHierarchical, CDistanceMachine, CKernelMulticlassMachine, and CLinearStructuredOutputMachine.
|
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.
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 MCLDA classifier
data | training data |
Reimplemented from CMulticlassMachine.
|
protectedvirtualinherited |
returns whether machine require labels for training
Reimplemented in COnlineLinearMachine, CKMeansBase, CHierarchical, CLinearLatentMachine, CVwConditionalProbabilityTree, CConditionalProbabilityTree, and CLibSVMOneClass.
|
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.
|
protectedinherited |
|
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.
|
protectedinherited |
machine
Definition at line 208 of file MulticlassMachine.h.
|
protectedinherited |
machines
Definition at line 56 of file BaseMulticlassMachine.h.
|
protectedinherited |
|
inherited |
model selection parameters
Definition at line 549 of file SGObject.h.
|
protectedinherited |
type of multiclass strategy
Definition at line 205 of file MulticlassMachine.h.
|
inherited |
parameters
Definition at line 546 of file SGObject.h.
|
protectedinherited |
|
protectedinherited |
|
inherited |
parallel
Definition at line 540 of file SGObject.h.
|
inherited |
version
Definition at line 543 of file SGObject.h.