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 101 of file StructuredModel.h.

Inheritance diagram for CStructuredModel:

[legend]

Public Member Functions
	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)

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)

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

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)

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 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 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
CStructuredLabels *	m_labels

CFeatures *	m_features

Constructor & Destructor Documentation

CStructuredModel ( )

default constructor

Definition at line 44 of file StructuredModel.cpp.

CStructuredModel	(	CFeatures *	features,
		CStructuredLabels *	labels
	)

constructor

Parameters

features	the feature vectors
labels	structured labels

Definition at line 49 of file StructuredModel.cpp.

~CStructuredModel ( )

virtual

destructor

Definition at line 60 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 CFactorGraphModel, CHashedMultilabelModel, CHierarchicalMultilabelModel, CHMSVMModel, CMulticlassModel, CMultilabelCLRModel, and CMultilabelModel.

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

dict	dictionary of parameters to be built.

Definition at line 597 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 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.

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 147 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 CFactorGraphModel, CHashedMultilabelModel, CHierarchicalMultilabelModel, CHMSVMModel, CMulticlassModel, CMultilabelCLRModel, and CMultilabelModel.

Definition at line 159 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

other	object to compare with
accuracy	accuracy to use for comparison (optional)
tolerant	allows 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.

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 CFactorGraphModel, CHierarchicalMultilabelModel, CHMSVMModel, CHashedMultilabelModel, CMulticlassModel, CMultilabelCLRModel, and CMultilabelModel.

CFeatures * get_features ( )

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.

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,
		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 105 of file StructuredModel.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 CFactorGraphModel, CHierarchicalMultilabelModel, CHMSVMModel, CHashedMultilabelModel, CMulticlassModel, CMultilabelCLRModel, and CMultilabelModel.

Definition at line 116 of file StructuredModel.cpp.

CStructuredLabels * get_labels ( )

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_name name 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_name name 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

Implements CSGObject.

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

Definition at line 260 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 189 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 194 of file StructuredModel.cpp.

SGSparseVector< float64_t > get_sparse_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 126 of file StructuredModel.cpp.

SGSparseVector< float64_t > get_sparse_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 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

regularization	regularization strength
A	is [-dPsi(y) \| -I_N ] with M+N columns => max. M+1 nnz per row
a
B
b	upper bounds of the constraints, Ax <= b
lb	lower bound for the weight vector
ub	upper bound for the weight vector
C	regularization matrix, w'Cw

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

Definition at line 66 of file StructuredModel.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 in CHMSVMModel, and CFactorGraphModel.

Definition at line 178 of file StructuredModel.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

generic set 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

file	where to load from
prefix	prefix 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

ShogunException will 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

ShogunException will 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

prefix prefix 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

file	where to save the object; will be closed during returning if PREFIX is an empty string.
prefix	prefix 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

ShogunException will 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

ShogunException will 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 )

set features

Parameters

feats features

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

io	io object to use

Definition at line 228 of file SGObject.cpp.

void set_global_parallel ( Parallel * parallel )

inherited

set the parallel object

Parameters

parallel parallel object to use

Definition at line 241 of file SGObject.cpp.

void set_global_version ( Version * version )

inherited

set the version object

Parameters

version version object to use

Definition at line 283 of file SGObject.cpp.

void set_labels ( CStructuredLabels * labs )

set labels

Parameters

labs labels

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 )

virtual

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.

Member Data Documentation

SGIO* io

inherited

io

Definition at line 369 of file SGObject.h.

CFeatures* m_features

protected

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.

CStructuredLabels* m_labels

protected

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.

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:

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation