SHOGUN
4.1.0
|
generic linear multiclass machine
Definition at line 29 of file LinearMulticlassMachine.h.
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 | 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 void | store_model_features () |
void | init_strategy () |
void | clear_machines () |
virtual bool | train_machine (CFeatures *data=NULL) |
virtual bool | is_acceptable_machine (CMachine *machine) |
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) |
Protected Attributes | |
CDotFeatures * | m_features |
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 |
default constructor
Definition at line 33 of file LinearMulticlassMachine.h.
CLinearMulticlassMachine | ( | CMulticlassStrategy * | strategy, |
CDotFeatures * | features, | ||
CLinearMachine * | machine, | ||
CLabels * | labs | ||
) |
standard constructor
strategy | multiclass strategy |
features | features |
machine | linear machine |
labs | labels |
Definition at line 45 of file LinearMulticlassMachine.h.
|
virtual |
destructor
Definition at line 54 of file LinearMulticlassMachine.h.
set subset to the features of the machine, deletes old one
subset | subset instance to set |
Implements CMulticlassMachine.
Definition at line 152 of file LinearMulticlassMachine.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, CWDSVMOcas, 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, and CMultitaskLinearMachine.
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.
|
virtualinherited |
classify all examples
Reimplemented from CMachine.
Reimplemented in CGaussianNaiveBayes, CMCLDA, and CQDA.
Definition at line 93 of file MulticlassMachine.cpp.
|
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, CWDSVMOcas, COnlineLinearMachine, CNeuralNetwork, CCHAIDTree, CStochasticGBMachine, CCARTree, CLinearMachine, 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 597 of file SGObject.cpp.
|
protectedinherited |
clear machines
|
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 714 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 198 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 618 of file SGObject.cpp.
|
virtualinherited |
get classifier type
Reimplemented in CLaRank, CSVMLight, CDualLibQPBMSOSVM, CNeuralNetwork, CCCSOSVM, CLeastAngleRegression, CLDA, CKernelRidgeRegression, CLibLinearMTL, CBaggingMachine, CLibLinear, CGaussianProcessClassification, CKMeans, CLibSVR, CQDA, CGaussianNaiveBayes, CSVRLight, CMCLDA, CLinearRidgeRegression, CKNN, CScatterSVM, CGaussianProcessRegression, CSGDQN, CSVMSGD, CSVMOcas, COnlineSVMSGD, CLeastSquaresRegression, CMKLRegression, CDomainAdaptationSVMLinear, CMKLMulticlass, CWDSVMOcas, CHierarchical, CMKLOneClass, CLibSVM, CStochasticSOSVM, CMKLClassification, CDomainAdaptationSVM, CLPBoost, CPerceptron, CAveragedPerceptron, CFWSOSVM, CNewtonSVM, CLPM, CGMNPSVM, CSVMLightOneClass, CSVMLin, CMulticlassLibSVM, CLibSVMOneClass, CMPDSVM, CGPBTSVM, CGNPPSVM, and CCPLEXSVM.
Definition at line 92 of file Machine.cpp.
CDotFeatures* get_features | ( | ) | const |
|
inherited |
|
inherited |
|
inherited |
|
virtualinherited |
|
inherited |
get machine
num | index of machine to get |
Definition at line 74 of file MulticlassMachine.h.
construct linear machine from given linear machine
Implements CMulticlassMachine.
Definition at line 137 of file LinearMulticlassMachine.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 498 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 522 of file SGObject.cpp.
|
inherited |
Returns index of model selection parameter with provided index
param_name | name of model selection parameter |
Definition at line 535 of file SGObject.cpp.
|
inherited |
get the type of multiclass'ness
Definition at line 114 of file MulticlassMachine.h.
|
virtual |
get name
Reimplemented from CMulticlassMachine.
Reimplemented in CMulticlassLibLinear, CDomainAdaptationMulticlassLibLinear, CMulticlassTreeGuidedLogisticRegression, CShareBoost, CMulticlassLogisticRegression, and CMulticlassOCAS.
Definition at line 60 of file LinearMulticlassMachine.h.
|
inherited |
get number of machines
Definition at line 27 of file BaseMulticlassMachine.cpp.
|
protectedvirtual |
get number of rhs feature vectors
Implements CMulticlassMachine.
Definition at line 143 of file LinearMulticlassMachine.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.
|
protectedvirtual |
init machine for train with setting features
Implements CMulticlassMachine.
Definition at line 96 of file LinearMulticlassMachine.h.
|
protectedvirtual |
init machines for applying with setting features
Implements CMulticlassMachine.
Definition at line 110 of file LinearMulticlassMachine.h.
|
protectedinherited |
init strategy
Definition at line 65 of file MulticlassMachine.cpp.
|
protectedvirtualinherited |
whether the machine is acceptable in set_machine
Reimplemented in CMulticlassSVM, and CNativeMulticlassMachine.
Definition at line 193 of file MulticlassMachine.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 296 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.
|
protectedvirtual |
check features availability
Implements CMulticlassMachine.
Definition at line 128 of file LinearMulticlassMachine.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 369 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 426 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 421 of file SGObject.cpp.
|
virtualinherited |
Definition at line 262 of file SGObject.cpp.
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 474 of file SGObject.cpp.
|
virtualinherited |
prints registered parameters out
prefix | prefix for members |
Definition at line 308 of file SGObject.cpp.
|
protectedvirtual |
deletes any subset set to the features of the machine
Implements CMulticlassMachine.
Definition at line 160 of file LinearMulticlassMachine.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 314 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 436 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 431 of file SGObject.cpp.
void set_features | ( | CDotFeatures * | f | ) |
|
inherited |
Definition at line 41 of file SGObject.cpp.
|
inherited |
Definition at line 46 of file SGObject.cpp.
|
inherited |
Definition at line 51 of file SGObject.cpp.
|
inherited |
Definition at line 56 of file SGObject.cpp.
|
inherited |
Definition at line 61 of file SGObject.cpp.
|
inherited |
Definition at line 66 of file SGObject.cpp.
|
inherited |
Definition at line 71 of file SGObject.cpp.
|
inherited |
Definition at line 76 of file SGObject.cpp.
|
inherited |
Definition at line 81 of file SGObject.cpp.
|
inherited |
Definition at line 86 of file SGObject.cpp.
|
inherited |
Definition at line 91 of file SGObject.cpp.
|
inherited |
Definition at line 96 of file SGObject.cpp.
|
inherited |
Definition at line 101 of file SGObject.cpp.
|
inherited |
Definition at line 106 of file SGObject.cpp.
|
inherited |
Definition at line 111 of file SGObject.cpp.
|
inherited |
set generic type to T
|
inherited |
|
inherited |
set the parallel object
parallel | parallel object to use |
Definition at line 241 of file SGObject.cpp.
|
inherited |
set the version object
version | version object to use |
Definition at line 283 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.
|
virtualinherited |
A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.
Reimplemented in CGaussianKernel.
Definition at line 192 of file SGObject.cpp.
|
protectedvirtual |
Stores feature data of underlying model. Does nothing because Linear machines store the normal vector of the separating hyperplane and therefore the model anyway
Reimplemented from CMachine.
Definition at line 171 of file LinearMulticlassMachine.h.
|
virtualinherited |
Reimplemented in CKernelMachine, and CMultitaskLinearMachine.
|
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 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, and CMultitaskLinearMachine.
|
protectedvirtualinherited |
train machine
Reimplemented from CMachine.
Reimplemented in CLaRank, CMKLMulticlass, CQDA, CMulticlassLibLinear, CMCLDA, CMulticlassOCAS, CMulticlassTreeGuidedLogisticRegression, CScatterSVM, CGaussianNaiveBayes, CMulticlassLogisticRegression, CGMNPSVM, CShareBoost, and CMulticlassLibSVM.
Definition at line 243 of file MulticlassMachine.cpp.
|
protectedvirtualinherited |
returns whether machine require labels for training
Reimplemented in COnlineLinearMachine, CHierarchical, CLinearLatentMachine, CVwConditionalProbabilityTree, CConditionalProbabilityTree, and CLibSVMOneClass.
|
inherited |
unset generic type
this has to be called in classes specializing a template class
Definition at line 303 of file SGObject.cpp.
|
virtualinherited |
Updates the hash of current parameter combination
Definition at line 248 of file SGObject.cpp.
|
inherited |
io
Definition at line 369 of file SGObject.h.
|
protectedinherited |
|
protected |
features
Definition at line 176 of file LinearMulticlassMachine.h.
|
inherited |
parameters wrt which we can compute gradients
Definition at line 384 of file SGObject.h.
|
inherited |
Hash of parameter values
Definition at line 387 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 381 of file SGObject.h.
|
protectedinherited |
type of multiclass strategy
Definition at line 205 of file MulticlassMachine.h.
|
inherited |
parameters
Definition at line 378 of file SGObject.h.
|
protectedinherited |
|
protectedinherited |
|
inherited |
parallel
Definition at line 372 of file SGObject.h.
|
inherited |
version
Definition at line 375 of file SGObject.h.