SHOGUN  4.1.0
所有成员列表 | Public 成员函数 | Public 属性 | Protected 成员函数 | Protected 属性
CHMSVMModel类 参考

详细描述

Class CHMSVMModel that represents the application specific model and contains the application dependent logic to solve Hidden Markov Support Vector Machines (HM-SVM) type of problems within a generic SO framework.

在文件 HMSVMModel.h 第 31 行定义.

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

Public 成员函数

 CHMSVMModel ()
 
 CHMSVMModel (CFeatures *features, CStructuredLabels *labels, EStateModelType smt, int32_t num_obs=0, bool use_plifs=false)
 
virtual ~CHMSVMModel ()
 
virtual int32_t get_dim () const
 
virtual SGVector< float64_t > get_joint_feature_vector (int32_t feat_idx, CStructuredData *y)
 
virtual CResultSet * argmax (SGVector< float64_t > w, int32_t feat_idx, bool const training=true)
 
virtual float64_t delta_loss (CStructuredData *y1, CStructuredData *y2)
 
virtual void init_primal_opt (float64_t regularization, SGMatrix< float64_t > &A, SGVector< float64_t > a, SGMatrix< float64_t > B, SGVector< float64_t > &b, SGVector< float64_t > &lb, SGVector< float64_t > &ub, SGMatrix< float64_t > &C)
 
virtual bool check_training_setup () const
 
virtual int32_t get_num_aux () const
 
virtual int32_t get_num_aux_con () const
 
void set_use_plifs (bool use_plifs)
 
virtual void init_training ()
 
SGMatrix< float64_t > get_transmission_weights () const
 
SGVector< float64_t > get_emission_weights () const
 
CStateModel * get_state_model () const
 
virtual const char * get_name () const
 
void set_labels (CStructuredLabels *labs)
 
CStructuredLabels * get_labels ()
 
virtual CStructuredLabels * structured_labels_factory (int32_t num_labels=0)
 
void set_features (CFeatures *feats)
 
CFeatures * get_features ()
 
SGVector< float64_t > get_joint_feature_vector (int32_t feat_idx, int32_t lab_idx)
 
SGSparseVector< float64_t > get_sparse_joint_feature_vector (int32_t feat_idx, int32_t lab_idx)
 
virtual SGSparseVector< float64_t > get_sparse_joint_feature_vector (int32_t feat_idx, CStructuredData *y)
 
float64_t delta_loss (int32_t ytrue_idx, CStructuredData *ypred)
 
virtual CSGObject * shallow_copy () const
 
virtual CSGObject * deep_copy () const
 
virtual bool is_generic (EPrimitiveType *generic) const
 
template<class T >
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
void unset_generic ()
 
virtual void print_serializable (const char *prefix="")
 
virtual bool save_serializable (CSerializableFile *file, const char *prefix="")
 
virtual bool load_serializable (CSerializableFile *file, const char *prefix="")
 
void set_global_io (SGIO *io)
 
SGIO * get_global_io ()
 
void set_global_parallel (Parallel *parallel)
 
Parallel * get_global_parallel ()
 
void set_global_version (Version *version)
 
Version * get_global_version ()
 
SGStringList< char > get_modelsel_names ()
 
void print_modsel_params ()
 
char * get_modsel_param_descr (const char *param_name)
 
index_t get_modsel_param_index (const char *param_name)
 
void build_gradient_parameter_dictionary (CMap< TParameter *, CSGObject * > *dict)
 
virtual void update_parameter_hash ()
 
virtual bool parameter_hash_changed ()
 
virtual bool equals (CSGObject *other, float64_t accuracy=0.0, bool tolerant=false)
 
virtual CSGObject * clone ()
 

Public 属性

SGIO * io
 
Parallel * parallel
 
Version * version
 
Parameter * m_parameters
 
Parameter * m_model_selection_parameters
 
Parameter * m_gradient_parameters
 
uint32_t m_hash
 

Protected 成员函数

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 属性

CStructuredLabels * m_labels
 
CFeatures * m_features
 

构造及析构函数说明

default constructor

在文件 HMSVMModel.cpp 第 20 行定义.

CHMSVMModel ( CFeatures *  features,
CStructuredLabels *  labels,
EStateModelType  smt,
int32_t  num_obs = 0,
bool  use_plifs = false 
)

constructor

参数
featuresthe feature vectors, must be of type MatrixFeatures
labelssequence labels
smtinternal state representation
num_obsnumber of observations
use_plifswhether to model the observations using PLiFs

在文件 HMSVMModel.cpp 第 26 行定义.

~CHMSVMModel ( )
virtual

destructor

在文件 HMSVMModel.cpp 第 45 行定义.

成员函数说明

CResultSet * argmax ( SGVector< float64_t >  w,
int32_t  feat_idx,
bool const  training = true 
)
virtual

obtains the argmax of \( \Delta(y_{pred}, y_{truth}) + \langle w, \Psi(x_{truth}, y_{pred}) \rangle \)

参数
wweight vector
feat_idxindex of the feature to compute the argmax
trainingtrue if argmax is called during training. Then, it is assumed that the label indexed by feat_idx in m_labels corresponds to the true label of the corresponding feature vector.
返回
structure with the predicted output

实现了 CStructuredModel.

在文件 HMSVMModel.cpp 第 160 行定义.

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.cpp 第 597 行定义.

bool check_training_setup ( ) const
virtual

method to be called from a SO machine before training to ensure that the training data is valid

重载 CStructuredModel .

在文件 HMSVMModel.cpp 第 442 行定义.

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.cpp 第 714 行定义.

CSGObject * deep_copy ( ) const
virtualinherited

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

在文件 SGObject.cpp 第 198 行定义.

float64_t delta_loss ( CStructuredData *  y1,
CStructuredData *  y2 
)
virtual

computes \( \Delta(y_{1}, y_{2}) \)

参数
y1an instance of structured data
y2another instance of structured data
返回
loss value

重载 CStructuredModel .

在文件 HMSVMModel.cpp 第 348 行定义.

float64_t delta_loss ( int32_t  ytrue_idx,
CStructuredData *  ypred 
)
inherited

computes \( \Delta(y_{\text{true}}, y_{\text{pred}}) \)

参数
ytrue_idxindex of the true label in labels
ypredthe predicted label
返回
loss value

在文件 StructuredModel.cpp 第 147 行定义.

bool equals ( CSGObject *  other,
float64_t  accuracy = 0.0,
bool  tolerant = false 
)
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)
tolerantallows linient check on float equality (within accuracy)
返回
true if all parameters were equal, false if not

在文件 SGObject.cpp 第 618 行定义.

int32_t get_dim ( ) const
virtual

return the dimensionality of the joint feature space, i.e. the dimension of the weight vector \(w\)

实现了 CStructuredModel.

在文件 HMSVMModel.cpp 第 51 行定义.

SGVector< float64_t > get_emission_weights ( ) const

get emission weights

返回
vector with the emission weights

在文件 HMSVMModel.cpp 第 604 行定义.

CFeatures * get_features ( )
inherited

get features

返回
features

在文件 StructuredModel.cpp 第 99 行定义.

SGIO * get_global_io ( )
inherited

get the io object

返回
io object

在文件 SGObject.cpp 第 235 行定义.

Parallel * get_global_parallel ( )
inherited

get the parallel object

返回
parallel object

在文件 SGObject.cpp 第 277 行定义.

Version * get_global_version ( )
inherited

get the version object

返回
version object

在文件 SGObject.cpp 第 290 行定义.

SGVector< float64_t > get_joint_feature_vector ( int32_t  feat_idx,
CStructuredData *  y 
)
virtual

get joint feature vector

\[ \vec{\Psi}(\bf{x}_\text{feat\_idx}, \bf{y}) \]

参数
feat_idxindex of the feature vector to use
ystructured label to use
返回
the joint feature vector

重载 CStructuredModel .

在文件 HMSVMModel.cpp 第 64 行定义.

SGVector< float64_t > get_joint_feature_vector ( int32_t  feat_idx,
int32_t  lab_idx 
)
inherited

gets joint feature vector

\[ \vec{\Psi}(\bf{x}_\text{feat\_idx}, \bf{y}_\text{lab\_idx}) \]

参数
feat_idxindex of the feature vector to use
lab_idxindex of the structured label to use
返回
the joint feature vector

在文件 StructuredModel.cpp 第 105 行定义.

CStructuredLabels * get_labels ( )
inherited

get labels

返回
labels

在文件 StructuredModel.cpp 第 86 行定义.

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

在文件 SGObject.cpp 第 498 行定义.

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.cpp 第 522 行定义.

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.cpp 第 535 行定义.

virtual const char* get_name ( ) const
virtual

return the SGSerializable's name

返回
name Gaussian

重载 CStructuredModel .

在文件 HMSVMModel.h 第 173 行定义.

int32_t get_num_aux ( ) const
virtual

get the number of auxiliary variables to introduce in the optimization problem. The auxiliary variables are used to implement smoothness regularization between adjacent emission scores via constraints.

返回
the number of auxiliary variables

重载 CStructuredModel .

在文件 HMSVMModel.cpp 第 508 行定义.

int32_t get_num_aux_con ( ) const
virtual

get the number of auxiliary constraints to introduce in the optimization problem. These constraints are used to implement smoothness regularization between adjacent emission scores.

返回
the number of auxiliary constraints

重载 CStructuredModel .

在文件 HMSVMModel.cpp 第 513 行定义.

SGSparseVector< float64_t > get_sparse_joint_feature_vector ( int32_t  feat_idx,
int32_t  lab_idx 
)
inherited

gets joint feature vector

\[ \vec{\Psi}(\bf{x}_\text{feat\_idx}, \bf{y}_\text{lab\_idx}) \]

参数
feat_idxindex of the feature vector to use
lab_idxindex of the structured label to use
返回
the joint feature vector

在文件 StructuredModel.cpp 第 126 行定义.

SGSparseVector< float64_t > get_sparse_joint_feature_vector ( int32_t  feat_idx,
CStructuredData *  y 
)
virtualinherited

get joint feature vector

\[ \vec{\Psi}(\bf{x}_\text{feat\_idx}, \bf{y}) \]

参数
feat_idxindex of the feature vector to use
ystructured label to use
返回
the joint feature vector

被 CHashedMultilabelModel 重载.

在文件 StructuredModel.cpp 第 137 行定义.

CStateModel * get_state_model ( ) const

get state model

返回
model with the description of the states

在文件 HMSVMModel.cpp 第 609 行定义.

SGMatrix< float64_t > get_transmission_weights ( ) const

get transmission weights

返回
vector with the transmission weights

在文件 HMSVMModel.cpp 第 599 行定义.

void init_primal_opt ( float64_t  regularization,
SGMatrix< float64_t > &  A,
SGVector< float64_t >  a,
SGMatrix< float64_t >  B,
SGVector< float64_t > &  b,
SGVector< float64_t > &  lb,
SGVector< float64_t > &  ub,
SGMatrix< float64_t > &  C 
)
virtual

initialize the optimization problem

参数
regularizationregularization strength
Ais [-dPsi(y) | -I_N ] with M+N columns => max. M+1 nnz per row
a
B
brhs of the equality constraints
bupper bounds of the constraints, Ax <= b
lblower bound for the weight vector
ubupper bound for the weight vector
Cregularization matrix, w'Cw

重载 CStructuredModel .

在文件 HMSVMModel.cpp 第 357 行定义.

void init_training ( )
virtual

initializes the emission and transmission vectors of weights used in Viterbi decoding. In case PLiFs are used, it also initializes the matrix of PLiFs and automatically selects the supporting points based on the feature values

重载 CStructuredModel .

在文件 HMSVMModel.cpp 第 523 行定义.

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.cpp 第 296 行定义.

bool load_serializable ( CSerializableFile *  file,
const char *  prefix = "" 
)
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
返回
TRUE if done, otherwise FALSE

在文件 SGObject.cpp 第 369 行定义.

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 occurs.

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

在文件 SGObject.cpp 第 426 行定义.

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 occurs.

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

在文件 SGObject.cpp 第 421 行定义.

bool parameter_hash_changed ( )
virtualinherited
返回
whether parameter combination has changed since last update

在文件 SGObject.cpp 第 262 行定义.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

在文件 SGObject.cpp 第 474 行定义.

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

prints registered parameters out

参数
prefixprefix for members

在文件 SGObject.cpp 第 308 行定义.

bool save_serializable ( CSerializableFile *  file,
const char *  prefix = "" 
)
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
返回
TRUE if done, otherwise FALSE

在文件 SGObject.cpp 第 314 行定义.

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 occurs.

被 CKernel 重载.

在文件 SGObject.cpp 第 436 行定义.

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 occurs.

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

在文件 SGObject.cpp 第 431 行定义.

void set_features ( CFeatures *  feats)
inherited

set features

参数
featsfeatures

在文件 StructuredModel.cpp 第 92 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 41 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 46 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 51 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 56 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 61 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 66 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 71 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 76 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 81 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 86 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 91 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 96 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 101 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 106 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 111 行定义.

void set_generic ( )
inherited

set generic type to T

void set_global_io ( SGIO *  io)
inherited

set the io object

参数
ioio object to use

在文件 SGObject.cpp 第 228 行定义.

void set_global_parallel ( Parallel *  parallel)
inherited

set the parallel object

参数
parallelparallel object to use

在文件 SGObject.cpp 第 241 行定义.

void set_global_version ( Version *  version)
inherited

set the version object

参数
versionversion object to use

在文件 SGObject.cpp 第 283 行定义.

void set_labels ( CStructuredLabels *  labs)
inherited

set labels

参数
labslabels

在文件 StructuredModel.cpp 第 79 行定义.

void set_use_plifs ( bool  use_plifs)

setter for use_plifs

参数
use_plifswhether PLiFs shall be used

在文件 HMSVMModel.cpp 第 518 行定义.

CSGObject * shallow_copy ( ) const
virtualinherited

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

被 CGaussianKernel 重载.

在文件 SGObject.cpp 第 192 行定义.

CStructuredLabels * structured_labels_factory ( int32_t  num_labels = 0)
virtualinherited

create empty StructuredLabels object

被 CHierarchicalMultilabelModel, CHashedMultilabelModel, CMulticlassModel, CMultilabelCLRModel , 以及 CMultilabelModel 重载.

在文件 StructuredModel.cpp 第 34 行定义.

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

在文件 SGObject.cpp 第 303 行定义.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

在文件 SGObject.cpp 第 248 行定义.

类成员变量说明

SGIO* io
inherited

io

在文件 SGObject.h 第 369 行定义.

CFeatures* m_features
protectedinherited

feature vectors

在文件 StructuredModel.h 第 308 行定义.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

在文件 SGObject.h 第 384 行定义.

uint32_t m_hash
inherited

Hash of parameter values

在文件 SGObject.h 第 387 行定义.

CStructuredLabels* m_labels
protectedinherited

structured labels

在文件 StructuredModel.h 第 305 行定义.

Parameter* m_model_selection_parameters
inherited

model selection parameters

在文件 SGObject.h 第 381 行定义.

Parameter* m_parameters
inherited

parameters

在文件 SGObject.h 第 378 行定义.

Parallel* parallel
inherited

parallel

在文件 SGObject.h 第 372 行定义.

Version* version
inherited

version

在文件 SGObject.h 第 375 行定义.


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

SHOGUN 机器学习工具包 - 项目文档