SHOGUN
4.2.0
|
CFactorGraphModel defines a model in terms of CFactorGraph and CMAPInference, where parameters are associated with factor types, in the model. There is a mapping vector records the locations of local factor parameters in the global parameter vector.
TODO: implement functions for SGD
Definition at line 32 of file FactorGraphModel.h.
Public Member Functions | |
CFactorGraphModel () | |
CFactorGraphModel (CFeatures *features, CStructuredLabels *labels, EMAPInferType inf_type=TREE_MAX_PROD, bool verbose=false) | |
~CFactorGraphModel () | |
virtual const char * | get_name () const |
void | add_factor_type (CFactorType *ftype) |
void | del_factor_type (const int32_t ftype_id) |
CDynamicObjectArray * | get_factor_types () const |
CFactorType * | get_factor_type (const int32_t ftype_id) const |
SGVector< int32_t > | get_global_params_mapping () const |
SGVector< int32_t > | get_params_mapping (const int32_t ftype_id) |
SGVector< float64_t > | fparams_to_w () |
void | w_to_fparams (SGVector< float64_t > w) |
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_training () |
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 int32_t | get_dim () const |
void | set_labels (CStructuredLabels *labs) |
CStructuredLabels * | get_labels () |
virtual CStructuredLabels * | structured_labels_factory (int32_t num_labels=0) |
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 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) |
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 > | |
T | get (const Tag< T > &_tag) const |
template<typename T , typename U = void> | |
T | 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 CSGObject * | clone () |
Public Attributes | |
SGIO * | io |
Parallel * | parallel |
Version * | version |
Parameter * | m_parameters |
Parameter * | m_model_selection_parameters |
Parameter * | m_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 | |
CDynamicObjectArray * | m_factor_types |
SGVector< int32_t > | m_w_map |
SGVector< float64_t > | m_w_cache |
EMAPInferType | m_inf_type |
bool | m_verbose |
CStructuredLabels * | m_labels |
CFeatures * | m_features |
constructor
Definition at line 26 of file FactorGraphModel.cpp.
CFactorGraphModel | ( | CFeatures * | features, |
CStructuredLabels * | labels, | ||
EMAPInferType | inf_type = TREE_MAX_PROD , |
||
bool | verbose = false |
||
) |
constructor
features | pointer to structured inputs |
labels | pointer to structured outputs |
inf_type | MAP inference type, default is tree max-product inference |
verbose | whether output verbose information, such as energy table, slack variables etc. NOTE: do NOT set this up when training with large data, massive printing will crash the program |
Definition at line 32 of file FactorGraphModel.cpp.
~CFactorGraphModel | ( | ) |
destructor
Definition at line 40 of file FactorGraphModel.cpp.
void add_factor_type | ( | CFactorType * | ftype | ) |
add a new factor type, NOTE: a factor type is not allowed to change once it has been added to the FactorGraphModel. Secondly, the model itself should not be modified during training, i.e. no add/delete operations.
ftype | pointer to new factor type |
Definition at line 58 of file FactorGraphModel.cpp.
|
virtual |
obtains 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. |
Implements CStructuredModel.
Definition at line 288 of file FactorGraphModel.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 630 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 747 of file SGObject.cpp.
|
virtualinherited |
A deep copy. All the instance variables will also be copied.
Definition at line 231 of file SGObject.cpp.
void del_factor_type | ( | const int32_t | ftype_id | ) |
delete a factor type
ftype_id | factor type id |
Definition at line 105 of file FactorGraphModel.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 383 of file FactorGraphModel.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 651 of file SGObject.cpp.
Definition at line 175 of file FactorGraphModel.cpp.
|
inherited |
Getter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.
_tag | name and type information of parameter |
Definition at line 367 of file SGObject.h.
|
inherited |
Getter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.
name | name of the parameter |
Definition at line 388 of file SGObject.h.
|
virtual |
return the dimensionality of the joint feature space, i.e. the dimension of the weight vector \(w\)
Implements CStructuredModel.
Definition at line 170 of file FactorGraphModel.cpp.
CFactorType * get_factor_type | ( | const int32_t | ftype_id | ) | const |
get a factor type specified by its id
ftype_id | factor type id |
Definition at line 146 of file FactorGraphModel.cpp.
CDynamicObjectArray * get_factor_types | ( | ) | const |
Definition at line 140 of file FactorGraphModel.cpp.
|
inherited |
|
inherited |
|
inherited |
SGVector< int32_t > get_global_params_mapping | ( | ) | const |
Definition at line 160 of file FactorGraphModel.cpp.
|
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 |
Reimplemented from CStructuredModel.
Definition at line 235 of file FactorGraphModel.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 531 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 555 of file SGObject.cpp.
|
inherited |
Returns index of model selection parameter with provided index
param_name | name of model selection parameter |
Definition at line 568 of file SGObject.cpp.
|
virtual |
Reimplemented from CStructuredModel.
Definition at line 53 of file FactorGraphModel.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.
SGVector< int32_t > get_params_mapping | ( | const int32_t | ftype_id | ) |
get parameter mapping for a factor type
ftype_id | factor type id |
Definition at line 165 of file FactorGraphModel.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.
|
inherited |
Checks if object has a class parameter identified by a name.
name | name of the parameter |
Definition at line 289 of file SGObject.h.
|
inherited |
Checks if object has a class parameter identified by a Tag.
tag | tag of the parameter containing name and type information |
Definition at line 301 of file SGObject.h.
|
inherited |
Checks if a type exists for a class parameter identified by a name.
name | name of the parameter |
Definition at line 312 of file SGObject.h.
|
virtual |
initialize the optimization problem for primal solver
regularization | input for C |
A | is [-dPsi(y) | -I_N ] with M+N columns => max. M+1 nnz per row |
a | unused input |
B | unused input |
b | upper bounds 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 406 of file FactorGraphModel.cpp.
|
virtual |
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 from CStructuredModel.
Definition at line 402 of file FactorGraphModel.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 329 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 |
Definition at line 402 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 459 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 454 of file SGObject.cpp.
|
virtualinherited |
Definition at line 295 of file SGObject.cpp.
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 507 of file SGObject.cpp.
|
virtualinherited |
prints registered parameters out
prefix | prefix for members |
Definition at line 341 of file SGObject.cpp.
|
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.
_tag | name and type information of parameter |
value | value of the parameter |
Definition at line 439 of file SGObject.h.
|
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.
name | name of the parameter |
value | value of the parameter along with type information |
Definition at line 452 of file SGObject.h.
|
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 |
Definition at line 347 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 469 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 464 of file SGObject.cpp.
|
inherited |
Setter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.
_tag | name and type information of parameter |
value | value of the parameter |
Definition at line 328 of file SGObject.h.
|
inherited |
Setter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.
name | name of the parameter |
value | value of the parameter along with type information |
Definition at line 354 of file SGObject.h.
|
inherited |
|
inherited |
Definition at line 74 of file SGObject.cpp.
|
inherited |
Definition at line 79 of file SGObject.cpp.
|
inherited |
Definition at line 84 of file SGObject.cpp.
|
inherited |
Definition at line 89 of file SGObject.cpp.
|
inherited |
Definition at line 94 of file SGObject.cpp.
|
inherited |
Definition at line 99 of file SGObject.cpp.
|
inherited |
Definition at line 104 of file SGObject.cpp.
|
inherited |
Definition at line 109 of file SGObject.cpp.
|
inherited |
Definition at line 114 of file SGObject.cpp.
|
inherited |
Definition at line 119 of file SGObject.cpp.
|
inherited |
Definition at line 124 of file SGObject.cpp.
|
inherited |
Definition at line 129 of file SGObject.cpp.
|
inherited |
Definition at line 134 of file SGObject.cpp.
|
inherited |
Definition at line 139 of file SGObject.cpp.
|
inherited |
Definition at line 144 of file SGObject.cpp.
|
inherited |
set generic type to T
|
inherited |
|
inherited |
set the parallel object
parallel | parallel object to use |
Definition at line 274 of file SGObject.cpp.
|
inherited |
set the version object
version | version object to use |
Definition at line 316 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 225 of file SGObject.cpp.
|
virtualinherited |
create empty StructuredLabels object
Reimplemented in CHierarchicalMultilabelModel, CHashedMultilabelModel, CMulticlassModel, CMultilabelCLRModel, and CMultilabelModel.
Definition at line 34 of file StructuredModel.cpp.
|
inherited |
unset generic type
this has to be called in classes specializing a template class
Definition at line 336 of file SGObject.cpp.
|
virtualinherited |
Updates the hash of current parameter combination
Definition at line 281 of file SGObject.cpp.
update local parameters
w | new global parameter vector |
Definition at line 204 of file FactorGraphModel.cpp.
|
inherited |
io
Definition at line 537 of file SGObject.h.
|
protected |
array of factor types
Definition at line 170 of file FactorGraphModel.h.
|
protectedinherited |
feature vectors
Definition at line 308 of file StructuredModel.h.
|
inherited |
parameters wrt which we can compute gradients
Definition at line 552 of file SGObject.h.
|
inherited |
Hash of parameter values
Definition at line 555 of file SGObject.h.
|
protected |
MAP inference type
Definition at line 179 of file FactorGraphModel.h.
|
protectedinherited |
structured labels
Definition at line 305 of file StructuredModel.h.
|
inherited |
model selection parameters
Definition at line 549 of file SGObject.h.
|
inherited |
parameters
Definition at line 546 of file SGObject.h.
|
protected |
whether print verbose information
Definition at line 182 of file FactorGraphModel.h.
cache of global parameters
Definition at line 176 of file FactorGraphModel.h.
|
protected |
index of factor type
Definition at line 173 of file FactorGraphModel.h.
|
inherited |
parallel
Definition at line 540 of file SGObject.h.
|
inherited |
version
Definition at line 543 of file SGObject.h.