SHOGUN
v3.0.0
|
A generic KernelMachine interface.
A kernel machine is defined as
\[ f({\bf x})=\sum_{i=0}^{N-1} \alpha_i k({\bf x}, {\bf x_i})+b \]
where \(N\) is the number of training examples \(\alpha_i\) are the weights assigned to each training example \(k(x,x')\) is the kernel and \(b\) the bias.
Using an a-priori choosen kernel, the \(\alpha_i\) and bias are determined in a training procedure.
Kernel machines support locking. This means that given some data, the machine can be locked. When this is done, the kernel matrix is computed and stored in a custom kernel. Speeds up cross-validation. Only train_locked and apply_locked are available when locked.
Definition at line 50 of file KernelMachine.h.
Static Public Member Functions | |
static void * | apply_helper (void *p) |
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 |
Protected Member Functions | |
SGVector< float64_t > | apply_get_outputs (CFeatures *data) |
virtual void | store_model_features () |
virtual bool | train_machine (CFeatures *data=NULL) |
virtual bool | is_label_valid (CLabels *lab) const |
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) |
Protected Attributes | |
CKernel * | kernel |
CCustomKernel * | m_custom_kernel |
CKernel * | m_kernel_backup |
bool | use_batch_computation |
bool | use_linadd |
bool | use_bias |
float64_t | m_bias |
SGVector< float64_t > | m_alpha |
SGVector< int32_t > | m_svs |
float64_t | m_max_train_time |
CLabels * | m_labels |
ESolverType | m_solver_type |
bool | m_store_model_features |
bool | m_data_locked |
CKernelMachine | ( | ) |
default constructor
Definition at line 35 of file KernelMachine.cpp.
CKernelMachine | ( | CKernel * | k, |
const SGVector< float64_t > | alphas, | ||
const SGVector< int32_t > | svs, | ||
float64_t | b | ||
) |
Convenience constructor to initialize a trained kernel machine
k | kernel |
alphas | vector of alpha weights |
svs | indices of examples, i.e. i's for x_i |
b | bias term |
Definition at line 40 of file KernelMachine.cpp.
CKernelMachine | ( | CKernelMachine * | machine | ) |
copy constructor
machine | machine having parameters to copy |
Definition at line 54 of file KernelMachine.cpp.
|
virtual |
destructor
Definition at line 71 of file KernelMachine.cpp.
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.
|
virtual |
apply kernel machine to data for binary classification task
data | (test)data to be classified |
Reimplemented from CMachine.
Reimplemented in CDomainAdaptationSVM.
Definition at line 245 of file KernelMachine.cpp.
apply get outputs
data | features to compute outputs |
Definition at line 251 of file KernelMachine.cpp.
|
static |
apply example helper, used in threads
p | params of the thread |
Definition at line 421 of file KernelMachine.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.
|
virtual |
Applies a locked machine on a set of indices. Error if machine is not locked. Binary case
indices | index vector (of locked features) that is predicted |
Reimplemented from CMachine.
Definition at line 515 of file KernelMachine.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 528 of file KernelMachine.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.
|
virtual |
Applies a locked machine on a set of indices. Error if machine is not locked. Binary case
indices | index vector (of locked features) that is predicted |
Reimplemented from CMachine.
Definition at line 521 of file KernelMachine.cpp.
|
virtualinherited |
applies a locked machine on a set of indices for structured problems
Definition at line 269 of file Machine.cpp.
|
virtualinherited |
apply machine to data in means of multiclass classification problem
Reimplemented in CMulticlassMachine, CKNN, CDistanceMachine, CVwConditionalProbabilityTree, CGaussianNaiveBayes, CConditionalProbabilityTree, CMCLDA, CQDA, CRelaxedTree, and CBaggingMachine.
Definition at line 230 of file Machine.cpp.
|
virtual |
apply kernel machine to one example
num | which example to apply to |
Reimplemented from CMachine.
Definition at line 402 of file KernelMachine.cpp.
|
virtual |
apply kernel machine to data for regression task
data | (test)data to be classified |
Reimplemented from CMachine.
Definition at line 239 of file KernelMachine.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 1196 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 1313 of file SGObject.cpp.
bool create_new_model | ( | int32_t | num | ) |
create new model
num | number of alphas and support vectors in new model |
Definition at line 191 of file KernelMachine.cpp.
Locks the machine on given labels and data. After this call, only train_locked and apply_locked may be called.
Computes kernel matrix to speed up train/apply calls
labs | labels used for locking |
features | features used for locking |
Reimplemented from CMachine.
Definition at line 620 of file KernelMachine.cpp.
|
virtual |
Unlocks a locked machine and restores previous state
Reimplemented from CMachine.
Definition at line 649 of file KernelMachine.cpp.
|
virtualinherited |
A deep copy. All the instance variables will also be copied.
Definition at line 160 of file SGObject.h.
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) |
Definition at line 1217 of file SGObject.cpp.
float64_t get_alpha | ( | int32_t | idx | ) |
get alpha at given index
idx | index of alpha |
Definition at line 137 of file KernelMachine.cpp.
Definition at line 186 of file KernelMachine.cpp.
bool get_batch_computation_enabled | ( | ) |
check if batch computation is enabled
Definition at line 96 of file KernelMachine.cpp.
float64_t get_bias | ( | ) |
bool get_bias_enabled | ( | ) |
|
virtualinherited |
get classifier type
Reimplemented in CLaRank, CSVMLight, CDualLibQPBMSOSVM, CCCSOSVM, CLeastAngleRegression, CKernelRidgeRegression, CLibLinearMTL, CBaggingMachine, CLibSVR, CLDA, CQDA, CLibLinear, CGaussianNaiveBayes, CSVRLight, CMCLDA, CLinearRidgeRegression, CScatterSVM, CKNN, CGaussianProcessRegression, CSGDQN, CSVMSGD, CSVMOcas, CLeastSquaresRegression, COnlineSVMSGD, CKMeans, CDomainAdaptationSVMLinear, CMKLRegression, CWDSVMOcas, CHierarchical, CLPBoost, CMKLMulticlass, CMKLClassification, CMKLOneClass, CLibSVM, CDomainAdaptationSVM, CLPM, CPerceptron, CAveragedPerceptron, CNewtonSVM, CSVMLightOneClass, CSVMLin, CGMNPSVM, CMulticlassLibSVM, CGPBTSVM, CLibSVMOneClass, CGNPPSVM, CMPDSVM, and CCPLEXSVM.
Definition at line 102 of file Machine.cpp.
|
inherited |
|
inherited |
|
inherited |
CKernel * get_kernel | ( | ) |
|
virtualinherited |
bool get_linadd_enabled | ( | ) |
check if linadd is enabled
Definition at line 106 of file KernelMachine.cpp.
|
virtualinherited |
returns type of problem machine solves
Reimplemented in CBaseMulticlassMachine.
|
inherited |
|
inherited |
Definition at line 1100 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 1124 of file SGObject.cpp.
|
inherited |
Returns index of model selection parameter with provided index
param_name | name of model selection parameter |
Definition at line 1137 of file SGObject.cpp.
|
virtual |
Returns the name of the SGSerializable instance. It MUST BE the CLASS NAME without the prefixed `C'.
Reimplemented from CMachine.
Reimplemented in CSVMLight, CMKL, CSVM, CSVRLight, CKernelRidgeRegression, CLibSVR, CDomainAdaptationSVM, CLibSVM, CSVMLightOneClass, CMKLRegression, CMKLClassification, CMKLOneClass, CGPBTSVM, CLibSVMOneClass, CGNPPSVM, and CMPDSVM.
Definition at line 79 of file KernelMachine.h.
int32_t get_num_support_vectors | ( | ) |
get number of support vectors
Definition at line 166 of file KernelMachine.cpp.
|
inherited |
int32_t get_support_vector | ( | int32_t | idx | ) |
get support vector at given index
idx | index of support vector |
Definition at line 131 of file KernelMachine.cpp.
SGVector< int32_t > get_support_vectors | ( | ) |
Definition at line 181 of file KernelMachine.cpp.
bool init_kernel_optimization | ( | ) |
initialise kernel optimisation
Definition at line 208 of file KernelMachine.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 268 of file SGObject.cpp.
|
protectedvirtualinherited |
check whether the labels is valid.
Subclasses can override this to implement their check of label types.
lab | the labels being checked, guaranteed to be non-NULL |
Reimplemented in CGaussianProcessRegression, and CBaseMulticlassMachine.
|
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 673 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 514 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 345 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, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.
Definition at line 1029 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. |
Reimplemented in CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, CDynamicArray< uint64_t >, and CDynamicObjectArray.
Definition at line 1024 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 711 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 918 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 858 of file SGObject.cpp.
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 1076 of file SGObject.cpp.
|
virtualinherited |
prints registered parameters out
prefix | prefix for members |
Definition at line 280 of file SGObject.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 286 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 1039 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, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, CDynamicArray< uint64_t >, and CDynamicObjectArray.
Definition at line 1034 of file SGObject.cpp.
bool set_alpha | ( | int32_t | idx, |
float64_t | val | ||
) |
set alpha at given index to given value
idx | index of alpha vector |
val | new value of alpha vector |
Definition at line 156 of file KernelMachine.cpp.
set alphas to given values
alphas | float vector with all alphas to set |
Definition at line 171 of file KernelMachine.cpp.
void set_batch_computation_enabled | ( | bool | enable | ) |
set batch computation enabled
enable | if batch computation shall be enabled |
Definition at line 91 of file KernelMachine.cpp.
void set_bias | ( | float64_t | bias | ) |
void set_bias_enabled | ( | bool | enable_bias | ) |
set state of bias
enable_bias | if bias shall be enabled |
Definition at line 111 of file KernelMachine.cpp.
|
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 220 of file SGObject.cpp.
|
inherited |
set the version object
version | version object to use |
Definition at line 255 of file SGObject.cpp.
void set_kernel | ( | CKernel * | k | ) |
|
virtualinherited |
set labels
lab | labels |
Reimplemented in CGaussianProcessMachine, CStructuredOutputMachine, CRelaxedTree, and CMulticlassMachine.
Definition at line 75 of file Machine.cpp.
void set_linadd_enabled | ( | bool | enable | ) |
set linadd enabled
enable | if linadd shall be enabled |
Definition at line 101 of file KernelMachine.cpp.
|
inherited |
set maximum training time
t | maximimum training time |
Definition at line 92 of file Machine.cpp.
|
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.
bool set_support_vector | ( | int32_t | idx, |
int32_t | val | ||
) |
set support vector at given index to given value
idx | index of support vector |
val | new value of support vector |
Definition at line 146 of file KernelMachine.cpp.
void set_support_vectors | ( | SGVector< int32_t > | svs | ) |
set support vectors to given values
svs | integer vector with all support vectors indexes to set |
Definition at line 176 of file KernelMachine.cpp.
|
virtualinherited |
A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.
Reimplemented in CGaussianKernel.
Definition at line 151 of file SGObject.h.
|
protectedvirtual |
Stores feature data of the SV indices and sets it to the lhs of the underlying kernel. Then, all SV indices are set to identity.
May be overwritten by subclasses in case the model should be stored differently.
Reimplemented from CMachine.
Definition at line 450 of file KernelMachine.cpp.
|
virtual |
Reimplemented from CMachine.
Definition at line 707 of file KernelMachine.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, 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
indices | index vector (of locked features) that is used for training |
Reimplemented from CMachine.
Definition at line 479 of file KernelMachine.cpp.
|
protectedvirtualinherited |
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) |
NOT IMPLEMENTED!
Reimplemented in CSVMLight, CLaRank, CWDSVMOcas, CLibLinearMTL, CMKL, COnlineLinearMachine, CSVRLight, CDualLibQPBMSOSVM, CPluginEstimate, CRelaxedTree, CKNN, CSVMOcas, CLeastAngleRegression, CCCSOSVM, CLibLinear, CMulticlassMachine, CMKLMulticlass, CQDA, CSVMSGD, CMulticlassLibLinear, CVowpalWabbit, CLibLinearRegression, CMCLDA, CKMeans, CKernelRidgeRegression, CDomainAdaptationSVMLinear, CLDA, CBaggingMachine, CMultitaskLinearMachine, CHierarchical, CMulticlassOCAS, CMulticlassTreeGuidedLogisticRegression, CLibSVR, CLPBoost, CLinearLatentMachine, CDomainAdaptationSVM, CNewtonSVM, CSVMLin, CFeatureBlockLogisticRegression, CScatterSVM, CLinearRidgeRegression, CLPM, CMultitaskLogisticRegression, CGaussianNaiveBayes, CMultitaskClusteredLogisticRegression, CNearestCentroid, CGaussianProcessRegression, CMulticlassLogisticRegression, CVwConditionalProbabilityTree, CMultitaskLeastSquaresRegression, CConditionalProbabilityTree, CMultitaskL12LogisticRegression, CPerceptron, CAveragedPerceptron, CGMNPSVM, CMultitaskTraceLogisticRegression, CLibSVM, CSVMLightOneClass, CShareBoost, CLibSVMOneClass, CMulticlassLibSVM, CGPBTSVM, CGNPPSVM, CMPDSVM, and CCPLEXSVM.
|
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 275 of file SGObject.cpp.
|
virtualinherited |
Updates the hash of current parameter combination.
Definition at line 227 of file SGObject.cpp.
|
inherited |
io
Definition at line 514 of file SGObject.h.
|
protected |
kernel
Definition at line 310 of file KernelMachine.h.
coefficients alpha
Definition at line 331 of file KernelMachine.h.
|
protected |
bias term b
Definition at line 328 of file KernelMachine.h.
|
protected |
is filled with pre-computed custom kernel on data lock
Definition at line 313 of file KernelMachine.h.
|
protectedinherited |
|
inherited |
parameters wrt which we can compute gradients
Definition at line 529 of file SGObject.h.
|
inherited |
Hash of parameter values
Definition at line 535 of file SGObject.h.
|
protected |
old kernel is stored here on data lock
Definition at line 316 of file KernelMachine.h.
|
protectedinherited |
|
inherited |
model selection parameters
Definition at line 526 of file SGObject.h.
|
inherited |
map for different parameter versions
Definition at line 532 of file SGObject.h.
|
inherited |
parameters
Definition at line 523 of file SGObject.h.
|
protectedinherited |
|
protectedinherited |
|
protected |
array of ``support vectors'' (indices of feature objects)
Definition at line 334 of file KernelMachine.h.
|
inherited |
parallel
Definition at line 517 of file SGObject.h.
|
protected |
if batch computation is enabled
Definition at line 319 of file KernelMachine.h.
|
protected |
if bias shall be used
Definition at line 325 of file KernelMachine.h.
|
protected |
if linadd is enabled
Definition at line 322 of file KernelMachine.h.
|
inherited |
version
Definition at line 520 of file SGObject.h.