Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes

CStructuredModel Class Reference

Detailed Description

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.

Definition at line 77 of file StructuredModel.h.

Inheritance diagram for CStructuredModel:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CStructuredModel ()
 CStructuredModel (CFeatures *features, CStructuredLabels *labels)
virtual ~CStructuredModel ()
virtual void init_opt (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)
CStructuredLabels * get_labels ()
void set_features (CFeatures *feats)
CFeatures * get_features ()
SGVector< float64_t > get_joint_feature_vector (int32_t feat_idx, int32_t lab_idx)
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)=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 bool check_training_setup () const
virtual int32_t get_num_aux () const
virtual int32_t get_num_aux_con () const
virtual float64_t risk (float64_t *subgrad, float64_t *W, TMultipleCPinfo *info=0)
virtual CSGObject * shallow_copy () const
virtual CSGObject * deep_copy () const
virtual bool is_generic (EPrimitiveType *generic) const
template<class T >
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_PARAMETER)
virtual bool load_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=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)
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_parameter_dictionary (CMap< TParameter *, CSGObject * > &dict)

Public Attributes

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

Protected Member Functions

virtual TParameter * migrate (DynArray< TParameter * > *param_base, const SGParamInfo *target)
virtual void one_to_one_migration_prepare (DynArray< TParameter * > *param_base, const SGParamInfo *target, TParameter *&replacement, TParameter *&to_migrate, char *old_name=NULL)
virtual void load_serializable_pre () throw (ShogunException)
virtual void load_serializable_post () throw (ShogunException)
virtual void save_serializable_pre () throw (ShogunException)
virtual void save_serializable_post () throw (ShogunException)
virtual bool update_parameter_hash ()

Protected Attributes

CStructuredLabels * m_labels
CFeatures * m_features

Constructor & Destructor Documentation

CStructuredModel (  ) 

default constructor

Definition at line 15 of file StructuredModel.cpp.

CStructuredModel ( CFeatures *  features,
CStructuredLabels *  labels 
)

constructor

Parameters:
features the feature vectors
labels structured labels

Definition at line 20 of file StructuredModel.cpp.

~CStructuredModel (  )  [virtual]

destructor

Definition at line 34 of file StructuredModel.cpp.

Member Function Documentation

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 $

Parameters:
w weight vector
feat_idx index of the feature to compute the argmax
training true 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.
Returns:
structure with the predicted output

Implemented in CHMSVMModel, and CMulticlassModel.

void build_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.

Parameters:
dict dictionary of parameters to be built.

Definition at line 1201 of file SGObject.cpp.

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

Reimplemented in CHMSVMModel.

Definition at line 130 of file StructuredModel.cpp.

virtual CSGObject* deep_copy (  )  const [virtual, inherited]

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

Definition at line 131 of file SGObject.h.

float64_t delta_loss ( int32_t  ytrue_idx,
CStructuredData *  ypred 
)

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

Parameters:
ytrue_idx index of the true label in labels
ypred the predicted label
Returns:
loss value

Definition at line 99 of file StructuredModel.cpp.

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

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

Parameters:
y1 an instance of structured data
y2 another instance of structured data
Returns:
loss value

Reimplemented in CHMSVMModel, and CMulticlassModel.

Definition at line 111 of file StructuredModel.cpp.

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$

Implemented in CHMSVMModel, and CMulticlassModel.

CFeatures * get_features (  ) 

get features

Returns:
features

Definition at line 72 of file StructuredModel.cpp.

SGIO * get_global_io (  )  [inherited]

get the io object

Returns:
io object

Definition at line 224 of file SGObject.cpp.

Parallel * get_global_parallel (  )  [inherited]

get the parallel object

Returns:
parallel object

Definition at line 259 of file SGObject.cpp.

Version * get_global_version (  )  [inherited]

get the version object

Returns:
version object

Definition at line 272 of file SGObject.cpp.

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}) \]

Parameters:
feat_idx index of the feature vector to use
y structured label to use
Returns:
the joint feature vector

Reimplemented in CHMSVMModel, and CMulticlassModel.

Definition at line 89 of file StructuredModel.cpp.

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}) \]

Parameters:
feat_idx index of the feature vector to use
lab_idx index of the structured label to use
Returns:
the joint feature vector

Definition at line 78 of file StructuredModel.cpp.

CStructuredLabels * get_labels (  ) 

get labels

Returns:
labels

Definition at line 59 of file StructuredModel.cpp.

SGStringList< char > get_modelsel_names (  )  [inherited]
Returns:
vector of names of all parameters which are registered for model selection

Definition at line 1108 of file SGObject.cpp.

char * get_modsel_param_descr ( const char *  param_name  )  [inherited]

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

Parameters:
param_name name of the parameter
Returns:
description of the parameter

Definition at line 1132 of file SGObject.cpp.

index_t get_modsel_param_index ( const char *  param_name  )  [inherited]

Returns index of model selection parameter with provided index

Parameters:
param_name name of model selection parameter
Returns:
index of model selection parameter with provided name, -1 if there is no such

Definition at line 1145 of file SGObject.cpp.

virtual const char* get_name (  )  const [virtual]
Returns:
name of SGSerializable

Implements CSGObject.

Reimplemented in CMulticlassModel.

Definition at line 201 of file StructuredModel.h.

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

Reimplemented in CHMSVMModel.

Definition at line 136 of file StructuredModel.cpp.

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

Reimplemented in CHMSVMModel.

Definition at line 141 of file StructuredModel.cpp.

void init_opt ( 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

Parameters:
A 
a 
B 
b 
lb 
ub 
C 

Reimplemented in CHMSVMModel, and CMulticlassModel.

Definition at line 40 of file StructuredModel.cpp.

bool is_generic ( EPrimitiveType *  generic  )  const [virtual, inherited]

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

Parameters:
generic set to the type of the generic if returning TRUE
Returns:
TRUE if a class template.

Definition at line 278 of file SGObject.cpp.

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)

Parameters:
file_version parameter version of the file
current_version version from which mapping begins (you want to use VERSION_PARAMETER for this in most cases)
file file to load from
prefix prefix for members
Returns:
(sorted) array of created TParameter instances with file data

Definition at line 679 of file SGObject.cpp.

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

Parameters:
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
Returns:
new array with TParameter instances with the attached data

Definition at line 523 of file SGObject.cpp.

bool load_serializable ( CSerializableFile *  file,
const char *  prefix = "",
int32_t  param_version = VERSION_PARAMETER 
) [virtual, inherited]

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

Parameters:
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)
Returns:
TRUE if done, otherwise FALSE

Reimplemented in CModelSelectionParameters.

Definition at line 354 of file SGObject.cpp.

void load_serializable_post (  )  throw (ShogunException) [protected, virtual, inherited]

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.

Exceptions:
ShogunException Will be thrown if an error occurres.

Reimplemented in CLinearHMM, CAlphabet, CANOVAKernel, CCircularKernel, CExponentialKernel, CGaussianKernel, CInverseMultiQuadricKernel, CKernel, CWeightedDegreePositionStringKernel, and CList.

Definition at line 1033 of file SGObject.cpp.

void load_serializable_pre (  )  throw (ShogunException) [protected, virtual, inherited]

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.

Exceptions:
ShogunException Will be thrown if an error occurres.

Definition at line 1028 of file SGObject.cpp.

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

Parameters:
param_base set of TParameter instances that are mapped to the provided target parameter infos
base_version version of the parameter base
target_param_infos set of SGParamInfo instances that specify the target parameter base

Definition at line 717 of file SGObject.cpp.

TParameter * migrate ( DynArray< TParameter * > *  param_base,
const SGParamInfo *  target 
) [protected, virtual, inherited]

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

Parameters:
param_base set of TParameter instances to use for migration
target parameter info for the resulting TParameter
Returns:
a new TParameter instance with migrated data from the base of the type which is specified by the target parameter

Definition at line 923 of file SGObject.cpp.

void one_to_one_migration_prepare ( DynArray< TParameter * > *  param_base,
const SGParamInfo *  target,
TParameter *&  replacement,
TParameter *&  to_migrate,
char *  old_name = NULL 
) [protected, virtual, inherited]

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)

Parameters:
param_base set of TParameter instances to use for migration
target parameter info for the resulting TParameter
replacement (used as output) here the TParameter instance which is returned by migration is created into
to_migrate the only source that is used for migration
old_name with this parameter, a name change may be specified

Definition at line 864 of file SGObject.cpp.

void print_modsel_params (  )  [inherited]

prints all parameter registered for model selection and their type

Definition at line 1084 of file SGObject.cpp.

void print_serializable ( const char *  prefix = ""  )  [virtual, inherited]

prints registered parameters out

Parameters:
prefix prefix for members

Definition at line 290 of file SGObject.cpp.

float64_t risk ( float64_t *  subgrad,
float64_t *  W,
TMultipleCPinfo *  info = 0 
) [virtual]

computes the value of the risk function and sub-gradient at given point

Parameters:
subgrad Subgradient computed at given point W
W Given weight vector
info Helper info for multiple cutting plane models algorithm
Returns:
Value of the computed risk at given point W

Reimplemented in CMulticlassModel.

Definition at line 146 of file StructuredModel.cpp.

bool save_serializable ( CSerializableFile *  file,
const char *  prefix = "",
int32_t  param_version = VERSION_PARAMETER 
) [virtual, inherited]

Save this object to file.

Parameters:
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)
Returns:
TRUE if done, otherwise FALSE

Reimplemented in CModelSelectionParameters.

Definition at line 296 of file SGObject.cpp.

void save_serializable_post (  )  throw (ShogunException) [protected, virtual, inherited]

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.

Exceptions:
ShogunException Will be thrown if an error occurres.

Reimplemented in CKernel.

Definition at line 1043 of file SGObject.cpp.

void save_serializable_pre (  )  throw (ShogunException) [protected, virtual, inherited]

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.

Exceptions:
ShogunException Will be thrown if an error occurres.

Reimplemented in CKernel.

Definition at line 1038 of file SGObject.cpp.

void set_features ( CFeatures *  feats  ) 

set features

Parameters:
feats features

Definition at line 65 of file StructuredModel.cpp.

void set_generic< floatmax_t > (  )  [inherited]

set generic type to T

void set_global_io ( SGIO *  io  )  [inherited]

set the io object

Parameters:
io io object to use

Definition at line 217 of file SGObject.cpp.

void set_global_parallel ( Parallel *  parallel  )  [inherited]

set the parallel object

Parameters:
parallel parallel object to use

Definition at line 230 of file SGObject.cpp.

void set_global_version ( Version *  version  )  [inherited]

set the version object

Parameters:
version version object to use

Definition at line 265 of file SGObject.cpp.

void set_labels ( CStructuredLabels *  labs  ) 

set labels

Parameters:
labs labels

Definition at line 52 of file StructuredModel.cpp.

virtual CSGObject* shallow_copy (  )  const [virtual, inherited]

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

Reimplemented in CGaussianKernel.

Definition at line 122 of file SGObject.h.

void unset_generic (  )  [inherited]

unset generic type

this has to be called in classes specializing a template class

Definition at line 285 of file SGObject.cpp.

bool update_parameter_hash (  )  [protected, virtual, inherited]

Updates the hash of current parameter combination.

Returns:
bool if parameter combination has changed since last update.

Definition at line 237 of file SGObject.cpp.

Member Data Documentation

SGIO* io [inherited]

io

Definition at line 462 of file SGObject.h.

CFeatures* m_features [protected]

feature vectors

Definition at line 252 of file StructuredModel.h.

uint32_t m_hash [inherited]

Hash of parameter values

Definition at line 480 of file SGObject.h.

CStructuredLabels* m_labels [protected]

structured labels

Definition at line 249 of file StructuredModel.h.

Parameter* m_model_selection_parameters [inherited]

model selection parameters

Definition at line 474 of file SGObject.h.

ParameterMap* m_parameter_map [inherited]

map for different parameter versions

Definition at line 477 of file SGObject.h.

Parameter* m_parameters [inherited]

parameters

Definition at line 471 of file SGObject.h.

Parallel* parallel [inherited]

parallel

Definition at line 465 of file SGObject.h.

Version* version [inherited]

version

Definition at line 468 of file SGObject.h.

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
SHOGUN Machine Learning Toolbox - Documentation