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

详细描述

Class CStructuredModel that represents the application specific model and contains most of the application dependent logic to solve structured output (SO) problems. The idea of this class is to be instantiated giving pointers to the functions that are dependent on the application, i.e. the combined feature representation \(\Psi(\bold{x},\bold{y})\) and the argmax function \( {\arg\max} _{\bold{y} \neq \bold{y}_i} \left \langle { \bold{w}, \Psi(\bold{x}_i,\bold{y}) } \right \rangle \). See: MulticlassModel.h and .cpp for an example of these functions implemented.

在文件 StructuredModel.h85 行定义.

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

Public 成员函数

 CStructuredModel ()
 
 CStructuredModel (CFeatures *features, CStructuredLabels *labels)
 
virtual ~CStructuredModel ()
 
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 int32_t get_dim () const =0
 
void set_labels (CStructuredLabels *labs)
 
CStructuredLabelsget_labels ()
 
virtual CStructuredLabelsstructured_labels_factory (int32_t num_labels=0)
 
void set_features (CFeatures *feats)
 
CFeaturesget_features ()
 
SGVector< float64_tget_joint_feature_vector (int32_t feat_idx, int32_t lab_idx)
 
virtual SGVector< float64_tget_joint_feature_vector (int32_t feat_idx, CStructuredData *y)
 
virtual CResultSetargmax (SGVector< float64_t > w, int32_t feat_idx, bool const training=true)=0
 
float64_t delta_loss (int32_t ytrue_idx, CStructuredData *ypred)
 
virtual float64_t delta_loss (CStructuredData *y1, CStructuredData *y2)
 
virtual const char * get_name () const
 
virtual void init_training ()
 
virtual bool check_training_setup () const
 
virtual int32_t get_num_aux () const
 
virtual int32_t get_num_aux_con () 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 属性

SGIOio
 
Parallelparallel
 
Versionversion
 
Parameterm_parameters
 
Parameterm_model_selection_parameters
 
Parameterm_gradient_parameters
 
ParameterMapm_parameter_map
 
uint32_t m_hash
 

Protected 成员函数

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

CStructuredLabelsm_labels
 
CFeaturesm_features
 

构造及析构函数说明

default constructor

在文件 StructuredModel.cpp35 行定义.

CStructuredModel ( CFeatures features,
CStructuredLabels labels 
)

constructor

参数
featuresthe feature vectors
labelsstructured labels

在文件 StructuredModel.cpp40 行定义.

~CStructuredModel ( )
virtual

destructor

在文件 StructuredModel.cpp51 行定义.

成员函数说明

virtual CResultSet* argmax ( SGVector< float64_t w,
int32_t  feat_idx,
bool const  training = true 
)
pure 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

CFactorGraphModel, CHMSVMModel , 以及 CMulticlassModel 内被实现.

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

bool check_training_setup ( ) const
virtual

method to be called from a SO machine before training to ensure that the training data is valid (e.g. check that there is at least one example for every class). In this class the method is empty and it can be re-implemented for any application (e.g. HM-SVM).

CHMSVMModel 重载.

在文件 StructuredModel.cpp153 行定义.

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

virtual CSGObject* deep_copy ( ) const
virtualinherited

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

在文件 SGObject.h126 行定义.

float64_t delta_loss ( int32_t  ytrue_idx,
CStructuredData ypred 
)

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

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

在文件 StructuredModel.cpp117 行定义.

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

CFactorGraphModel, CHMSVMModel , 以及 CMulticlassModel 重载.

在文件 StructuredModel.cpp129 行定义.

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

virtual int32_t get_dim ( ) const
pure virtual

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

CFactorGraphModel, CHMSVMModel , 以及 CMulticlassModel 内被实现.

CFeatures * get_features ( )

get features

返回
features

在文件 StructuredModel.cpp90 行定义.

SGIO * get_global_io ( )
inherited

get the io object

返回
io object

在文件 SGObject.cpp174 行定义.

Parallel * get_global_parallel ( )
inherited

get the parallel object

返回
parallel object

在文件 SGObject.cpp209 行定义.

Version * get_global_version ( )
inherited

get the version object

返回
version object

在文件 SGObject.cpp222 行定义.

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

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.cpp96 行定义.

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

CFactorGraphModel, CHMSVMModel , 以及 CMulticlassModel 重载.

在文件 StructuredModel.cpp107 行定义.

CStructuredLabels * get_labels ( )

get labels

返回
labels

在文件 StructuredModel.cpp77 行定义.

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

在文件 SGObject.cpp1060 行定义.

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

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

virtual const char* get_name ( ) const
virtual
返回
name of SGSerializable

实现了 CSGObject.

CHMSVMModel, CMulticlassModel , 以及 CFactorGraphModel 重载.

在文件 StructuredModel.h214 行定义.

int32_t get_num_aux ( ) const
virtual

get the number of auxiliary variables to introduce in the optimization problem. By default, this class do not impose the use of auxiliary variables and it will return zero. Re-implement this method subclasses to use auxiliary variables.

return the number of auxiliary variables

CHMSVMModel 重载.

在文件 StructuredModel.cpp159 行定义.

int32_t get_num_aux_con ( ) const
virtual

get the number of auxiliary constraints to introduce in the optimization problem. By default, this class do not impose the use of any auxiliary constraints and it will return zero. Re-implement this method in subclasses to use auxiliary constraints.

return the number of auxiliary constraints

CHMSVMModel 重载.

在文件 StructuredModel.cpp164 行定义.

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 for primal solver

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

CFactorGraphModel, CHMSVMModel , 以及 CMulticlassModel 重载.

在文件 StructuredModel.cpp57 行定义.

void init_training ( )
virtual

initializes the part of the model that needs to be used during training. In this class this method is empty and it can be re-implemented for any particular StructuredModel

CHMSVMModel , 以及 CFactorGraphModel 重载.

在文件 StructuredModel.cpp148 行定义.

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

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

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

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

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

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

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

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

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

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

在文件 SGObject.cpp1036 行定义.

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

prints registered parameters out

参数
prefixprefix for members

在文件 SGObject.cpp240 行定义.

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

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

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

void set_features ( CFeatures feats)

set features

参数
featsfeatures

在文件 StructuredModel.cpp83 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp41 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp46 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp51 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp56 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp61 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp66 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp71 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp76 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp81 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp86 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp91 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp96 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp101 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp106 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp111 行定义.

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.cpp167 行定义.

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

参数
parallelparallel object to use

在文件 SGObject.cpp180 行定义.

void set_global_version ( Version version)
inherited

set the version object

参数
versionversion object to use

在文件 SGObject.cpp215 行定义.

void set_labels ( CStructuredLabels labs)

set labels

参数
labslabels

在文件 StructuredModel.cpp70 行定义.

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

CStructuredLabels * structured_labels_factory ( int32_t  num_labels = 0)
virtual

create empty StructuredLabels object

CMulticlassModel 重载.

在文件 StructuredModel.cpp25 行定义.

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

在文件 SGObject.cpp235 行定义.

bool update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination.

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

在文件 SGObject.cpp187 行定义.

类成员变量说明

SGIO* io
inherited

io

在文件 SGObject.h473 行定义.

CFeatures* m_features
protected

feature vectors

在文件 StructuredModel.h262 行定义.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

在文件 SGObject.h488 行定义.

uint32_t m_hash
inherited

Hash of parameter values

在文件 SGObject.h494 行定义.

CStructuredLabels* m_labels
protected

structured labels

在文件 StructuredModel.h259 行定义.

Parameter* m_model_selection_parameters
inherited

model selection parameters

在文件 SGObject.h485 行定义.

ParameterMap* m_parameter_map
inherited

map for different parameter versions

在文件 SGObject.h491 行定义.

Parameter* m_parameters
inherited

parameters

在文件 SGObject.h482 行定义.

Parallel* parallel
inherited

parallel

在文件 SGObject.h476 行定义.

Version* version
inherited

version

在文件 SGObject.h479 行定义.


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

SHOGUN Machine Learning Toolbox - Documentation