SHOGUN  4.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
List of all members | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
CFactorGraphModel Class Reference

Detailed Description

CFactorGraphModel defines a model in terms of CFactorGraph and CMAPInference, where parameters are associated with factor types, in the model. There is a mapping vector records the locations of local factor parameters in the global parameter vector.

TODO: implement functions for SGD

Definition at line 32 of file FactorGraphModel.h.

Inheritance diagram for CFactorGraphModel:
Inheritance graph
[legend]

Public Member Functions

 CFactorGraphModel ()
 
 CFactorGraphModel (CFeatures *features, CStructuredLabels *labels, EMAPInferType inf_type=TREE_MAX_PROD, bool verbose=false)
 
 ~CFactorGraphModel ()
 
virtual const char * get_name () const
 
void add_factor_type (CFactorType *ftype)
 
void del_factor_type (const int32_t ftype_id)
 
CDynamicObjectArray * get_factor_types () const
 
CFactorType * get_factor_type (const int32_t ftype_id) const
 
SGVector< int32_t > get_global_params_mapping () const
 
SGVector< int32_t > get_params_mapping (const int32_t ftype_id)
 
SGVector< float64_t > fparams_to_w ()
 
void w_to_fparams (SGVector< float64_t > w)
 
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_training ()
 
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
 
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 bool check_training_setup () const
 
virtual int32_t get_num_aux () const
 
virtual int32_t get_num_aux_con () const
 
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 Attributes

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

Protected Member Functions

virtual void load_serializable_pre () throw (ShogunException)
 
virtual void load_serializable_post () throw (ShogunException)
 
virtual void save_serializable_pre () throw (ShogunException)
 
virtual void save_serializable_post () throw (ShogunException)
 

Protected Attributes

CDynamicObjectArray * m_factor_types
 
SGVector< int32_t > m_w_map
 
SGVector< float64_t > m_w_cache
 
EMAPInferType m_inf_type
 
bool m_verbose
 
CStructuredLabels * m_labels
 
CFeatures * m_features
 

Constructor & Destructor Documentation

CFactorGraphModel ( )

constructor

Definition at line 26 of file FactorGraphModel.cpp.

CFactorGraphModel ( CFeatures *  features,
CStructuredLabels *  labels,
EMAPInferType  inf_type = TREE_MAX_PROD,
bool  verbose = false 
)

constructor

Parameters
featurespointer to structured inputs
labelspointer to structured outputs
inf_typeMAP inference type, default is tree max-product inference
verbosewhether output verbose information, such as energy table, slack variables etc. NOTE: do NOT set this up when training with large data, massive printing will crash the program

Definition at line 32 of file FactorGraphModel.cpp.

~CFactorGraphModel ( )

destructor

Definition at line 40 of file FactorGraphModel.cpp.

Member Function Documentation

void add_factor_type ( CFactorType *  ftype)

add a new factor type, NOTE: a factor type is not allowed to change once it has been added to the FactorGraphModel. Secondly, the model itself should not be modified during training, i.e. no add/delete operations.

Parameters
ftypepointer to new factor type

Definition at line 58 of file FactorGraphModel.cpp.

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

Parameters
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.
Returns
structure with the predicted output

Implements CStructuredModel.

Definition at line 288 of file FactorGraphModel.cpp.

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.

Parameters
dictdictionary of parameters to be built.

Definition at line 597 of file SGObject.cpp.

bool check_training_setup ( ) const
virtualinherited

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 183 of file StructuredModel.cpp.

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.

Returns
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

Definition at line 714 of file SGObject.cpp.

CSGObject * deep_copy ( ) const
virtualinherited

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

Definition at line 198 of file SGObject.cpp.

void del_factor_type ( const int32_t  ftype_id)

delete a factor type

Parameters
ftype_idfactor type id

Definition at line 105 of file FactorGraphModel.cpp.

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

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

Parameters
y1an instance of structured data
y2another instance of structured data
Returns
loss value

Reimplemented from CStructuredModel.

Definition at line 383 of file FactorGraphModel.cpp.

float64_t delta_loss ( int32_t  ytrue_idx,
CStructuredData *  ypred 
)
inherited

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

Parameters
ytrue_idxindex of the true label in labels
ypredthe predicted label
Returns
loss value

Definition at line 147 of file StructuredModel.cpp.

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.

Parameters
otherobject to compare with
accuracyaccuracy to use for comparison (optional)
tolerantallows linient check on float equality (within accuracy)
Returns
true if all parameters were equal, false if not

Definition at line 618 of file SGObject.cpp.

SGVector< float64_t > fparams_to_w ( )
Returns
concatenated parameter vector from local parameters

Definition at line 175 of file FactorGraphModel.cpp.

int32_t get_dim ( ) const
virtual

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

Implements CStructuredModel.

Definition at line 170 of file FactorGraphModel.cpp.

CFactorType * get_factor_type ( const int32_t  ftype_id) const

get a factor type specified by its id

Parameters
ftype_idfactor type id

Definition at line 146 of file FactorGraphModel.cpp.

CDynamicObjectArray * get_factor_types ( ) const
Returns
pointer to the array of factor types

Definition at line 140 of file FactorGraphModel.cpp.

CFeatures * get_features ( )
inherited

get features

Returns
features

Definition at line 99 of file StructuredModel.cpp.

SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 235 of file SGObject.cpp.

Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 277 of file SGObject.cpp.

SGVector< int32_t > get_global_params_mapping ( ) const
Returns
parameter mapping for all factor types

Definition at line 160 of file FactorGraphModel.cpp.

Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 290 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_idxindex of the feature vector to use
ystructured label to use
Returns
the joint feature vector

Reimplemented from CStructuredModel.

Definition at line 235 of file FactorGraphModel.cpp.

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

Parameters
feat_idxindex of the feature vector to use
lab_idxindex of the structured label to use
Returns
the joint feature vector

Definition at line 105 of file StructuredModel.cpp.

CStructuredLabels * get_labels ( )
inherited

get labels

Returns
labels

Definition at line 86 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 498 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_namename of the parameter
Returns
description of the parameter

Definition at line 522 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_namename of model selection parameter
Returns
index of model selection parameter with provided name, -1 if there is no such

Definition at line 535 of file SGObject.cpp.

virtual const char* get_name ( ) const
virtual
Returns
name of SGSerializable

Reimplemented from CStructuredModel.

Definition at line 53 of file FactorGraphModel.h.

int32_t get_num_aux ( ) const
virtualinherited

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 189 of file StructuredModel.cpp.

int32_t get_num_aux_con ( ) const
virtualinherited

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 194 of file StructuredModel.cpp.

SGVector< int32_t > get_params_mapping ( const int32_t  ftype_id)

get parameter mapping for a factor type

Parameters
ftype_idfactor type id

Definition at line 165 of file FactorGraphModel.cpp.

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

Parameters
feat_idxindex of the feature vector to use
lab_idxindex of the structured label to use
Returns
the joint feature vector

Definition at line 126 of file StructuredModel.cpp.

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

Parameters
feat_idxindex of the feature vector to use
ystructured label to use
Returns
the joint feature vector

Reimplemented in CHashedMultilabelModel.

Definition at line 137 of file StructuredModel.cpp.

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

Parameters
regularizationinput for C
Ais [-dPsi(y) | -I_N ] with M+N columns => max. M+1 nnz per row
aunused input
Bunused input
bupper bounds of the constraints, Ax <= b
lblower bounds for w
ubupper bounds for w
Cregularization matrix, w'Cw

Reimplemented from CStructuredModel.

Definition at line 406 of file FactorGraphModel.cpp.

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

Reimplemented from CStructuredModel.

Definition at line 402 of file FactorGraphModel.cpp.

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.

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

Definition at line 296 of file SGObject.cpp.

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!

Parameters
filewhere to load from
prefixprefix for members
Returns
TRUE if done, otherwise FALSE

Definition at line 369 of file SGObject.cpp.

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.

Exceptions
ShogunExceptionwill be thrown if an error occurs.

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

Definition at line 426 of file SGObject.cpp.

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.

Exceptions
ShogunExceptionwill be thrown if an error occurs.

Reimplemented in CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.

Definition at line 421 of file SGObject.cpp.

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

Definition at line 262 of file SGObject.cpp.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 474 of file SGObject.cpp.

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

prints registered parameters out

Parameters
prefixprefix for members

Definition at line 308 of file SGObject.cpp.

bool save_serializable ( CSerializableFile *  file,
const char *  prefix = "" 
)
virtualinherited

Save this object to file.

Parameters
filewhere to save the object; will be closed during returning if PREFIX is an empty string.
prefixprefix for members
Returns
TRUE if done, otherwise FALSE

Definition at line 314 of file SGObject.cpp.

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.

Exceptions
ShogunExceptionwill be thrown if an error occurs.

Reimplemented in CKernel.

Definition at line 436 of file SGObject.cpp.

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.

Exceptions
ShogunExceptionwill be thrown if an error occurs.

Reimplemented in CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.

Definition at line 431 of file SGObject.cpp.

void set_features ( CFeatures *  feats)
inherited

set features

Parameters
featsfeatures

Definition at line 92 of file StructuredModel.cpp.

void set_generic ( )
inherited

Definition at line 41 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 46 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 51 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 56 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 61 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 66 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 71 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 76 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 81 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 86 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 91 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 96 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 101 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 106 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 111 of file SGObject.cpp.

void set_generic ( )
inherited

set generic type to T

void set_global_io ( SGIO *  io)
inherited

set the io object

Parameters
ioio object to use

Definition at line 228 of file SGObject.cpp.

void set_global_parallel ( Parallel *  parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 241 of file SGObject.cpp.

void set_global_version ( Version *  version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 283 of file SGObject.cpp.

void set_labels ( CStructuredLabels *  labs)
inherited

set labels

Parameters
labslabels

Definition at line 79 of file StructuredModel.cpp.

CSGObject * shallow_copy ( ) const
virtualinherited

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

Reimplemented in CGaussianKernel.

Definition at line 192 of file SGObject.cpp.

CStructuredLabels * structured_labels_factory ( int32_t  num_labels = 0)
virtualinherited

create empty StructuredLabels object

Reimplemented in CHierarchicalMultilabelModel, CHashedMultilabelModel, CMulticlassModel, CMultilabelCLRModel, and CMultilabelModel.

Definition at line 34 of file StructuredModel.cpp.

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

Definition at line 303 of file SGObject.cpp.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 248 of file SGObject.cpp.

void w_to_fparams ( SGVector< float64_t >  w)

update local parameters

Parameters
wnew global parameter vector

Definition at line 204 of file FactorGraphModel.cpp.

Member Data Documentation

SGIO* io
inherited

io

Definition at line 369 of file SGObject.h.

CDynamicObjectArray* m_factor_types
protected

array of factor types

Definition at line 170 of file FactorGraphModel.h.

CFeatures* m_features
protectedinherited

feature vectors

Definition at line 308 of file StructuredModel.h.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

Definition at line 384 of file SGObject.h.

uint32_t m_hash
inherited

Hash of parameter values

Definition at line 387 of file SGObject.h.

EMAPInferType m_inf_type
protected

MAP inference type

Definition at line 179 of file FactorGraphModel.h.

CStructuredLabels* m_labels
protectedinherited

structured labels

Definition at line 305 of file StructuredModel.h.

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 381 of file SGObject.h.

Parameter* m_parameters
inherited

parameters

Definition at line 378 of file SGObject.h.

bool m_verbose
protected

whether print verbose information

Definition at line 182 of file FactorGraphModel.h.

SGVector<float64_t> m_w_cache
protected

cache of global parameters

Definition at line 176 of file FactorGraphModel.h.

SGVector<int32_t> m_w_map
protected

index of factor type

Definition at line 173 of file FactorGraphModel.h.

Parallel* parallel
inherited

parallel

Definition at line 372 of file SGObject.h.

Version* version
inherited

version

Definition at line 375 of file SGObject.h.

The documentation for this class was generated from the following files:
SHOGUN Machine Learning Toolbox - Documentation