SHOGUN  4.1.0
 全部 类 命名空间 文件 函数 变量 类型定义 枚举 枚举值 友元 宏定义 组 页
所有成员列表 | Public 成员函数 | Public 属性 | Protected 成员函数 | Protected 属性
CStateModel类 参考abstract

详细描述

class CStateModel base, abstract class for the internal state representation used in the CHMSVMModel.

在文件 StateModel.h 第 30 行定义.

类 CStateModel 继承关系图:
Inheritance graph
[图例]

Public 成员函数

 CStateModel ()
 
virtual ~CStateModel ()
 
int32_t get_num_states () const
 
int32_t get_num_transmission_params () const
 
virtual SGMatrix< float64_t > loss_matrix (CSequence *label_seq)=0
 
virtual float64_t loss (CSequence *label_seq_lhs, CSequence *label_seq_rhs)=0
 
virtual void reshape_emission_params (SGVector< float64_t > &emission_weights, SGVector< float64_t > w, int32_t num_feats, int32_t num_obs)=0
 
virtual void reshape_emission_params (CDynamicObjectArray *plif_matrix, SGVector< float64_t > w, int32_t num_feats, int32_t num_plif_nodes)=0
 
virtual void reshape_transmission_params (SGMatrix< float64_t > &transmission_weights, SGVector< float64_t > w)=0
 
virtual SGVector< int32_t > labels_to_states (CSequence *label_seq) const =0
 
virtual CSequence * states_to_labels (SGVector< int32_t > state_seq) const =0
 
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 =0
 
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 =0
 
virtual SGVector< int32_t > get_monotonicity (int32_t num_free_states, int32_t num_feats) const
 
SGVector< float64_t > get_start_states () const
 
SGVector< float64_t > get_stop_states () const
 
virtual const char * get_name () 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 ()
 

Public 属性

SGIO * io
 
Parallel * parallel
 
Version * version
 
Parameter * m_parameters
 
Parameter * m_model_selection_parameters
 
Parameter * m_gradient_parameters
 
uint32_t m_hash
 

Protected 成员函数

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 属性

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
 

构造及析构函数说明

CStateModel ( )

default constructor

在文件 StateModel.cpp 第 15 行定义.

~CStateModel ( )
virtual

destructor

在文件 StateModel.cpp 第 20 行定义.

成员函数说明

void build_gradient_parameter_dictionary ( CMap< TParameter *, CSGObject * > *  dict)
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.

参数
dictdictionary of parameters to be built.

在文件 SGObject.cpp 第 597 行定义.

CSGObject * clone ( )
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.

返回
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 行定义.

CSGObject * deep_copy ( ) const
virtualinherited

A deep copy. All the instance variables will also be copied.

在文件 SGObject.cpp 第 198 行定义.

bool equals ( CSGObject *  other,
float64_t  accuracy = 0.0,
bool  tolerant = false 
)
virtualinherited

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.

参数
otherobject to compare with
accuracyaccuracy to use for comparison (optional)
tolerantallows linient check on float equality (within accuracy)
返回
true if all parameters were equal, false if not

在文件 SGObject.cpp 第 618 行定义.

SGIO * get_global_io ( )
inherited

get the io object

返回
io object

在文件 SGObject.cpp 第 235 行定义.

Parallel * get_global_parallel ( )
inherited

get the parallel object

返回
parallel object

在文件 SGObject.cpp 第 277 行定义.

Version * get_global_version ( )
inherited

get the version object

返回
version object

在文件 SGObject.cpp 第 290 行定义.

SGStringList< char > get_modelsel_names ( )
inherited
返回
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_namename 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_namename of model selection parameter
返回
index of model selection parameter with provided name, -1 if there is no such

在文件 SGObject.cpp 第 535 行定义.

SGVector< int32_t > get_monotonicity ( int32_t  num_free_states,
int32_t  num_feats 
) const
virtual

specify monotonicity constraints for feature scoring functions. The elements of the vector returned can take one of three values:

  • +1 if monotonically increasing scoring function
  • -1 if monotonically decreasing scoring function
  • 0 if no constraint in the monotonicity

By default, this method returns a vector of zeros (no monotonicity constraints). Re-implement this method in a child class to specify constraints.

参数
num_free_statesnumber of states whose parameters are learnt
num_featsnumber of features
返回
vector with monotonicity constraints of length num_feats times num_free_states

被 CTwoStateModel 重载.

在文件 StateModel.cpp 第 48 行定义.

virtual const char* get_name ( ) const
virtual
返回
name of SGSerializable

实现了 CSGObject.

被 CTwoStateModel 重载.

在文件 StateModel.h 第 211 行定义.

int32_t get_num_states ( ) const
返回
number of states

在文件 StateModel.cpp 第 24 行定义.

int32_t get_num_transmission_params ( ) const
返回
number of transmission parameters to be learnt

在文件 StateModel.cpp 第 29 行定义.

SGVector< float64_t > get_start_states ( ) const

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:

  • -INFTY if the state is not allowed to be a start state
  • 0 otherwise

The distrubtion of start states m_p must be initialized in the constructor of CStateModel's child classes.

返回
the distribution of start states m_p, vector of m_num_states elements

在文件 StateModel.cpp 第 56 行定义.

SGVector< float64_t > get_stop_states ( ) const

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:

  • -INFTY if the state is not allowed to be a stop state
  • 0 otherwise

The distrubtion of stop states m_q must be initialized in the constructor of CStateModel's child classes.

返回
the distribution of start states m_p, vector of m_num_states elements

在文件 StateModel.cpp 第 61 行定义.

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.

参数
genericset to the type of the generic if returning TRUE
返回
TRUE if a class template.

在文件 SGObject.cpp 第 296 行定义.

virtual SGVector< int32_t > labels_to_states ( CSequence *  label_seq) const
pure virtual

translates label sequence to state sequence

参数
label_seqlabel sequence
返回
state sequence

在 CTwoStateModel 内被实现.

bool load_serializable ( CSerializableFile *  file,
const char *  prefix = "" 
)
virtualinherited

Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!

参数
filewhere to load from
prefixprefix for members
返回
TRUE if done, otherwise FALSE

在文件 SGObject.cpp 第 369 行定义.

void load_serializable_post ( )
throw (ShogunException
)
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.

异常
ShogunExceptionwill be thrown if an error occurs.

被 CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel , 以及 CExponentialKernel 重载.

在文件 SGObject.cpp 第 426 行定义.

void load_serializable_pre ( )
throw (ShogunException
)
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.

异常
ShogunExceptionwill be thrown if an error occurs.

被 CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.

在文件 SGObject.cpp 第 421 行定义.

virtual float64_t loss ( CSequence *  label_seq_lhs,
CSequence *  label_seq_rhs 
)
pure virtual

computes the loss between two sequences of labels using the Hamming loss and the state loss matrix

参数
label_seq_lhsone label sequence
label_seq_rhsother label sequence
返回
the Hamming loss

在 CTwoStateModel 内被实现.

virtual SGMatrix< float64_t > loss_matrix ( CSequence *  label_seq)
pure virtual

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_seqlabel sequence (normally the true label sequence)
返回
the loss matrix

在 CTwoStateModel 内被实现.

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

prints registered parameters out

参数
prefixprefix for members

在文件 SGObject.cpp 第 308 行定义.

virtual void reshape_emission_params ( SGVector< float64_t > &  emission_weights,
SGVector< float64_t >  w,
int32_t  num_feats,
int32_t  num_obs 
)
pure virtual

arranges the emission parameters 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_weightsemission parameters outputted
wthe weight vector
num_featsnumber of features
num_obsnumber of emission scores per feature and state

在 CTwoStateModel 内被实现.

virtual void reshape_emission_params ( CDynamicObjectArray *  plif_matrix,
SGVector< float64_t >  w,
int32_t  num_feats,
int32_t  num_plif_nodes 
)
pure 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_matrixmatrix of PLiFs outputted
wthe weight vector
num_featsnumber of features
num_plif_nodesnumber of nodes in the PLiFs

在 CTwoStateModel 内被实现.

virtual void reshape_transmission_params ( SGMatrix< float64_t > &  transmission_weights,
SGVector< float64_t >  w 
)
pure 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_weightstransmission parameters outputted
wthe weight vector

在 CTwoStateModel 内被实现.

bool save_serializable ( CSerializableFile *  file,
const char *  prefix = "" 
)
virtualinherited

Save this object to file.

参数
filewhere to save the object; will be closed during returning if PREFIX is an empty string.
prefixprefix for members
返回
TRUE if done, otherwise FALSE

在文件 SGObject.cpp 第 314 行定义.

void save_serializable_post ( )
throw (ShogunException
)
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.

异常
ShogunExceptionwill be thrown if an error occurs.

被 CKernel 重载.

在文件 SGObject.cpp 第 436 行定义.

void save_serializable_pre ( )
throw (ShogunException
)
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.

异常
ShogunExceptionwill 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 第 431 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 41 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 46 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 51 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 56 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 61 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 66 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 71 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 76 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 81 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 86 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 91 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 96 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 101 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 106 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 111 行定义.

void set_generic ( )
inherited

set generic type to T

void set_global_io ( SGIO *  io)
inherited

set the io object

参数
ioio object to use

在文件 SGObject.cpp 第 228 行定义.

void set_global_parallel ( Parallel *  parallel)
inherited

set the parallel object

参数
parallelparallel object to use

在文件 SGObject.cpp 第 241 行定义.

void set_global_version ( Version *  version)
inherited

set the version object

参数
versionversion object to use

在文件 SGObject.cpp 第 283 行定义.

CSGObject * shallow_copy ( ) const
virtualinherited

A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.

被 CGaussianKernel 重载.

在文件 SGObject.cpp 第 192 行定义.

virtual CSequence* states_to_labels ( SGVector< int32_t >  state_seq) const
pure virtual

translates state sequence to label sequence

参数
state_seqstate sequence
返回
label sequence

在 CTwoStateModel 内被实现.

void unset_generic ( )
inherited

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 行定义.

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
pure 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

参数
psioutput vector
transmission_weightscounts of the state transitions for a state sequence
emission_weightscounts of the emission scores for a state sequence and a feature vector
num_featsnumber of features
num_obsnumber of emission scores per feature and state

在 CTwoStateModel 内被实现.

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
pure 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_weightscounts of the state transitions for a state sequence
emission_weightscounts of the emission scores for a state sequence and a feature vector
num_featsnumber of features
num_obsnumber of emission scores per feature and state
返回
psi output vector

在 CTwoStateModel 内被实现.

类成员变量说明

SGIO* io
inherited

io

在文件 SGObject.h 第 369 行定义.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

在文件 SGObject.h 第 384 行定义.

uint32_t m_hash
inherited

Hash of parameter values

在文件 SGObject.h 第 387 行定义.

Parameter* m_model_selection_parameters
inherited

model selection parameters

在文件 SGObject.h 第 381 行定义.

int32_t m_num_states
protected

the number of states

在文件 StateModel.h 第 219 行定义.

int32_t m_num_transmission_params
protected

the number of transmission parameters

在文件 StateModel.h 第 222 行定义.

SGVector< float64_t > m_p
protected

the distribution of start states

在文件 StateModel.h 第 228 行定义.

Parameter* m_parameters
inherited

parameters

在文件 SGObject.h 第 378 行定义.

SGVector< float64_t > m_q
protected

the distribution of stop states

在文件 StateModel.h 第 231 行定义.

SGMatrix< float64_t > m_state_loss_mat
protected

state loss matrix, loss for every pair of states

在文件 StateModel.h 第 225 行定义.

Parallel* parallel
inherited

parallel

在文件 SGObject.h 第 372 行定义.

Version* version
inherited

version

在文件 SGObject.h 第 375 行定义.

该类的文档由以下文件生成:
SHOGUN 机器学习工具包 - 项目文档