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

Detailed Description

Class CHierarchicalMultilabelModel represents application specific model and contains application dependent logic for solving hierarchical multilabel classification[1] within a generic SO framework.

[1] Lijuan Cai. Multilabel Classification over Category Taxonomies http://cs.brown.edu/research/pubs/theses/phd/2008/cai.pdf

[2] Wei Bi, et.al. Mandatory Leaf Node Prediction in Hierarchical Multilabel Classification http://papers.nips.cc/paper/4520-mandatory-leaf-node-prediction-in-hierarchical-multilabel-classification.pdf

Definition at line 29 of file HierarchicalMultilabelModel.h.

Inheritance diagram for CHierarchicalMultilabelModel:
[legend]

Public Member Functions

 CHierarchicalMultilabelModel ()
 
 CHierarchicalMultilabelModel (CFeatures *features, CStructuredLabels *labels, SGVector< int32_t > taxonomy, bool leaf_nodes_mandatory=false)
 
virtual ~CHierarchicalMultilabelModel ()
 
virtual CStructuredLabelsstructured_labels_factory (int32_t num_labels=0)
 
virtual int32_t get_dim () const
 
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)
 
virtual float64_t delta_loss (CStructuredData *y1, CStructuredData *y2)
 
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 const char * get_name () const
 
void set_labels (CStructuredLabels *labs)
 
CStructuredLabelsget_labels ()
 
void set_features (CFeatures *feats)
 
CFeaturesget_features ()
 
SGVector< float64_tget_joint_feature_vector (int32_t feat_idx, int32_t lab_idx)
 
SGSparseVector< float64_tget_sparse_joint_feature_vector (int32_t feat_idx, int32_t lab_idx)
 
virtual SGSparseVector< float64_tget_sparse_joint_feature_vector (int32_t feat_idx, CStructuredData *y)
 
float64_t delta_loss (int32_t ytrue_idx, CStructuredData *ypred)
 
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="")
 
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)
 
bool has (const std::string &name) const
 
template<typename T >
bool has (const Tag< T > &tag) const
 
template<typename T , typename U = void>
bool has (const std::string &name) const
 
template<typename T >
void set (const Tag< T > &_tag, const T &value)
 
template<typename T , typename U = void>
void set (const std::string &name, const T &value)
 
template<typename T >
get (const Tag< T > &_tag) const
 
template<typename T , typename U = void>
get (const std::string &name) const
 
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)
 
template<typename T >
void register_param (Tag< T > &_tag, const T &value)
 
template<typename T >
void register_param (const std::string &name, const T &value)
 

Protected Attributes

CStructuredLabelsm_labels
 
CFeaturesm_features
 

Constructor & Destructor Documentation

default constructor

Definition at line 17 of file HierarchicalMultilabelModel.cpp.

CHierarchicalMultilabelModel ( CFeatures features,
CStructuredLabels labels,
SGVector< int32_t >  taxonomy,
bool  leaf_nodes_mandatory = false 
)

constructor

Parameters
featuresfeatures
labelsstructured labels
taxonomytaxonomy is stored in an integer array with:
  • length of array = number of nodes
  • each element storing only its parent-id taxonomy[node-id] = parent-id
  • root node should store its parent-id as -1
leaf_nodes_mandatorywhether only full paths (from ROOT to TERMINAL NODES) are only allowed or not class or not

Definition at line 23 of file HierarchicalMultilabelModel.cpp.

destructor

Definition at line 37 of file HierarchicalMultilabelModel.cpp.

Member Function Documentation

CResultSet * argmax ( SGVector< float64_t w,
int32_t  feat_idx,
bool const  training = true 
)
virtual

obtain the argmax of

\[ \Delta(y_{pred}, y_{truth}) + \langle w, \Psi(x_{truth}, y_{pred} \rangle \]

Parameters
wweight vector
feat_idxindex of the feature vector to use
trainingwhether training is being used

Implements CStructuredModel.

Definition at line 212 of file HierarchicalMultilabelModel.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 630 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 747 of file SGObject.cpp.

CSGObject * deep_copy ( ) const
virtualinherited

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

Definition at line 231 of file SGObject.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 166 of file HierarchicalMultilabelModel.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 651 of file SGObject.cpp.

T get ( const Tag< T > &  _tag) const
inherited

Getter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.

Parameters
_tagname and type information of parameter
Returns
value of the parameter identified by the input tag

Definition at line 367 of file SGObject.h.

T get ( const std::string &  name) const
inherited

Getter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.

Parameters
namename of the parameter
Returns
value of the parameter corresponding to the input name and type

Definition at line 388 of file SGObject.h.

int32_t get_dim ( ) const
virtual
Returns
the dimensionality of the joint feature space, i.e., the dimension of the weight vector \(w\).

Implements CStructuredModel.

Definition at line 102 of file HierarchicalMultilabelModel.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 268 of file SGObject.cpp.

Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 310 of file SGObject.cpp.

Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 323 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 labels to use
Returns
joint feature vector

Reimplemented from CStructuredModel.

Definition at line 134 of file HierarchicalMultilabelModel.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 531 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 555 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 568 of file SGObject.cpp.

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

Reimplemented from CStructuredModel.

Definition at line 119 of file HierarchicalMultilabelModel.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.

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.

bool has ( const std::string &  name) const
inherited

Checks if object has a class parameter identified by a name.

Parameters
namename of the parameter
Returns
true if the parameter exists with the input name

Definition at line 289 of file SGObject.h.

bool has ( const Tag< T > &  tag) const
inherited

Checks if object has a class parameter identified by a Tag.

Parameters
tagtag of the parameter containing name and type information
Returns
true if the parameter exists with the input tag

Definition at line 301 of file SGObject.h.

bool has ( const std::string &  name) const
inherited

Checks if a type exists for a class parameter identified by a name.

Parameters
namename of the parameter
Returns
true if the parameter exists with the input name and type

Definition at line 312 of file SGObject.h.

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

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

Reimplemented from CStructuredModel.

Definition at line 199 of file HierarchicalMultilabelModel.cpp.

void init_training ( )
virtualinherited

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
genericset to the type of the generic if returning TRUE
Returns
TRUE if a class template.

Definition at line 329 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 402 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 459 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 454 of file SGObject.cpp.

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

Definition at line 295 of file SGObject.cpp.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 507 of file SGObject.cpp.

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

prints registered parameters out

Parameters
prefixprefix for members

Definition at line 341 of file SGObject.cpp.

void register_param ( Tag< T > &  _tag,
const T &  value 
)
protectedinherited

Registers a class parameter which is identified by a tag. This enables the parameter to be modified by set() and retrieved by get(). Parameters can be registered in the constructor of the class.

Parameters
_tagname and type information of parameter
valuevalue of the parameter

Definition at line 439 of file SGObject.h.

void register_param ( const std::string &  name,
const T &  value 
)
protectedinherited

Registers a class parameter which is identified by a name. This enables the parameter to be modified by set() and retrieved by get(). Parameters can be registered in the constructor of the class.

Parameters
namename of the parameter
valuevalue of the parameter along with type information

Definition at line 452 of file SGObject.h.

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 347 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 469 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 464 of file SGObject.cpp.

void set ( const Tag< T > &  _tag,
const T &  value 
)
inherited

Setter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.

Parameters
_tagname and type information of parameter
valuevalue of the parameter

Definition at line 328 of file SGObject.h.

void set ( const std::string &  name,
const T &  value 
)
inherited

Setter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.

Parameters
namename of the parameter
valuevalue of the parameter along with type information

Definition at line 354 of file SGObject.h.

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 74 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 79 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 84 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 89 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 94 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 99 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 104 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 109 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 114 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 119 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 124 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 129 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 134 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 139 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 144 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 261 of file SGObject.cpp.

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 274 of file SGObject.cpp.

void set_global_version ( Version version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 316 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 225 of file SGObject.cpp.

CStructuredLabels * structured_labels_factory ( int32_t  num_labels = 0)
virtual

create empty StructuredLabels object

Reimplemented from CStructuredModel.

Definition at line 31 of file HierarchicalMultilabelModel.cpp.

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

Definition at line 336 of file SGObject.cpp.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 281 of file SGObject.cpp.

Member Data Documentation

SGIO* io
inherited

io

Definition at line 537 of file SGObject.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 552 of file SGObject.h.

uint32_t m_hash
inherited

Hash of parameter values

Definition at line 555 of file SGObject.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 549 of file SGObject.h.

Parameter* m_parameters
inherited

parameters

Definition at line 546 of file SGObject.h.

Parallel* parallel
inherited

parallel

Definition at line 540 of file SGObject.h.

Version* version
inherited

version

Definition at line 543 of file SGObject.h.


The documentation for this class was generated from the following files:

SHOGUN Machine Learning Toolbox - Documentation