SHOGUN
4.0.0
|
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.
Public Member Functions | |
CHierarchicalMultilabelModel () | |
CHierarchicalMultilabelModel (CFeatures *features, CStructuredLabels *labels, SGVector< int32_t > taxonomy, bool leaf_nodes_mandatory=false) | |
virtual | ~CHierarchicalMultilabelModel () |
virtual CStructuredLabels * | structured_labels_factory (int32_t num_labels=0) |
virtual int32_t | get_dim () const |
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_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) |
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) |
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 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="", int32_t param_version=Version::get_version_parameter()) |
virtual bool | load_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=Version::get_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_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 |
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) |
Protected Attributes | |
CStructuredLabels * | m_labels |
CFeatures * | m_features |
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
features | features |
labels | structured labels |
taxonomy | taxonomy is stored in an integer array with:
|
leaf_nodes_mandatory | whether only full paths (from ROOT to TERMINAL NODES) are only allowed or not class or not |
Definition at line 23 of file HierarchicalMultilabelModel.cpp.
|
virtual |
destructor
Definition at line 37 of file HierarchicalMultilabelModel.cpp.
|
virtual |
obtain the argmax of
\[ \Delta(y_{pred}, y_{truth}) + \langle w, \Psi(x_{truth}, y_{pred} \rangle \]
w | weight vector |
feat_idx | index of the feature vector to use |
training | whether training is being used |
Implements CStructuredModel.
Definition at line 212 of file HierarchicalMultilabelModel.cpp.
|
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.
dict | dictionary of parameters to be built. |
Definition at line 1243 of file SGObject.cpp.
|
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.
|
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.
Definition at line 1360 of file SGObject.cpp.
|
virtualinherited |
A deep copy. All the instance variables will also be copied.
Definition at line 200 of file SGObject.cpp.
|
virtual |
computes \( \Delta(y_{1}, y_{2}) \)
y1 | an instance of structured data |
y2 | another instance of structured data |
Reimplemented from CStructuredModel.
Definition at line 166 of file HierarchicalMultilabelModel.cpp.
|
inherited |
computes \( \Delta(y_{\text{true}}, y_{\text{pred}}) \)
ytrue_idx | index of the true label in labels |
ypred | the predicted label |
Definition at line 147 of file StructuredModel.cpp.
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.
other | object to compare with |
accuracy | accuracy to use for comparison (optional) |
tolerant | allows linient check on float equality (within accuracy) |
Definition at line 1264 of file SGObject.cpp.
|
virtual |
Implements CStructuredModel.
Definition at line 102 of file HierarchicalMultilabelModel.cpp.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
virtual |
get joint feature vector
\[ \vec{\Psi}(\bf{x}_\text{feat\_idx}, \bf{y}) \]
feat_idx | index of the feature vector to use |
y | structured labels to use |
Reimplemented from CStructuredModel.
Definition at line 134 of file HierarchicalMultilabelModel.cpp.
gets joint feature vector
\[ \vec{\Psi}(\bf{x}_\text{feat\_idx}, \bf{y}_\text{lab\_idx}) \]
feat_idx | index of the feature vector to use |
lab_idx | index of the structured label to use |
Definition at line 105 of file StructuredModel.cpp.
|
inherited |
|
inherited |
Definition at line 1135 of file SGObject.cpp.
|
inherited |
Returns description of a given parameter string, if it exists. SG_ERROR otherwise
param_name | name of the parameter |
Definition at line 1159 of file SGObject.cpp.
|
inherited |
Returns index of model selection parameter with provided index
param_name | name of model selection parameter |
Definition at line 1172 of file SGObject.cpp.
|
virtual |
Reimplemented from CStructuredModel.
Definition at line 119 of file HierarchicalMultilabelModel.h.
|
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.
|
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.
|
inherited |
gets joint feature vector
\[ \vec{\Psi}(\bf{x}_\text{feat\_idx}, \bf{y}_\text{lab\_idx}) \]
feat_idx | index of the feature vector to use |
lab_idx | index of the structured label to use |
Definition at line 126 of file StructuredModel.cpp.
|
virtualinherited |
get joint feature vector
\[ \vec{\Psi}(\bf{x}_\text{feat\_idx}, \bf{y}) \]
feat_idx | index of the feature vector to use |
y | structured label to use |
Reimplemented in CHashedMultilabelModel.
Definition at line 137 of file StructuredModel.cpp.
|
virtual |
initialize the optimization problem
regularization | regularization strength |
A | is [-dPsi(y) | -I_N ] with M+N columns => max, M+1 nnz per row |
a | unused input |
B | unused input |
b | upper bound of the constraints, Ax <= b |
lb | lower bounds for w |
ub | upper bounds for w |
C | regularization matrix, w'Cw |
Reimplemented from CStructuredModel.
Definition at line 199 of file HierarchicalMultilabelModel.cpp.
|
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.
|
virtualinherited |
If the SGSerializable is a class template then TRUE will be returned and GENERIC is set to the type of the generic.
generic | set to the type of the generic if returning TRUE |
Definition at line 297 of file SGObject.cpp.
|
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)
file_version | parameter version of the file |
current_version | version from which mapping begins (you want to use Version::get_version_parameter() for this in most cases) |
file | file to load from |
prefix | prefix for members |
Definition at line 704 of file SGObject.cpp.
|
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
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 |
Definition at line 545 of file SGObject.cpp.
|
virtualinherited |
Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!
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) |
Definition at line 374 of file SGObject.cpp.
|
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.
ShogunException | will be thrown if an error occurs. |
Reimplemented in CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.
Definition at line 1062 of file SGObject.cpp.
|
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.
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 1057 of file SGObject.cpp.
|
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
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 742 of file SGObject.cpp.
|
protectedvirtualinherited |
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
param_base | set of TParameter instances to use for migration |
target | parameter info for the resulting TParameter |
Definition at line 949 of file SGObject.cpp.
|
protectedvirtualinherited |
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)
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 889 of file SGObject.cpp.
|
virtualinherited |
Definition at line 263 of file SGObject.cpp.
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 1111 of file SGObject.cpp.
|
virtualinherited |
prints registered parameters out
prefix | prefix for members |
Definition at line 309 of file SGObject.cpp.
|
virtualinherited |
Save this object to file.
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) |
Definition at line 315 of file SGObject.cpp.
|
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.
ShogunException | will be thrown if an error occurs. |
Reimplemented in CKernel.
Definition at line 1072 of file SGObject.cpp.
|
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.
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 1067 of file SGObject.cpp.
|
inherited |
|
inherited |
Definition at line 42 of file SGObject.cpp.
|
inherited |
Definition at line 47 of file SGObject.cpp.
|
inherited |
Definition at line 52 of file SGObject.cpp.
|
inherited |
Definition at line 57 of file SGObject.cpp.
|
inherited |
Definition at line 62 of file SGObject.cpp.
|
inherited |
Definition at line 67 of file SGObject.cpp.
|
inherited |
Definition at line 72 of file SGObject.cpp.
|
inherited |
Definition at line 77 of file SGObject.cpp.
|
inherited |
Definition at line 82 of file SGObject.cpp.
|
inherited |
Definition at line 87 of file SGObject.cpp.
|
inherited |
Definition at line 92 of file SGObject.cpp.
|
inherited |
Definition at line 97 of file SGObject.cpp.
|
inherited |
Definition at line 102 of file SGObject.cpp.
|
inherited |
Definition at line 107 of file SGObject.cpp.
|
inherited |
Definition at line 112 of file SGObject.cpp.
|
inherited |
set generic type to T
|
inherited |
|
inherited |
set the parallel object
parallel | parallel object to use |
Definition at line 243 of file SGObject.cpp.
|
inherited |
set the version object
version | version object to use |
Definition at line 284 of file SGObject.cpp.
|
inherited |
|
virtualinherited |
A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.
Reimplemented in CGaussianKernel.
Definition at line 194 of file SGObject.cpp.
|
virtual |
create empty StructuredLabels object
Reimplemented from CStructuredModel.
Definition at line 31 of file HierarchicalMultilabelModel.cpp.
|
inherited |
unset generic type
this has to be called in classes specializing a template class
Definition at line 304 of file SGObject.cpp.
|
virtualinherited |
Updates the hash of current parameter combination
Definition at line 250 of file SGObject.cpp.
|
inherited |
io
Definition at line 496 of file SGObject.h.
|
protectedinherited |
feature vectors
Definition at line 308 of file StructuredModel.h.
|
inherited |
parameters wrt which we can compute gradients
Definition at line 511 of file SGObject.h.
|
inherited |
Hash of parameter values
Definition at line 517 of file SGObject.h.
|
protectedinherited |
structured labels
Definition at line 305 of file StructuredModel.h.
|
inherited |
model selection parameters
Definition at line 508 of file SGObject.h.
|
inherited |
map for different parameter versions
Definition at line 514 of file SGObject.h.
|
inherited |
parameters
Definition at line 505 of file SGObject.h.
|
inherited |
parallel
Definition at line 499 of file SGObject.h.
|
inherited |
version
Definition at line 502 of file SGObject.h.