SHOGUN
v3.0.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 30 of file FactorGraphModel.h.
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 | |
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 25 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 |
Definition at line 31 of file FactorGraphModel.cpp.
~CFactorGraphModel | ( | ) |
destructor
Definition at line 39 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 57 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 287 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 1196 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 148 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 1313 of file SGObject.cpp.
|
virtualinherited |
A deep copy. All the instance variables will also be copied.
Definition at line 160 of file SGObject.h.
void del_factor_type | ( | const int32_t | ftype_id | ) |
delete a factor type
ftype_id | factor type id |
Definition at line 104 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 381 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 112 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) |
Definition at line 1217 of file SGObject.cpp.
Definition at line 174 of file FactorGraphModel.cpp.
|
virtual |
return the dimensionality of the joint feature space, i.e. the dimension of the weight vector \(w\)
Implements CStructuredModel.
Definition at line 169 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 145 of file FactorGraphModel.cpp.
CDynamicObjectArray * get_factor_types | ( | ) | const |
Definition at line 139 of file FactorGraphModel.cpp.
|
inherited |
|
inherited |
|
inherited |
SGVector< int32_t > get_global_params_mapping | ( | ) | const |
Definition at line 159 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 234 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 91 of file StructuredModel.cpp.
|
inherited |
|
inherited |
Definition at line 1100 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 1124 of file SGObject.cpp.
|
inherited |
Returns index of model selection parameter with provided index
param_name | name of model selection parameter |
Definition at line 1137 of file SGObject.cpp.
|
virtual |
Reimplemented from CStructuredModel.
Definition at line 49 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 154 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 159 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 164 of file FactorGraphModel.cpp.
|
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 404 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 400 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 268 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 673 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 514 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 345 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 occurres. |
Reimplemented in CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.
Definition at line 1029 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 occurres. |
Reimplemented in CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, CDynamicArray< uint64_t >, and CDynamicObjectArray.
Definition at line 1024 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 711 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 918 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 858 of file SGObject.cpp.
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 1076 of file SGObject.cpp.
|
virtualinherited |
prints registered parameters out
prefix | prefix for members |
Definition at line 280 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 286 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 occurres. |
Reimplemented in CKernel.
Definition at line 1039 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 occurres. |
Reimplemented in CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, CDynamicArray< uint64_t >, and CDynamicObjectArray.
Definition at line 1034 of file SGObject.cpp.
|
inherited |
|
inherited |
set generic type to T
Definition at line 41 of file SGObject.cpp.
|
inherited |
|
inherited |
set the parallel object
parallel | parallel object to use |
Definition at line 220 of file SGObject.cpp.
|
inherited |
set the version object
version | version object to use |
Definition at line 255 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 151 of file SGObject.h.
|
inherited |
unset generic type
this has to be called in classes specializing a template class
Definition at line 275 of file SGObject.cpp.
|
virtualinherited |
Updates the hash of current parameter combination.
Definition at line 227 of file SGObject.cpp.
update local parameters
w | new global parameter vector |
Definition at line 203 of file FactorGraphModel.cpp.
|
inherited |
io
Definition at line 514 of file SGObject.h.
|
protected |
array of factor types
Definition at line 166 of file FactorGraphModel.h.
|
protectedinherited |
feature vectors
Definition at line 259 of file StructuredModel.h.
|
inherited |
parameters wrt which we can compute gradients
Definition at line 529 of file SGObject.h.
|
inherited |
Hash of parameter values
Definition at line 535 of file SGObject.h.
|
protected |
MAP inference type
Definition at line 175 of file FactorGraphModel.h.
|
protectedinherited |
structured labels
Definition at line 256 of file StructuredModel.h.
|
inherited |
model selection parameters
Definition at line 526 of file SGObject.h.
|
inherited |
map for different parameter versions
Definition at line 532 of file SGObject.h.
|
inherited |
parameters
Definition at line 523 of file SGObject.h.
|
protected |
whether print verbose information
Definition at line 178 of file FactorGraphModel.h.
cache of global parameters
Definition at line 172 of file FactorGraphModel.h.
|
protected |
index of factor type
Definition at line 169 of file FactorGraphModel.h.
|
inherited |
parallel
Definition at line 517 of file SGObject.h.
|
inherited |
version
Definition at line 520 of file SGObject.h.