Class CMultilabelModel represents application specific model and contains application dependent logic for solving multilabel classification within a generic SO framework.
[1] C. Lampert. Maximum Margin Multi-Label Structured Prediction, NIPS 2011. http://machinelearning.wustl.edu/mlpapers/paper_files/NIPS2011_0207.pdf
Definition at line 24 of file MultilabelModel.h.
|
| | CMultilabelModel () |
| |
| | CMultilabelModel (CFeatures *features, CStructuredLabels *labels) |
| |
| virtual | ~CMultilabelModel () |
| |
| 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 | set_misclass_cost (float64_t false_positive, float64_t false_negative) |
| |
| 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="") |
| |
| 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 () |
| |
constructor
- Parameters
-
| features | features |
| labels | structured labels |
Definition at line 21 of file MultilabelModel.cpp.
obtain 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
Implements CStructuredModel.
Definition at line 153 of file MultilabelModel.cpp.
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 |
|
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.
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.
A deep copy. All the instance variables will also be copied.
Definition at line 198 of file SGObject.cpp.
computes \( \Delta(y_{1}, y_{2}) \)
- Parameters
-
| y1 | an instance of structured data |
| y2 | another instance of structured data |
- Returns
- loss value
Reimplemented from CStructuredModel.
Definition at line 86 of file MultilabelModel.cpp.
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.
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.
| int32_t get_dim |
( |
| ) |
const |
|
virtual |
get the io object
- Returns
- io object
Definition at line 235 of file SGObject.cpp.
get the parallel object
- Returns
- parallel object
Definition at line 277 of file SGObject.cpp.
get the version object
- Returns
- version object
Definition at line 290 of file SGObject.cpp.
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 |
Reimplemented from CStructuredModel.
Definition at line 63 of file MultilabelModel.cpp.
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.
- 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 |
| 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.
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.
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.
initialize the optimization problem
- Parameters
-
| 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 215 of file MultilabelModel.cpp.
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.
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.
|
|
protectedvirtualinherited |
|
|
protectedvirtualinherited |
| 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
-
Definition at line 308 of file SGObject.cpp.
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.
|
|
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
-
Reimplemented in CKernel.
Definition at line 436 of file SGObject.cpp.
|
|
protectedvirtualinherited |
| void set_global_io |
( |
SGIO * |
io | ) |
|
|
inherited |
| 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.
set misclassification cost for false positive and false negative
- Parameters
-
| false_positive | cost for false positive |
| false_negative | cost for false negative |
Definition at line 57 of file MultilabelModel.cpp.
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.
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.
parameters wrt which we can compute gradients
Definition at line 384 of file SGObject.h.
Hash of parameter values
Definition at line 387 of file SGObject.h.
model selection parameters
Definition at line 381 of file SGObject.h.
The documentation for this class was generated from the following files:
