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
在文件 HierarchicalMultilabelModel.h 第 29 行定义.
|
| 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="") |
|
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
- 参数
-
features | features |
labels | structured labels |
taxonomy | taxonomy 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_mandatory | whether only full paths (from ROOT to TERMINAL NODES) are only allowed or not class or not |
在文件 HierarchicalMultilabelModel.cpp 第 23 行定义.
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 |
实现了 CStructuredModel.
在文件 HierarchicalMultilabelModel.cpp 第 212 行定义.
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. |
在文件 SGObject.cpp 第 597 行定义.
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).
被 CHMSVMModel 重载.
在文件 StructuredModel.cpp 第 183 行定义.
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.
- 返回
- 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
在文件 SGObject.cpp 第 714 行定义.
A deep copy. All the instance variables will also be copied.
在文件 SGObject.cpp 第 198 行定义.
computes \( \Delta(y_{\text{true}}, y_{\text{pred}}) \)
- 参数
-
ytrue_idx | index of the true label in labels |
ypred | the predicted label |
- 返回
- loss value
在文件 StructuredModel.cpp 第 147 行定义.
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) |
- 返回
- true if all parameters were equal, false if not
在文件 SGObject.cpp 第 618 行定义.
int32_t get_dim |
( |
| ) |
const |
|
virtual |
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 |
- 返回
- the joint feature vector
在文件 StructuredModel.cpp 第 105 行定义.
- 返回
- vector of names of all parameters which are registered for model selection
在文件 SGObject.cpp 第 498 行定义.
char * get_modsel_param_descr |
( |
const char * |
param_name | ) |
|
|
inherited |
Returns description of a given parameter string, if it exists. SG_ERROR otherwise
- 参数
-
param_name | name of the parameter |
- 返回
- description of the parameter
在文件 SGObject.cpp 第 522 行定义.
index_t get_modsel_param_index |
( |
const char * |
param_name | ) |
|
|
inherited |
Returns index of model selection parameter with provided index
- 参数
-
param_name | name of model selection parameter |
- 返回
- index of model selection parameter with provided name, -1 if there is no such
在文件 SGObject.cpp 第 535 行定义.
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
被 CHMSVMModel 重载.
在文件 StructuredModel.cpp 第 189 行定义.
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
被 CHMSVMModel 重载.
在文件 StructuredModel.cpp 第 194 行定义.
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 |
- 返回
- the joint feature vector
在文件 StructuredModel.cpp 第 126 行定义.
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 |
- 返回
- the joint feature vector
被 CHashedMultilabelModel 重载.
在文件 StructuredModel.cpp 第 137 行定义.
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 |
重载 CStructuredModel .
在文件 HierarchicalMultilabelModel.cpp 第 199 行定义.
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.
- 参数
-
generic | set to the type of the generic if returning TRUE |
- 返回
- TRUE if a class template.
在文件 SGObject.cpp 第 296 行定义.
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 |
- 返回
- TRUE if done, otherwise FALSE
在文件 SGObject.cpp 第 369 行定义.
|
protectedvirtualinherited |
|
protectedvirtualinherited |
bool parameter_hash_changed |
( |
| ) |
|
|
virtualinherited |
- 返回
- whether parameter combination has changed since last update
在文件 SGObject.cpp 第 262 行定义.
void print_modsel_params |
( |
| ) |
|
|
inherited |
prints all parameter registered for model selection and their type
在文件 SGObject.cpp 第 474 行定义.
void print_serializable |
( |
const char * |
prefix = "" | ) |
|
|
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 |
- 返回
- TRUE if done, otherwise FALSE
在文件 SGObject.cpp 第 314 行定义.
|
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.
- 异常
-
被 CKernel 重载.
在文件 SGObject.cpp 第 436 行定义.
|
protectedvirtualinherited |
void set_global_io |
( |
SGIO * |
io | ) |
|
|
inherited |
void set_global_parallel |
( |
Parallel * |
parallel | ) |
|
|
inherited |
set the parallel object
- 参数
-
parallel | parallel object to use |
在文件 SGObject.cpp 第 241 行定义.
void set_global_version |
( |
Version * |
version | ) |
|
|
inherited |
set the version object
- 参数
-
version | version object to use |
在文件 SGObject.cpp 第 283 行定义.
unset generic type
this has to be called in classes specializing a template class
在文件 SGObject.cpp 第 303 行定义.
void update_parameter_hash |
( |
| ) |
|
|
virtualinherited |
Updates the hash of current parameter combination
在文件 SGObject.cpp 第 248 行定义.
parameters wrt which we can compute gradients
在文件 SGObject.h 第 384 行定义.
该类的文档由以下文件生成: