SHOGUN  v3.2.0
所有成员列表 | Public 成员函数 | 静态 Public 成员函数 | Public 属性 | Protected 成员函数 | Protected 属性
CKernelRidgeRegression类 参考

详细描述

Class KernelRidgeRegression implements Kernel Ridge Regression - a regularized least square method for classification and regression.

It is similar to support vector machines (cf. CSVM). However in contrast to SVMs a different objective is optimized that leads to a dense solution (thus not only a few support vectors are active in the end but all training examples). This makes it only applicable to rather few (a couple of thousand) training examples. In case a linear kernel is used RR is closely related to Fishers Linear Discriminant (cf. LDA).

Internally (for linear kernels) it is solved via minimizing the following system

\[ \frac{1}{2}\left(\sum_{i=1}^N(y_i-{\bf w}\cdot {\bf x}_i)^2 + \tau||{\bf w}||^2\right) \]

which boils down to solving a linear system

\[ {\bf w} = \left(\tau {\bf I}+ \sum_{i=1}^N{\bf x}_i{\bf x}_i^T\right)^{-1}\left(\sum_{i=1}^N y_i{\bf x}_i\right) \]

and in the kernel case

\[ {\bf \alpha}=\left({\bf K}+\tau{\bf I}\right)^{-1}{\bf y} \]

where K is the kernel matrix and y the vector of labels. The expressed solution can again be written as a linear combination of kernels (cf. CKernelMachine) with bias \(b=0\).

在文件 KernelRidgeRegression.h64 行定义.

类 CKernelRidgeRegression 继承关系图:
Inheritance graph
[图例]

Public 成员函数

 MACHINE_PROBLEM_TYPE (PT_REGRESSION)
 
 CKernelRidgeRegression ()
 
 CKernelRidgeRegression (float64_t tau, CKernel *k, CLabels *lab, ETrainingType m=PINV)
 
virtual ~CKernelRidgeRegression ()
 
void set_tau (float64_t tau)
 
void set_epsilon (float64_t epsilon)
 
virtual bool load (FILE *srcfile)
 
virtual bool save (FILE *dstfile)
 
virtual EMachineType get_classifier_type ()
 
virtual const char * get_name () const
 
void set_kernel (CKernel *k)
 
CKernelget_kernel ()
 
void set_batch_computation_enabled (bool enable)
 
bool get_batch_computation_enabled ()
 
void set_linadd_enabled (bool enable)
 
bool get_linadd_enabled ()
 
void set_bias_enabled (bool enable_bias)
 
bool get_bias_enabled ()
 
float64_t get_bias ()
 
void set_bias (float64_t bias)
 
int32_t get_support_vector (int32_t idx)
 
float64_t get_alpha (int32_t idx)
 
bool set_support_vector (int32_t idx, int32_t val)
 
bool set_alpha (int32_t idx, float64_t val)
 
int32_t get_num_support_vectors ()
 
void set_alphas (SGVector< float64_t > alphas)
 
void set_support_vectors (SGVector< int32_t > svs)
 
SGVector< int32_t > get_support_vectors ()
 
SGVector< float64_tget_alphas ()
 
bool create_new_model (int32_t num)
 
bool init_kernel_optimization ()
 
virtual CRegressionLabelsapply_regression (CFeatures *data=NULL)
 
virtual CBinaryLabelsapply_binary (CFeatures *data=NULL)
 
virtual float64_t apply_one (int32_t num)
 
virtual bool train_locked (SGVector< index_t > indices)
 
virtual CBinaryLabelsapply_locked_binary (SGVector< index_t > indices)
 
virtual CRegressionLabelsapply_locked_regression (SGVector< index_t > indices)
 
virtual SGVector< float64_tapply_locked_get_output (SGVector< index_t > indices)
 
virtual void data_lock (CLabels *labs, CFeatures *features=NULL)
 
virtual void data_unlock ()
 
virtual bool supports_locking () const
 
virtual bool train (CFeatures *data=NULL)
 
virtual CLabelsapply (CFeatures *data=NULL)
 
virtual CMulticlassLabelsapply_multiclass (CFeatures *data=NULL)
 
virtual CStructuredLabelsapply_structured (CFeatures *data=NULL)
 
virtual CLatentLabelsapply_latent (CFeatures *data=NULL)
 
virtual void set_labels (CLabels *lab)
 
virtual CLabelsget_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 CLabelsapply_locked (SGVector< index_t > indices)
 
virtual CMulticlassLabelsapply_locked_multiclass (SGVector< index_t > indices)
 
virtual CStructuredLabelsapply_locked_structured (SGVector< index_t > indices)
 
virtual CLatentLabelsapply_locked_latent (SGVector< index_t > indices)
 
virtual void post_lock (CLabels *labs, CFeatures *features)
 
bool is_data_locked () const
 
virtual EProblemType get_machine_problem_type () const
 
virtual CSGObjectshallow_copy () const
 
virtual CSGObjectdeep_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="", int32_t param_version=Version::get_version_parameter())
 
virtual bool load_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=Version::get_version_parameter())
 
DynArray< TParameter * > * load_file_parameters (const SGParamInfo *param_info, int32_t file_version, CSerializableFile *file, const char *prefix="")
 
DynArray< TParameter * > * load_all_file_parameters (int32_t file_version, int32_t current_version, CSerializableFile *file, const char *prefix="")
 
void map_parameters (DynArray< TParameter *> *param_base, int32_t &base_version, DynArray< const SGParamInfo *> *target_param_infos)
 
void set_global_io (SGIO *io)
 
SGIOget_global_io ()
 
void set_global_parallel (Parallel *parallel)
 
Parallelget_global_parallel ()
 
void set_global_version (Version *version)
 
Versionget_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)
 
virtual bool update_parameter_hash ()
 
virtual bool equals (CSGObject *other, float64_t accuracy=0.0)
 
virtual CSGObjectclone ()
 

静态 Public 成员函数

static void * apply_helper (void *p)
 

Public 属性

SGIOio
 
Parallelparallel
 
Versionversion
 
Parameterm_parameters
 
Parameterm_model_selection_parameters
 
Parameterm_gradient_parameters
 
ParameterMapm_parameter_map
 
uint32_t m_hash
 

Protected 成员函数

virtual bool train_machine (CFeatures *data=NULL)
 
SGVector< float64_tapply_get_outputs (CFeatures *data)
 
virtual void store_model_features ()
 
virtual bool is_label_valid (CLabels *lab) const
 
virtual bool train_require_labels () const
 
virtual TParametermigrate (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 属性

CKernelkernel
 
CCustomKernelm_custom_kernel
 
CKernelm_kernel_backup
 
bool use_batch_computation
 
bool use_linadd
 
bool use_bias
 
float64_t m_bias
 
SGVector< float64_tm_alpha
 
SGVector< int32_t > m_svs
 
float64_t m_max_train_time
 
CLabelsm_labels
 
ESolverType m_solver_type
 
bool m_store_model_features
 
bool m_data_locked
 

构造及析构函数说明

◆ CKernelRidgeRegression() [1/2]

default constructor

在文件 KernelRidgeRegression.cpp22 行定义.

◆ CKernelRidgeRegression() [2/2]

CKernelRidgeRegression ( float64_t  tau,
CKernel k,
CLabels lab,
ETrainingType  m = PINV 
)

constructor

参数
tauregularization constant tau
kkernel
lablabels
mmethod to use for training PINV (pseudo inverse by default)

在文件 KernelRidgeRegression.cpp28 行定义.

◆ ~CKernelRidgeRegression()

virtual ~CKernelRidgeRegression ( )
virtual

default destructor

在文件 KernelRidgeRegression.h83 行定义.

成员函数说明

◆ apply()

CLabels * apply ( CFeatures data = NULL)
virtualinherited

apply machine to data if data is not specified apply to the current features

参数
data(test)data to be classified
返回
classified labels

在文件 Machine.cpp162 行定义.

◆ apply_binary()

CBinaryLabels * apply_binary ( CFeatures data = NULL)
virtualinherited

apply kernel machine to data for binary classification task

参数
data(test)data to be classified
返回
classified labels

重载 CMachine .

在文件 KernelMachine.cpp245 行定义.

◆ apply_get_outputs()

SGVector< float64_t > apply_get_outputs ( CFeatures data)
protectedinherited

apply get outputs

参数
datafeatures to compute outputs
返回
outputs

在文件 KernelMachine.cpp251 行定义.

◆ apply_helper()

void * apply_helper ( void *  p)
staticinherited

apply example helper, used in threads

参数
pparams of the thread
返回
nothing really

在文件 KernelMachine.cpp421 行定义.

◆ apply_latent()

CLatentLabels * apply_latent ( CFeatures data = NULL)
virtualinherited

apply machine to data in means of latent problem

CLinearLatentMachine 重载.

在文件 Machine.cpp242 行定义.

◆ apply_locked()

CLabels * apply_locked ( SGVector< index_t indices)
virtualinherited

Applies a locked machine on a set of indices. Error if machine is not locked

参数
indicesindex vector (of locked features) that is predicted

在文件 Machine.cpp197 行定义.

◆ apply_locked_binary()

CBinaryLabels * apply_locked_binary ( SGVector< index_t indices)
virtualinherited

Applies a locked machine on a set of indices. Error if machine is not locked. Binary case

参数
indicesindex vector (of locked features) that is predicted
返回
resulting labels

重载 CMachine .

在文件 KernelMachine.cpp515 行定义.

◆ apply_locked_get_output()

SGVector< float64_t > apply_locked_get_output ( SGVector< index_t indices)
virtualinherited

Applies a locked machine on a set of indices. Error if machine is not locked

参数
indicesindex vector (of locked features) that is predicted
返回
raw output of machine

在文件 KernelMachine.cpp528 行定义.

◆ apply_locked_latent()

CLatentLabels * apply_locked_latent ( SGVector< index_t indices)
virtualinherited

applies a locked machine on a set of indices for latent problems

在文件 Machine.cpp276 行定义.

◆ apply_locked_multiclass()

CMulticlassLabels * apply_locked_multiclass ( SGVector< index_t indices)
virtualinherited

applies a locked machine on a set of indices for multiclass problems

在文件 Machine.cpp262 行定义.

◆ apply_locked_regression()

CRegressionLabels * apply_locked_regression ( SGVector< index_t indices)
virtualinherited

Applies a locked machine on a set of indices. Error if machine is not locked. Binary case

参数
indicesindex vector (of locked features) that is predicted
返回
resulting labels

重载 CMachine .

在文件 KernelMachine.cpp521 行定义.

◆ apply_locked_structured()

CStructuredLabels * apply_locked_structured ( SGVector< index_t indices)
virtualinherited

applies a locked machine on a set of indices for structured problems

在文件 Machine.cpp269 行定义.

◆ apply_multiclass()

CMulticlassLabels * apply_multiclass ( CFeatures data = NULL)
virtualinherited

apply machine to data in means of multiclass classification problem

CMulticlassMachine, CKNN, CDistanceMachine, CVwConditionalProbabilityTree, CGaussianNaiveBayes, CConditionalProbabilityTree, CMCLDA, CQDA, CRelaxedTree , 以及 CBaggingMachine 重载.

在文件 Machine.cpp230 行定义.

◆ apply_one()

float64_t apply_one ( int32_t  num)
virtualinherited

apply kernel machine to one example

参数
numwhich example to apply to
返回
classified value

重载 CMachine .

在文件 KernelMachine.cpp402 行定义.

◆ apply_regression()

CRegressionLabels * apply_regression ( CFeatures data = NULL)
virtualinherited

apply kernel machine to data for regression task

参数
data(test)data to be classified
返回
classified labels

重载 CMachine .

在文件 KernelMachine.cpp239 行定义.

◆ apply_structured()

CStructuredLabels * apply_structured ( CFeatures data = NULL)
virtualinherited

apply machine to data in means of SO classification problem

CLinearStructuredOutputMachine 重载.

在文件 Machine.cpp236 行定义.

◆ build_gradient_parameter_dictionary()

void build_gradient_parameter_dictionary ( CMap< TParameter *, CSGObject *> *  dict)
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.

参数
dictdictionary of parameters to be built.

在文件 SGObject.cpp1156 行定义.

◆ clone()

CSGObject * clone ( )
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.

返回
an identical copy of the given object, which is disjoint in memory. NULL if the clone fails. Note that the returned object is SG_REF'ed

在文件 SGObject.cpp1273 行定义.

◆ create_new_model()

bool create_new_model ( int32_t  num)
inherited

create new model

参数
numnumber of alphas and support vectors in new model

在文件 KernelMachine.cpp191 行定义.

◆ data_lock()

void data_lock ( CLabels labs,
CFeatures features = NULL 
)
virtualinherited

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

参数
labslabels used for locking
featuresfeatures used for locking

重载 CMachine .

在文件 KernelMachine.cpp620 行定义.

◆ data_unlock()

void data_unlock ( )
virtualinherited

Unlocks a locked machine and restores previous state

重载 CMachine .

在文件 KernelMachine.cpp649 行定义.

◆ deep_copy()

virtual CSGObject* deep_copy ( ) const
virtualinherited

A deep copy. All the instance variables will also be copied.

在文件 SGObject.h126 行定义.

◆ equals()

bool equals ( CSGObject other,
float64_t  accuracy = 0.0 
)
virtualinherited

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.

参数
otherobject to compare with
accuracyaccuracy to use for comparison (optional)
返回
true if all parameters were equal, false if not

在文件 SGObject.cpp1177 行定义.

◆ get_alpha()

float64_t get_alpha ( int32_t  idx)
inherited

get alpha at given index

参数
idxindex of alpha
返回
alpha

在文件 KernelMachine.cpp137 行定义.

◆ get_alphas()

SGVector< float64_t > get_alphas ( )
inherited
返回
vector of alphas

在文件 KernelMachine.cpp186 行定义.

◆ get_batch_computation_enabled()

bool get_batch_computation_enabled ( )
inherited

check if batch computation is enabled

返回
if batch computation is enabled

在文件 KernelMachine.cpp96 行定义.

◆ get_bias()

float64_t get_bias ( )
inherited

get bias

返回
bias

在文件 KernelMachine.cpp121 行定义.

◆ get_bias_enabled()

bool get_bias_enabled ( )
inherited

get state of bias

返回
state of bias

在文件 KernelMachine.cpp116 行定义.

◆ get_classifier_type()

virtual EMachineType get_classifier_type ( )
virtual

get classifier type

返回
classifier type KernelRidgeRegression

重载 CMachine .

在文件 KernelRidgeRegression.h115 行定义.

◆ get_global_io()

SGIO * get_global_io ( )
inherited

get the io object

返回
io object

在文件 SGObject.cpp174 行定义.

◆ get_global_parallel()

Parallel * get_global_parallel ( )
inherited

get the parallel object

返回
parallel object

在文件 SGObject.cpp209 行定义.

◆ get_global_version()

Version * get_global_version ( )
inherited

get the version object

返回
version object

在文件 SGObject.cpp222 行定义.

◆ get_kernel()

CKernel * get_kernel ( )
inherited

get kernel

返回
kernel

在文件 KernelMachine.cpp85 行定义.

◆ get_labels()

CLabels * get_labels ( )
virtualinherited

get labels

返回
labels

在文件 Machine.cpp86 行定义.

◆ get_linadd_enabled()

bool get_linadd_enabled ( )
inherited

check if linadd is enabled

返回
if linadd is enabled

在文件 KernelMachine.cpp106 行定义.

◆ get_machine_problem_type()

virtual EProblemType get_machine_problem_type ( ) const
virtualinherited

returns type of problem machine solves

CBaseMulticlassMachine 重载.

在文件 Machine.h294 行定义.

◆ get_max_train_time()

float64_t get_max_train_time ( )
inherited

get maximum training time

返回
maximum training time

在文件 Machine.cpp97 行定义.

◆ get_modelsel_names()

SGStringList< char > get_modelsel_names ( )
inherited
返回
vector of names of all parameters which are registered for model selection

在文件 SGObject.cpp1060 行定义.

◆ get_modsel_param_descr()

char * get_modsel_param_descr ( const char *  param_name)
inherited

Returns description of a given parameter string, if it exists. SG_ERROR otherwise

参数
param_namename of the parameter
返回
description of the parameter

在文件 SGObject.cpp1084 行定义.

◆ get_modsel_param_index()

index_t get_modsel_param_index ( const char *  param_name)
inherited

Returns index of model selection parameter with provided index

参数
param_namename of model selection parameter
返回
index of model selection parameter with provided name, -1 if there is no such

在文件 SGObject.cpp1097 行定义.

◆ get_name()

virtual const char* get_name ( ) const
virtual
返回
object name

重载 CKernelMachine .

在文件 KernelRidgeRegression.h121 行定义.

◆ get_num_support_vectors()

int32_t get_num_support_vectors ( )
inherited

get number of support vectors

返回
number of support vectors

在文件 KernelMachine.cpp166 行定义.

◆ get_solver_type()

ESolverType get_solver_type ( )
inherited

get solver type

返回
solver

在文件 Machine.cpp112 行定义.

◆ get_support_vector()

int32_t get_support_vector ( int32_t  idx)
inherited

get support vector at given index

参数
idxindex of support vector
返回
support vector

在文件 KernelMachine.cpp131 行定义.

◆ get_support_vectors()

SGVector< int32_t > get_support_vectors ( )
inherited
返回
all support vectors

在文件 KernelMachine.cpp181 行定义.

◆ init_kernel_optimization()

bool init_kernel_optimization ( )
inherited

initialise kernel optimisation

返回
if operation was successful

在文件 KernelMachine.cpp208 行定义.

◆ is_data_locked()

bool is_data_locked ( ) const
inherited
返回
whether this machine is locked

在文件 Machine.h291 行定义.

◆ is_generic()

bool is_generic ( EPrimitiveType *  generic) const
virtualinherited

If the SGSerializable is a class template then TRUE will be returned and GENERIC is set to the type of the generic.

参数
genericset to the type of the generic if returning TRUE
返回
TRUE if a class template.

在文件 SGObject.cpp228 行定义.

◆ is_label_valid()

virtual bool is_label_valid ( CLabels lab) const
protectedvirtualinherited

check whether the labels is valid.

Subclasses can override this to implement their check of label types.

参数
labthe labels being checked, guaranteed to be non-NULL

CGaussianProcessBinaryClassification, CGaussianProcessRegression , 以及 CBaseMulticlassMachine 重载.

在文件 Machine.h343 行定义.

◆ load()

bool load ( FILE *  srcfile)
virtual

load regression from file

参数
srcfilefile to load from
返回
if loading was successful

在文件 KernelRidgeRegression.cpp155 行定义.

◆ load_all_file_parameters()

DynArray< TParameter * > * load_all_file_parameters ( int32_t  file_version,
int32_t  current_version,
CSerializableFile file,
const char *  prefix = "" 
)
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_versionparameter version of the file
current_versionversion from which mapping begins (you want to use Version::get_version_parameter() for this in most cases)
filefile to load from
prefixprefix for members
返回
(sorted) array of created TParameter instances with file data

在文件 SGObject.cpp633 行定义.

◆ load_file_parameters()

DynArray< TParameter * > * load_file_parameters ( const SGParamInfo param_info,
int32_t  file_version,
CSerializableFile file,
const char *  prefix = "" 
)
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_infoinformation of parameter
file_versionparameter version of the file, must be <= provided parameter version
filefile to load from
prefixprefix for members
返回
new array with TParameter instances with the attached data

在文件 SGObject.cpp474 行定义.

◆ load_serializable()

bool load_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = Version::get_version_parameter() 
)
virtualinherited

Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!

参数
filewhere to load from
prefixprefix for members
param_version(optional) a parameter version different to (this is mainly for testing, better do not use)
返回
TRUE if done, otherwise FALSE

在文件 SGObject.cpp305 行定义.

◆ load_serializable_post()

void load_serializable_post ( )
throw (ShogunException
)
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.

异常
ShogunExceptionWill be thrown if an error occurres.

CWeightedDegreePositionStringKernel, CKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel , 以及 CExponentialKernel 重载.

在文件 SGObject.cpp989 行定义.

◆ load_serializable_pre()

void load_serializable_pre ( )
throw (ShogunException
)
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.

异常
ShogunExceptionWill be thrown if an error occurres.

CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.

在文件 SGObject.cpp984 行定义.

◆ MACHINE_PROBLEM_TYPE()

MACHINE_PROBLEM_TYPE ( PT_REGRESSION  )

problem type

◆ map_parameters()

void map_parameters ( DynArray< TParameter *> *  param_base,
int32_t &  base_version,
DynArray< const SGParamInfo *> *  target_param_infos 
)
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_baseset of TParameter instances that are mapped to the provided target parameter infos
base_versionversion of the parameter base
target_param_infosset of SGParamInfo instances that specify the target parameter base

在文件 SGObject.cpp671 行定义.

◆ migrate()

TParameter * migrate ( DynArray< TParameter *> *  param_base,
const SGParamInfo target 
)
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_baseset of TParameter instances to use for migration
targetparameter info for the resulting TParameter
返回
a new TParameter instance with migrated data from the base of the type which is specified by the target parameter

在文件 SGObject.cpp878 行定义.

◆ one_to_one_migration_prepare()

void one_to_one_migration_prepare ( DynArray< TParameter *> *  param_base,
const SGParamInfo target,
TParameter *&  replacement,
TParameter *&  to_migrate,
char *  old_name = NULL 
)
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_baseset of TParameter instances to use for migration
targetparameter info for the resulting TParameter
replacement(used as output) here the TParameter instance which is returned by migration is created into
to_migratethe only source that is used for migration
old_namewith this parameter, a name change may be specified

在文件 SGObject.cpp818 行定义.

◆ post_lock()

virtual void post_lock ( CLabels labs,
CFeatures features 
)
virtualinherited

post lock

CMultitaskLinearMachine 重载.

在文件 Machine.h282 行定义.

◆ print_modsel_params()

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

在文件 SGObject.cpp1036 行定义.

◆ print_serializable()

void print_serializable ( const char *  prefix = "")
virtualinherited

prints registered parameters out

参数
prefixprefix for members

在文件 SGObject.cpp240 行定义.

◆ save()

bool save ( FILE *  dstfile)
virtual

save regression to file

参数
dstfilefile to save to
返回
if saving was successful

在文件 KernelRidgeRegression.cpp162 行定义.

◆ save_serializable()

bool save_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = Version::get_version_parameter() 
)
virtualinherited

Save this object to file.

参数
filewhere to save the object; will be closed during returning if PREFIX is an empty string.
prefixprefix for members
param_version(optional) a parameter version different to (this is mainly for testing, better do not use)
返回
TRUE if done, otherwise FALSE

在文件 SGObject.cpp246 行定义.

◆ save_serializable_post()

void save_serializable_post ( )
throw (ShogunException
)
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.

异常
ShogunExceptionWill be thrown if an error occurres.

CKernel 重载.

在文件 SGObject.cpp999 行定义.

◆ save_serializable_pre()

void save_serializable_pre ( )
throw (ShogunException
)
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.

异常
ShogunExceptionWill be thrown if an error occurres.

CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.

在文件 SGObject.cpp994 行定义.

◆ set_alpha()

bool set_alpha ( int32_t  idx,
float64_t  val 
)
inherited

set alpha at given index to given value

参数
idxindex of alpha vector
valnew value of alpha vector
返回
if operation was successful

在文件 KernelMachine.cpp156 行定义.

◆ set_alphas()

void set_alphas ( SGVector< float64_t alphas)
inherited

set alphas to given values

参数
alphasfloat vector with all alphas to set

在文件 KernelMachine.cpp171 行定义.

◆ set_batch_computation_enabled()

void set_batch_computation_enabled ( bool  enable)
inherited

set batch computation enabled

参数
enableif batch computation shall be enabled

在文件 KernelMachine.cpp91 行定义.

◆ set_bias()

void set_bias ( float64_t  bias)
inherited

set bias to given value

参数
biasnew bias

在文件 KernelMachine.cpp126 行定义.

◆ set_bias_enabled()

void set_bias_enabled ( bool  enable_bias)
inherited

set state of bias

参数
enable_biasif bias shall be enabled

在文件 KernelMachine.cpp111 行定义.

◆ set_epsilon()

void set_epsilon ( float64_t  epsilon)

set convergence precision for gauss seidel method

参数
epsilonnew epsilon

在文件 KernelRidgeRegression.h95 行定义.

◆ set_generic() [1/16]

void set_generic ( )
inherited

在文件 SGObject.cpp41 行定义.

◆ set_generic() [2/16]

void set_generic ( )
inherited

在文件 SGObject.cpp46 行定义.

◆ set_generic() [3/16]

void set_generic ( )
inherited

在文件 SGObject.cpp51 行定义.

◆ set_generic() [4/16]

void set_generic ( )
inherited

在文件 SGObject.cpp56 行定义.

◆ set_generic() [5/16]

void set_generic ( )
inherited

在文件 SGObject.cpp61 行定义.

◆ set_generic() [6/16]

void set_generic ( )
inherited

在文件 SGObject.cpp66 行定义.

◆ set_generic() [7/16]

void set_generic ( )
inherited

在文件 SGObject.cpp71 行定义.

◆ set_generic() [8/16]

void set_generic ( )
inherited

在文件 SGObject.cpp76 行定义.

◆ set_generic() [9/16]

void set_generic ( )
inherited

在文件 SGObject.cpp81 行定义.

◆ set_generic() [10/16]

void set_generic ( )
inherited

在文件 SGObject.cpp86 行定义.

◆ set_generic() [11/16]

void set_generic ( )
inherited

在文件 SGObject.cpp91 行定义.

◆ set_generic() [12/16]

void set_generic ( )
inherited

在文件 SGObject.cpp96 行定义.

◆ set_generic() [13/16]

void set_generic ( )
inherited

在文件 SGObject.cpp101 行定义.

◆ set_generic() [14/16]

void set_generic ( )
inherited

在文件 SGObject.cpp106 行定义.

◆ set_generic() [15/16]

void set_generic ( )
inherited

在文件 SGObject.cpp111 行定义.

◆ set_generic() [16/16]

void set_generic ( )
inherited

set generic type to T

◆ set_global_io()

void set_global_io ( SGIO io)
inherited

set the io object

参数
ioio object to use

在文件 SGObject.cpp167 行定义.

◆ set_global_parallel()

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

参数
parallelparallel object to use

在文件 SGObject.cpp180 行定义.

◆ set_global_version()

void set_global_version ( Version version)
inherited

set the version object

参数
versionversion object to use

在文件 SGObject.cpp215 行定义.

◆ set_kernel()

void set_kernel ( CKernel k)
inherited

set kernel

参数
kkernel

在文件 KernelMachine.cpp78 行定义.

◆ set_labels()

void set_labels ( CLabels lab)
virtualinherited

set labels

参数
lablabels

CGaussianProcessMachine, CStructuredOutputMachine, CRelaxedTree , 以及 CMulticlassMachine 重载.

在文件 Machine.cpp75 行定义.

◆ set_linadd_enabled()

void set_linadd_enabled ( bool  enable)
inherited

set linadd enabled

参数
enableif linadd shall be enabled

在文件 KernelMachine.cpp101 行定义.

◆ set_max_train_time()

void set_max_train_time ( float64_t  t)
inherited

set maximum training time

参数
tmaximimum training time

在文件 Machine.cpp92 行定义.

◆ set_solver_type()

void set_solver_type ( ESolverType  st)
inherited

set solver type

参数
stsolver type

在文件 Machine.cpp107 行定义.

◆ set_store_model_features()

void set_store_model_features ( bool  store_model)
virtualinherited

Setter for store-model-features-after-training flag

参数
store_modelwhether model should be stored after training

在文件 Machine.cpp117 行定义.

◆ set_support_vector()

bool set_support_vector ( int32_t  idx,
int32_t  val 
)
inherited

set support vector at given index to given value

参数
idxindex of support vector
valnew value of support vector
返回
if operation was successful

在文件 KernelMachine.cpp146 行定义.

◆ set_support_vectors()

void set_support_vectors ( SGVector< int32_t >  svs)
inherited

set support vectors to given values

参数
svsinteger vector with all support vectors indexes to set

在文件 KernelMachine.cpp176 行定义.

◆ set_tau()

void set_tau ( float64_t  tau)

set regularization constant

参数
taunew tau

在文件 KernelRidgeRegression.h89 行定义.

◆ shallow_copy()

virtual CSGObject* shallow_copy ( ) const
virtualinherited

A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.

CGaussianKernel 重载.

在文件 SGObject.h117 行定义.

◆ store_model_features()

void store_model_features ( )
protectedvirtualinherited

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.

重载 CMachine .

在文件 KernelMachine.cpp450 行定义.

◆ supports_locking()

bool supports_locking ( ) const
virtualinherited
返回
whether machine supports locking

重载 CMachine .

在文件 KernelMachine.cpp707 行定义.

◆ train()

bool train ( CFeatures data = NULL)
virtualinherited

train machine

参数
datatraining 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.
返回
whether training was successful

CRelaxedTree, CSGDQN , 以及 COnlineSVMSGD 重载.

在文件 Machine.cpp49 行定义.

◆ train_locked()

bool train_locked ( SGVector< index_t indices)
virtualinherited

Trains a locked machine on a set of indices. Error if machine is not locked

参数
indicesindex vector (of locked features) that is used for training
返回
whether training was successful

重载 CMachine .

在文件 KernelMachine.cpp479 行定义.

◆ train_machine()

bool train_machine ( CFeatures data = NULL)
protectedvirtual

train regression

参数
datatraining data (parameter can be avoided if distance or kernel-based regressors are used and distance/kernels are initialized with train data)
返回
whether training was successful

重载 CMachine .

在文件 KernelRidgeRegression.cpp125 行定义.

◆ train_require_labels()

virtual bool train_require_labels ( ) const
protectedvirtualinherited

returns whether machine require labels for training

COnlineLinearMachine, CHierarchical, CLinearLatentMachine, CVwConditionalProbabilityTree, CConditionalProbabilityTree , 以及 CLibSVMOneClass 重载.

在文件 Machine.h349 行定义.

◆ unset_generic()

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

在文件 SGObject.cpp235 行定义.

◆ update_parameter_hash()

bool update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination.

返回
bool if parameter combination has changed since last update.

在文件 SGObject.cpp187 行定义.

类成员变量说明

◆ io

SGIO* io
inherited

io

在文件 SGObject.h473 行定义.

◆ kernel

CKernel* kernel
protectedinherited

kernel

在文件 KernelMachine.h310 行定义.

◆ m_alpha

SGVector<float64_t> m_alpha
protectedinherited

coefficients alpha

在文件 KernelMachine.h331 行定义.

◆ m_bias

float64_t m_bias
protectedinherited

bias term b

在文件 KernelMachine.h328 行定义.

◆ m_custom_kernel

CCustomKernel* m_custom_kernel
protectedinherited

is filled with pre-computed custom kernel on data lock

在文件 KernelMachine.h313 行定义.

◆ m_data_locked

bool m_data_locked
protectedinherited

whether data is locked

在文件 Machine.h365 行定义.

◆ m_gradient_parameters

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

在文件 SGObject.h488 行定义.

◆ m_hash

uint32_t m_hash
inherited

Hash of parameter values

在文件 SGObject.h494 行定义.

◆ m_kernel_backup

CKernel* m_kernel_backup
protectedinherited

old kernel is stored here on data lock

在文件 KernelMachine.h316 行定义.

◆ m_labels

CLabels* m_labels
protectedinherited

labels

在文件 Machine.h356 行定义.

◆ m_max_train_time

float64_t m_max_train_time
protectedinherited

maximum training time

在文件 Machine.h353 行定义.

◆ m_model_selection_parameters

Parameter* m_model_selection_parameters
inherited

model selection parameters

在文件 SGObject.h485 行定义.

◆ m_parameter_map

ParameterMap* m_parameter_map
inherited

map for different parameter versions

在文件 SGObject.h491 行定义.

◆ m_parameters

Parameter* m_parameters
inherited

parameters

在文件 SGObject.h482 行定义.

◆ m_solver_type

ESolverType m_solver_type
protectedinherited

solver type

在文件 Machine.h359 行定义.

◆ m_store_model_features

bool m_store_model_features
protectedinherited

whether model features should be stored after training

在文件 Machine.h362 行定义.

◆ m_svs

SGVector<int32_t> m_svs
protectedinherited

array of ``support vectors'' (indices of feature objects)

在文件 KernelMachine.h334 行定义.

◆ parallel

Parallel* parallel
inherited

parallel

在文件 SGObject.h476 行定义.

◆ use_batch_computation

bool use_batch_computation
protectedinherited

if batch computation is enabled

在文件 KernelMachine.h319 行定义.

◆ use_bias

bool use_bias
protectedinherited

if bias shall be used

在文件 KernelMachine.h325 行定义.

◆ use_linadd

bool use_linadd
protectedinherited

if linadd is enabled

在文件 KernelMachine.h322 行定义.

◆ version

Version* version
inherited

version

在文件 SGObject.h479 行定义.


该类的文档由以下文件生成:

SHOGUN Machine Learning Toolbox - Documentation