SHOGUN
v2.0.0
|
Class GMNPSVM implements a one vs. rest MultiClass SVM.
It uses CGMNPLib for training (in true multiclass-SVM fashion).
Public Attributes | |
SGIO * | io |
Parallel * | parallel |
Version * | version |
Parameter * | m_parameters |
Parameter * | m_model_selection_parameters |
ParameterMap * | m_parameter_map |
uint32_t | m_hash |
Protected Member Functions | |
virtual bool | train_machine (CFeatures *data=NULL) |
CSVM * | svm_proto () |
SGVector< int32_t > | svm_svs () |
virtual bool | init_machines_for_apply (CFeatures *data) |
virtual bool | is_acceptable_machine (CMachine *machine) |
virtual bool | init_machine_for_train (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 () |
void | init_strategy () |
void | clear_machines () |
virtual bool | train_require_labels () const |
virtual TParameter * | migrate (DynArray< TParameter * > *param_base, const SGParamInfo *target) |
virtual void | one_to_one_migration_prepare (DynArray< TParameter * > *param_base, const SGParamInfo *target, TParameter *&replacement, TParameter *&to_migrate, char *old_name=NULL) |
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) |
virtual bool | update_parameter_hash () |
CGMNPSVM | ( | ) |
default constructor
Definition at line 25 of file GMNPSVM.cpp.
|
virtual |
default destructor
Definition at line 37 of file GMNPSVM.cpp.
set subset to the features of the machine, deletes old one
subset | subset indices to set |
Implements CMulticlassMachine.
Definition at line 153 of file KernelMulticlassMachine.h.
apply machine to data if data is not specified apply to the current features
data | (test)data to be classified |
Definition at line 162 of file Machine.cpp.
|
virtualinherited |
apply machine to data in means of binary classification problem
Reimplemented in CKernelMachine, COnlineLinearMachine, CWDSVMOcas, CLinearMachine, CDomainAdaptationSVMLinear, CDomainAdaptationSVM, and CPluginEstimate.
Definition at line 218 of file Machine.cpp.
|
virtualinherited |
apply machine to data in means of latent problem
Reimplemented in CLinearLatentMachine.
Definition at line 242 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 197 of file Machine.cpp.
|
virtualinherited |
applies a locked machine on a set of indices for binary problems
Reimplemented in CKernelMachine, CMultitaskLinearMachine, and CMultitaskCompositeMachine.
Definition at line 248 of file Machine.cpp.
|
virtualinherited |
applies a locked machine on a set of indices for latent problems
Definition at line 276 of file Machine.cpp.
|
virtualinherited |
applies a locked machine on a set of indices for multiclass problems
Definition at line 262 of file Machine.cpp.
|
virtualinherited |
applies a locked machine on a set of indices for regression problems
Reimplemented in CKernelMachine.
Definition at line 255 of file Machine.cpp.
|
virtualinherited |
applies a locked machine on a set of indices for structured problems
Definition at line 269 of file Machine.cpp.
|
virtualinherited |
classify all examples
Reimplemented from CMachine.
Reimplemented in CGaussianNaiveBayes, and CQDA.
Definition at line 92 of file MulticlassMachine.cpp.
|
virtualinherited |
classify all examples with multiple output
Definition at line 146 of file MulticlassMachine.cpp.
|
virtualinherited |
classify one example
vec_idx |
Reimplemented from CMachine.
Reimplemented in CGaussianNaiveBayes.
Definition at line 234 of file MulticlassMachine.cpp.
|
virtualinherited |
apply machine to data in means of regression problem
Reimplemented in CKernelMachine, CWDSVMOcas, COnlineLinearMachine, CGaussianProcessRegression, and CLinearMachine.
Definition at line 224 of file Machine.cpp.
|
virtualinherited |
apply machine to data in means of SO classification problem
Reimplemented in CLinearStructuredOutputMachine.
Definition at line 236 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 1204 of file SGObject.cpp.
|
protectedinherited |
clear machines
Reimplemented in CNativeMulticlassMachine.
|
virtualinherited |
clone
Reimplemented in CKernelMachine, and CLinearMachine.
|
inherited |
create multiclass SVM. Appends the appropriate number of svm pointer (depending on multiclass strategy) to m_machines. All pointers are initialized with NULL.
num_classes | number of classes in SVM |
Definition at line 46 of file MulticlassSVM.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 122 of file Machine.cpp.
|
virtualinherited |
Unlocks a locked machine and restores previous state
Reimplemented in CKernelMachine.
Definition at line 153 of file Machine.cpp.
|
virtualinherited |
A deep copy. All the instance variables will also be copied.
Definition at line 131 of file SGObject.h.
required for CMKLMulticlass constraint computation
y | height of basealphas |
x | width of basealphas |
Definition at line 186 of file GMNPSVM.cpp.
|
inherited |
get batch computation option of base SVM
Definition at line 144 of file MulticlassSVM.h.
|
inherited |
get bias enabled options of base SVM
Definition at line 134 of file MulticlassSVM.h.
|
inherited |
|
virtual |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
virtualinherited |
|
inherited |
get linadd option of base SVM
Definition at line 139 of file MulticlassSVM.h.
get linear term of base SVM
Definition at line 93 of file MulticlassSVM.h.
|
inherited |
get machine
num | index of machine to get |
Definition at line 71 of file MulticlassMachine.h.
construct kernel machine from given kernel machine
Implements CMulticlassMachine.
Definition at line 138 of file KernelMulticlassMachine.h.
|
virtualinherited |
get problem type
Reimplemented from CMachine.
Definition at line 46 of file BaseMulticlassMachine.h.
|
inherited |
|
inherited |
Definition at line 1108 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 1132 of file SGObject.cpp.
|
inherited |
Returns index of model selection parameter with provided index
param_name | name of model selection parameter |
Definition at line 1145 of file SGObject.cpp.
|
inherited |
get the type of multiclass'ness
Definition at line 111 of file MulticlassMachine.h.
|
virtual |
Reimplemented from CKernelMulticlassMachine.
|
inherited |
|
inherited |
get number of machines
Definition at line 40 of file BaseMulticlassMachine.h.
|
protectedvirtualinherited |
return number of rhs feature vectors
Implements CMulticlassMachine.
Definition at line 144 of file KernelMulticlassMachine.h.
|
inherited |
get objective of base SVM
Definition at line 128 of file MulticlassSVM.h.
|
inherited |
|
inherited |
returns rejection strategy
Definition at line 121 of file MulticlassMachine.h.
|
inherited |
get shrinking option of base SVM
Definition at line 123 of file MulticlassSVM.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 79 of file MulticlassMachine.cpp.
|
virtualinherited |
get outputs of i-th submachine
i | number of submachine |
Reimplemented in CDomainAdaptationMulticlassLibLinear.
Definition at line 70 of file MulticlassMachine.cpp.
|
inherited |
get SVM
num | which SVM to get |
Definition at line 74 of file MulticlassSVM.h.
|
inherited |
get tube epsilon of base SVM
Definition at line 98 of file MulticlassSVM.h.
|
protectedvirtualinherited |
init machine for training with kernel init
Implements CMulticlassMachine.
Definition at line 95 of file KernelMulticlassMachine.h.
|
protectedvirtualinherited |
initializes machines (OvO, OvR) for apply
Reimplemented from CKernelMulticlassMachine.
Definition at line 71 of file MulticlassSVM.cpp.
|
protectedinherited |
init strategy
Reimplemented in CNativeMulticlassMachine.
Definition at line 64 of file MulticlassMachine.cpp.
|
protectedvirtualinherited |
is machine an SVM instance
Reimplemented from CMulticlassMachine.
Definition at line 224 of file MulticlassSVM.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 278 of file SGObject.cpp.
|
virtualinherited |
check whether the labels is valid.
lab | the labels being checked, guaranteed to be non-NULL |
Reimplemented from CMachine.
Definition at line 55 of file BaseMulticlassMachine.h.
|
protectedvirtualinherited |
check kernel availability
Implements CMulticlassMachine.
Definition at line 129 of file KernelMulticlassMachine.h.
|
inherited |
load a Multiclass SVM from file
svm_file | the file handle |
Definition at line 109 of file MulticlassSVM.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_PARAMETER for this in most cases) |
file | file to load from |
prefix | prefix for members |
Definition at line 679 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 523 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) |
Reimplemented in CModelSelectionParameters.
Definition at line 354 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 occurres. |
Reimplemented in CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CANOVAKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.
Definition at line 1033 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 occurres. |
Definition at line 1028 of file SGObject.cpp.
|
inherited |
problem type
|
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 717 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 923 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 864 of file SGObject.cpp.
post lock
Reimplemented in CMultitaskLinearMachine, and CMultitaskCompositeMachine.
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 1084 of file SGObject.cpp.
|
virtualinherited |
prints registered parameters out
prefix | prefix for members |
Definition at line 290 of file SGObject.cpp.
|
protectedvirtualinherited |
deletes any subset set to the features of the machine
Implements CMulticlassMachine.
Definition at line 159 of file KernelMulticlassMachine.h.
|
inherited |
write a Multiclass SVM to a file
svm_file | the file handle |
Definition at line 257 of file MulticlassSVM.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) |
Reimplemented in CModelSelectionParameters.
Definition at line 296 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 occurres. |
Reimplemented in CKernel.
Definition at line 1043 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 occurres. |
Reimplemented in CKernel.
Definition at line 1038 of file SGObject.cpp.
|
inherited |
set batch computation option
enable | whether batch computation should be enabled |
Definition at line 205 of file MulticlassSVM.h.
|
inherited |
set bias option
enable_bias | whether bias should be enabled |
Definition at line 195 of file MulticlassSVM.h.
|
inherited |
set C parameters
C | set regularization parameter |
Definition at line 160 of file MulticlassSVM.h.
|
inherited |
set default number of support vectors
num_sv | number of support vectors |
Definition at line 150 of file MulticlassSVM.h.
|
inherited |
|
inherited |
set generic type to T
Definition at line 41 of file SGObject.cpp.
|
inherited |
|
inherited |
set the parallel object
parallel | parallel object to use |
Definition at line 230 of file SGObject.cpp.
|
inherited |
set the version object
version | version object to use |
Definition at line 265 of file SGObject.cpp.
|
inherited |
|
virtualinherited |
set labels
lab | labels |
Reimplemented from CMachine.
Definition at line 51 of file MulticlassMachine.cpp.
|
inherited |
set linadd option
enable | whether linadd should be enabled |
Definition at line 200 of file MulticlassSVM.h.
set linear term
linear_term | linear term vector |
Definition at line 155 of file MulticlassSVM.h.
|
inherited |
set machine
num | index of machine |
machine | machine to set |
Definition at line 56 of file MulticlassMachine.h.
|
inherited |
set maximum training time
t | maximimum training time |
Definition at line 92 of file Machine.cpp.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
sets rejection strategy
rejection_strategy | rejection strategy to be set |
Definition at line 130 of file MulticlassMachine.h.
|
inherited |
set shrinking option
enable | whether shrinking should be enabled |
Definition at line 185 of file MulticlassSVM.h.
|
inherited |
|
virtualinherited |
Setter for store-model-features-after-training flag
store_model | whether model should be stored after training |
Definition at line 117 of file Machine.cpp.
|
inherited |
set SVM
num | number to set |
svm | SVM to set |
Definition at line 61 of file MulticlassSVM.cpp.
|
inherited |
set tube epsilon value
eps | tube epsilon value |
Definition at line 175 of file MulticlassSVM.h.
|
virtualinherited |
A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.
Reimplemented in CGaussianKernel.
Definition at line 122 of file SGObject.h.
|
virtualinherited |
Stores feature data of underlying model.
Need to store the SVs for all sub-machines. We make a union of the SVs for all sub-machines, store the union and adjust the sub-machines to index into the union.
Reimplemented from CMachine.
Definition at line 17 of file KernelMulticlassMachine.cpp.
|
virtualinherited |
Reimplemented in CKernelMachine, CMultitaskLinearMachine, and CMultitaskCompositeMachine.
|
protectedinherited |
casts m_machine to SVM
Definition at line 210 of file MulticlassSVM.h.
|
protectedinherited |
returns support vectors
Definition at line 215 of file MulticlassSVM.h.
|
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, CSGDQN, and COnlineSVMSGD.
Definition at line 49 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, CMultitaskLinearMachine, and CMultitaskCompositeMachine.
|
protectedvirtual |
train SVM
data | training data (parameter can be avoided if distance or kernel-based classifiers are used and distance/kernels are initialized with train data) |
Reimplemented from CMulticlassMachine.
Definition at line 53 of file GMNPSVM.cpp.
|
protectedvirtualinherited |
returns whether machine require labels for training
Reimplemented in COnlineLinearMachine, CKMeans, CHierarchical, CLinearLatentMachine, CVwConditionalProbabilityTree, CConditionalProbabilityTree, and CLibSVMOneClass.
|
inherited |
unset generic type
this has to be called in classes specializing a template class
Definition at line 285 of file SGObject.cpp.
|
protectedvirtualinherited |
Updates the hash of current parameter combination.
Definition at line 237 of file SGObject.cpp.
|
inherited |
io
Definition at line 462 of file SGObject.h.
|
protected |
required for CMKLMulticlass stores the untransformed alphas of this algorithm whereas CSVM* members stores a transformed version of it m_basealphas[k][j] is the alpha for class k and sample j
|
protectedinherited |
C regularization constant
Definition at line 239 of file MulticlassSVM.h.
|
protectedinherited |
|
inherited |
Hash of parameter values
Definition at line 480 of file SGObject.h.
|
protectedinherited |
kernel
Definition at line 167 of file KernelMulticlassMachine.h.
|
protectedinherited |
machine
Definition at line 191 of file MulticlassMachine.h.
|
protectedinherited |
machines
Definition at line 62 of file BaseMulticlassMachine.h.
|
protectedinherited |
|
inherited |
model selection parameters
Definition at line 474 of file SGObject.h.
|
protectedinherited |
type of multiclass strategy
Definition at line 188 of file MulticlassMachine.h.
|
inherited |
map for different parameter versions
Definition at line 477 of file SGObject.h.
|
inherited |
parameters
Definition at line 471 of file SGObject.h.
|
protectedinherited |
|
protectedinherited |
|
inherited |
parallel
Definition at line 465 of file SGObject.h.
|
inherited |
version
Definition at line 468 of file SGObject.h.