SHOGUN
4.2.0
|
class CTwoStateModel class for the internal two-state representation used in the CHMSVMModel.
Definition at line 26 of file TwoStateModel.h.
Public Member Functions | |
CTwoStateModel () | |
virtual | ~CTwoStateModel () |
virtual SGMatrix< float64_t > | loss_matrix (CSequence *label_seq) |
virtual float64_t | loss (CSequence *label_seq_lhs, CSequence *label_seq_rhs) |
virtual void | reshape_emission_params (SGVector< float64_t > &emission_weights, SGVector< float64_t > w, int32_t num_feats, int32_t num_obs) |
virtual void | reshape_emission_params (CDynamicObjectArray *plif_matrix, SGVector< float64_t > w, int32_t num_feats, int32_t num_plif_nodes) |
virtual void | reshape_transmission_params (SGMatrix< float64_t > &transmission_weights, SGVector< float64_t > w) |
virtual SGVector< int32_t > | labels_to_states (CSequence *label_seq) const |
virtual CSequence * | states_to_labels (SGVector< int32_t > state_seq) const |
virtual void | weights_to_vector (SGVector< float64_t > &psi, SGMatrix< float64_t > transmission_weights, SGVector< float64_t > emission_weights, int32_t num_feats, int32_t num_obs) const |
virtual SGVector< float64_t > | weights_to_vector (SGMatrix< float64_t > transmission_weights, SGVector< float64_t > emission_weights, int32_t num_feats, int32_t num_obs) const |
virtual SGVector< int32_t > | get_monotonicity (int32_t num_free_states, int32_t num_feats) const |
virtual const char * | get_name () const |
int32_t | get_num_states () const |
int32_t | get_num_transmission_params () const |
SGVector< float64_t > | get_start_states () const |
SGVector< float64_t > | get_stop_states () 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 () |
Static Public Member Functions | |
static CHMSVMModel * | simulate_data (int32_t num_exm, int32_t exm_len, int32_t num_features, int32_t num_noise_features) |
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 | |
int32_t | m_num_states |
int32_t | m_num_transmission_params |
SGMatrix< float64_t > | m_state_loss_mat |
SGVector< float64_t > | m_p |
SGVector< float64_t > | m_q |
CTwoStateModel | ( | ) |
default constructor
Definition at line 18 of file TwoStateModel.cpp.
|
virtual |
destructor
Definition at line 43 of file TwoStateModel.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 |
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.
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.
|
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.
|
inherited |
|
inherited |
|
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 |
specify monotonicity constraints for feature scoring functions. The elements of the vector returned can take one of three values:
see CStateModel::get_monotonicity
num_free_states | number of states whose parameters are learnt |
num_feats | number of features |
Reimplemented from CStateModel.
Definition at line 234 of file TwoStateModel.cpp.
|
virtual |
Reimplemented from CStateModel.
Definition at line 174 of file TwoStateModel.h.
|
inherited |
Definition at line 24 of file StateModel.cpp.
|
inherited |
Definition at line 29 of file StateModel.cpp.
return the distribution of start states, i.e. the specification of which states may appear in the start of a state sequence and which may not. The elements of the vector returned can take one out of two values:
The distrubtion of start states m_p must be initialized in the constructor of CStateModel's child classes.
Definition at line 56 of file StateModel.cpp.
return the distribution of stop states, i.e. the specification of which states may appear in the end of a state sequence and which may not. The elements of the vector returned can take one out of two values:
The distrubtion of stop states m_q must be initialized in the constructor of CStateModel's child classes.
Definition at line 61 of file StateModel.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.
|
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.
translates label sequence to state sequence
label_seq | label sequence |
Implements CStateModel.
Definition at line 75 of file TwoStateModel.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.
computes the loss between two sequences of labels using the Hamming loss and the state loss matrix
label_seq_lhs | one label sequence |
label_seq_rhs | other label sequence |
Implements CStateModel.
Definition at line 61 of file TwoStateModel.cpp.
computes a loss matrix with m_num_states rows and number of columns equal to the length of label_seq. This matrix can be added directly to the emission matrix used in Viterbi decoding during training to form the loss-augmented emission matrix
label_seq | label sequence (normally the true label sequence) |
Implements CStateModel.
Definition at line 47 of file TwoStateModel.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.
|
virtual |
arranges the emission parameterss of the weight vector into a vector adding zero elements for the states whose parameters are not learnt. This vector is suitable to iterate through when constructing the emission matrix used in Viterbi decoding
emission_weights | emission parameters outputted |
w | the weight vector |
num_feats | number of features |
num_obs | number of emission scores per feature and state |
Implements CStateModel.
Definition at line 120 of file TwoStateModel.cpp.
|
virtual |
arranges the emission parameters of the weight vector into a matrix of PLiFs adding zero elements for the states whose parameters are not learnt.
plif_matrix | matrix of PLiFs outputted |
w | the weight vector |
num_feats | number of features |
num_plif_nodes | number of nodes in the PLiFs |
Implements CStateModel.
Definition at line 147 of file TwoStateModel.cpp.
|
virtual |
arranges the transmission parameters of the weight vector into a matrix adding zero elements for the states whose parameters are not learnt. This matrix is suitable to iterate during Viterbi decoding
transmission_weights | transmission parameters outputted |
w | the weight vector |
Implements CStateModel.
Definition at line 169 of file TwoStateModel.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 |
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 |
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.
|
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.
|
static |
generates simulated data. The features are generated from the label sequence swapping some of the labels and adding noise
num_exm | number of sample pairs (sequence of features, sequence of labels) to generate |
exm_len | length of each sample sequence |
num_features | features dimension |
num_noise_features | number of features to be pure noise |
Definition at line 249 of file TwoStateModel.cpp.
translates state sequence to label sequence
state_seq | state sequence |
Implements CStateModel.
Definition at line 98 of file TwoStateModel.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.
|
virtual |
reshapes the transition and emission weights into a vector (the joint feature vector so it will be possible to take the dot product with the weight vector). Version with the joint feature vector as parameter by reference
psi | output vector |
transmission_weights | counts of the state transitions for a state sequence |
emission_weights | counts of the emission scores for a state sequence and a feature vector |
num_feats | number of features |
num_obs | number of emission scores per feature and state |
Implements CStateModel.
Definition at line 193 of file TwoStateModel.cpp.
|
virtual |
reshapes the transition and emission weights into a vector (the joint feature vector so it will be possible to take the dot product with the weight vector). Version returning the joint feature vector
transmission_weights | counts of the state transitions for a state sequence |
emission_weights | counts of the emission scores for a state sequence and a feature vector |
num_feats | number of features |
num_obs | number of emission scores per feature and state |
Implements CStateModel.
Definition at line 224 of file TwoStateModel.cpp.
|
inherited |
io
Definition at line 537 of file SGObject.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.
|
inherited |
model selection parameters
Definition at line 549 of file SGObject.h.
|
protectedinherited |
the number of states
Definition at line 219 of file StateModel.h.
|
protectedinherited |
the number of transmission parameters
Definition at line 222 of file StateModel.h.
the distribution of start states
Definition at line 228 of file StateModel.h.
|
inherited |
parameters
Definition at line 546 of file SGObject.h.
the distribution of stop states
Definition at line 231 of file StateModel.h.
state loss matrix, loss for every pair of states
Definition at line 225 of file StateModel.h.
|
inherited |
parallel
Definition at line 540 of file SGObject.h.
|
inherited |
version
Definition at line 543 of file SGObject.h.