SHOGUN
4.1.0
|
Class MultilabelCLRModel represents application specific model and contains application dependent logic for solving multi-label classification using Calibrated Label Ranking (CLR) [1] method within a generic SO framework.
[1] J. Furnkranz, et.al. Multilabel Classification via Calibrated Label Ranking. https://www.mathematik.uni-marburg.de/~eyke/publications/ml08.pdf
在文件 MultilabelCLRModel.h 第 25 行定义.
Public 成员函数 | |
CMultilabelCLRModel () | |
CMultilabelCLRModel (CFeatures *features, CStructuredLabels *labels) | |
virtual | ~CMultilabelCLRModel () |
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 属性 | |
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 成员函数 | |
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 属性 | |
CStructuredLabels * | m_labels |
CFeatures * | m_features |
default constructor
在文件 MultilabelCLRModel.cpp 第 16 行定义.
CMultilabelCLRModel | ( | CFeatures * | features, |
CStructuredLabels * | labels | ||
) |
|
virtual |
destructor
在文件 MultilabelCLRModel.cpp 第 34 行定义.
|
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 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 |
实现了 CStructuredModel.
在文件 MultilabelCLRModel.cpp 第 160 行定义.
|
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. |
在文件 SGObject.cpp 第 1244 行定义.
|
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 行定义.
|
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.
在文件 SGObject.cpp 第 1361 行定义.
|
virtualinherited |
A deep copy. All the instance variables will also be copied.
在文件 SGObject.cpp 第 200 行定义.
|
virtual |
computes \( \Delta(y_{1}, y_{2}) \)
y1 | an instance of structured data |
y2 | another instance of structured data |
重载 CStructuredModel .
在文件 MultilabelCLRModel.cpp 第 93 行定义.
|
inherited |
computes \( \Delta(y_{\text{true}}, y_{\text{pred}}) \)
ytrue_idx | index of the true label in labels |
ypred | the predicted label |
在文件 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) |
在文件 SGObject.cpp 第 1265 行定义.
|
virtual |
return the dimensionality of the joint feature space, i.e., the dimension of the weight vector \(w\).
实现了 CStructuredModel.
在文件 MultilabelCLRModel.cpp 第 45 行定义.
|
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 label to use |
重载 CStructuredModel .
在文件 MultilabelCLRModel.cpp 第 53 行定义.
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 |
在文件 StructuredModel.cpp 第 105 行定义.
|
inherited |
|
inherited |
在文件 SGObject.cpp 第 1136 行定义.
|
inherited |
Returns description of a given parameter string, if it exists. SG_ERROR otherwise
param_name | name of the parameter |
在文件 SGObject.cpp 第 1160 行定义.
|
inherited |
Returns index of model selection parameter with provided index
param_name | name of model selection parameter |
在文件 SGObject.cpp 第 1173 行定义.
|
virtual |
|
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 行定义.
|
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 行定义.
|
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 |
在文件 StructuredModel.cpp 第 126 行定义.
|
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 |
被 CHashedMultilabelModel 重载.
在文件 StructuredModel.cpp 第 137 行定义.
|
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 |
重载 CStructuredModel .
在文件 MultilabelCLRModel.cpp 第 259 行定义.
|
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
被 CHMSVMModel , 以及 CFactorGraphModel 重载.
在文件 StructuredModel.cpp 第 178 行定义.
|
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 |
在文件 SGObject.cpp 第 298 行定义.
|
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 |
在文件 SGObject.cpp 第 705 行定义.
|
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 |
在文件 SGObject.cpp 第 546 行定义.
|
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) |
在文件 SGObject.cpp 第 375 行定义.
|
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. |
被 CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel , 以及 CExponentialKernel 重载.
在文件 SGObject.cpp 第 1063 行定义.
|
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. |
被 CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.
在文件 SGObject.cpp 第 1058 行定义.
|
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 |
在文件 SGObject.cpp 第 743 行定义.
|
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 |
在文件 SGObject.cpp 第 950 行定义.
|
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 |
在文件 SGObject.cpp 第 890 行定义.
|
virtualinherited |
在文件 SGObject.cpp 第 264 行定义.
|
inherited |
prints all parameter registered for model selection and their type
在文件 SGObject.cpp 第 1112 行定义.
|
virtualinherited |
|
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) |
在文件 SGObject.cpp 第 316 行定义.
|
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. |
被 CKernel 重载.
在文件 SGObject.cpp 第 1073 行定义.
|
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. |
被 CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.
在文件 SGObject.cpp 第 1068 行定义.
|
inherited |
|
inherited |
在文件 SGObject.cpp 第 42 行定义.
|
inherited |
在文件 SGObject.cpp 第 47 行定义.
|
inherited |
在文件 SGObject.cpp 第 52 行定义.
|
inherited |
在文件 SGObject.cpp 第 57 行定义.
|
inherited |
在文件 SGObject.cpp 第 62 行定义.
|
inherited |
在文件 SGObject.cpp 第 67 行定义.
|
inherited |
在文件 SGObject.cpp 第 72 行定义.
|
inherited |
在文件 SGObject.cpp 第 77 行定义.
|
inherited |
在文件 SGObject.cpp 第 82 行定义.
|
inherited |
在文件 SGObject.cpp 第 87 行定义.
|
inherited |
在文件 SGObject.cpp 第 92 行定义.
|
inherited |
在文件 SGObject.cpp 第 97 行定义.
|
inherited |
在文件 SGObject.cpp 第 102 行定义.
|
inherited |
在文件 SGObject.cpp 第 107 行定义.
|
inherited |
在文件 SGObject.cpp 第 112 行定义.
|
inherited |
set generic type to T
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
virtualinherited |
A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.
被 CGaussianKernel 重载.
在文件 SGObject.cpp 第 194 行定义.
|
virtual |
|
inherited |
unset generic type
this has to be called in classes specializing a template class
在文件 SGObject.cpp 第 305 行定义.
|
virtualinherited |
Updates the hash of current parameter combination
在文件 SGObject.cpp 第 250 行定义.
|
inherited |
io
在文件 SGObject.h 第 496 行定义.
|
protectedinherited |
feature vectors
在文件 StructuredModel.h 第 308 行定义.
|
inherited |
parameters wrt which we can compute gradients
在文件 SGObject.h 第 511 行定义.
|
inherited |
Hash of parameter values
在文件 SGObject.h 第 517 行定义.
|
protectedinherited |
structured labels
在文件 StructuredModel.h 第 305 行定义.
|
inherited |
model selection parameters
在文件 SGObject.h 第 508 行定义.
|
inherited |
map for different parameter versions
在文件 SGObject.h 第 514 行定义.
|
inherited |
parameters
在文件 SGObject.h 第 505 行定义.
|
inherited |
parallel
在文件 SGObject.h 第 499 行定义.
|
inherited |
version
在文件 SGObject.h 第 502 行定义.