SHOGUN  4.2.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
CLatentModel Class Referenceabstract

Detailed Description

Abstract class CLatentModel It represents the application specific model and contains most of the application dependent logic to solve latent variable based problems.

The idea is that the user have to define and implement her own model, which is derived from CLatentModel and implement all the pure virtual functions which depends on the given problem she wants to solve, like the combined feature representation: \(\Psi(\bold{x_i},\bold{h_i})\) and the inference of the latent variable \(argmax_{h} \langle \bold{w},\Psi(\bold{x},\bold{h}) \rangle\)

Definition at line 33 of file LatentModel.h.

Inheritance diagram for CLatentModel:
[legend]

Public Member Functions

 CLatentModel ()
 
 CLatentModel (CLatentFeatures *feats, CLatentLabels *labels, bool do_caching=true)
 
virtual ~CLatentModel ()
 
virtual int32_t get_num_vectors () const
 
virtual int32_t get_dim () const =0
 
void set_labels (CLatentLabels *labs)
 
CLatentLabelsget_labels () const
 
void set_features (CLatentFeatures *feats)
 
CLatentFeaturesget_features () const
 
virtual CDotFeaturesget_psi_feature_vectors ()=0
 
virtual CDatainfer_latent_variable (const SGVector< float64_t > &w, index_t idx)=0
 
virtual void argmax_h (const SGVector< float64_t > &w)
 
void cache_psi_features ()
 
CDotFeaturesget_cached_psi_features () const
 
bool get_caching () const
 
void set_caching (bool caching)
 
virtual const char * get_name () 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="")
 
virtual bool load_serializable (CSerializableFile *file, const char *prefix="")
 
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 void update_parameter_hash ()
 
virtual bool parameter_hash_changed ()
 
virtual bool equals (CSGObject *other, float64_t accuracy=0.0, bool tolerant=false)
 
virtual CSGObjectclone ()
 

Public Attributes

SGIOio
 
Parallelparallel
 
Versionversion
 
Parameterm_parameters
 
Parameterm_model_selection_parameters
 
Parameterm_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

CLatentFeaturesm_features
 
CLatentLabelsm_labels
 
bool m_do_caching
 
CDotFeaturesm_cached_psi
 

Constructor & Destructor Documentation

default ctor

Definition at line 16 of file LatentModel.cpp.

CLatentModel ( CLatentFeatures feats,
CLatentLabels labels,
bool  do_caching = true 
)

constructor

Parameters
featsLatent features
labelsLatent labels
do_cachingwhether caching of PSI vectors is enabled or not. Enabled by default.

Definition at line 25 of file LatentModel.cpp.

~CLatentModel ( )
virtual

destructor

Definition at line 36 of file LatentModel.cpp.

Member Function Documentation

void argmax_h ( const SGVector< float64_t > &  w)
virtual

Calculates \(argmax_{h} \langle \bold{w},\Psi(\bold{x},\bold{h}) \rangle\) The default implementaiton calculates the argmax_h only on the positive examples.

Parameters
wweight vector (cutting plane) supplied by the underlying optimizer.

Definition at line 68 of file LatentModel.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.

void cache_psi_features ( )

cache the PSI vectors

Definition at line 102 of file LatentModel.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.

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.

CDotFeatures * get_cached_psi_features ( ) const

get the cached PSI vectors

Returns
the cached PSI vectors

Definition at line 113 of file LatentModel.cpp.

bool get_caching ( ) const

get caching

Returns
true if caching of PSI vectors is enabled; false otherwise

Definition at line 124 of file LatentModel.h.

virtual int32_t get_dim ( ) const
pure virtual

get the dimension of the combined features, i.e \(\Psi(\ldots)\)

Returns
dimension of features, i.e. psi vector
CLatentFeatures * get_features ( ) const

get latent features

Returns
latent features

Definition at line 96 of file LatentModel.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.

CLatentLabels * get_labels ( ) const

get latent labels

Returns
latent labels

Definition at line 55 of file LatentModel.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 the name of the SGSerializable instance.

Returns
name of the SGSerializable

Implements CSGObject.

Definition at line 142 of file LatentModel.h.

int32_t get_num_vectors ( ) const
virtual

get the number of examples

Returns
number of examples/vectors in latent features

Definition at line 43 of file LatentModel.cpp.

virtual CDotFeatures* get_psi_feature_vectors ( )
pure virtual

Calculate the PSI vectors for all features

Returns
PSI vectors
virtual CData* infer_latent_variable ( const SGVector< float64_t > &  w,
index_t  idx 
)
pure virtual

User defined \(h^{*} = argmax_{h} \langle \bold{w},\Psi(\bold{x},\bold{h}) \rangle\) This function has to be defined the user as it is applications specific, since it depends on the user defined latent feature and latent label.

Parameters
wweight vector
idxindex of the example
Returns
returns \(h^{*}\) for the given example
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_caching ( bool  caching)

set caching of PSI features

Parameters
cachingtrue if one wants to cache PSI vectors; false otherwise

Definition at line 133 of file LatentModel.h.

void set_features ( CLatentFeatures feats)

set latent features

Parameters
featsthe latent features of the problem

Definition at line 61 of file LatentModel.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 ( CLatentLabels labs)

set latent labels

Parameters
labslatent labels

Definition at line 48 of file LatentModel.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.

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.

CDotFeatures* m_cached_psi
protected

cached PSI feature vectors after argmax_h

Definition at line 152 of file LatentModel.h.

bool m_do_caching
protected

boolean that indicates whether caching of PSI vectors is enabled or not

Definition at line 150 of file LatentModel.h.

CLatentFeatures* m_features
protected

latent features for training

Definition at line 146 of file LatentModel.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.

CLatentLabels* m_labels
protected

corresponding labels for the train set

Definition at line 148 of file LatentModel.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:

SHOGUN Machine Learning Toolbox - Documentation