SHOGUN  4.2.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
List of all members | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
CMulticlassOneVsRestStrategy Class Reference

Detailed Description

multiclass one vs rest strategy used to train generic multiclass machines for K-class problems with building ensemble of K binary classifiers

multiclass probabilistic outputs can be obtained by using the heuristics described in [1]

[1] J. Milgram, M. Cheriet, R.Sabourin, "One Against One" or "One Against One": Which One is Better for Handwriting Recognition with SVMs?

Definition at line 33 of file MulticlassOneVsRestStrategy.h.

Inheritance diagram for CMulticlassOneVsRestStrategy:
[legend]

Public Member Functions

 CMulticlassOneVsRestStrategy ()
 
 CMulticlassOneVsRestStrategy (EProbHeuristicType prob_heuris)
 
virtual ~CMulticlassOneVsRestStrategy ()
 
virtual void train_start (CMulticlassLabels *orig_labels, CBinaryLabels *train_labels)
 
virtual bool train_has_more ()
 
virtual SGVector< int32_t > train_prepare_next ()
 
virtual int32_t decide_label (SGVector< float64_t > outputs)
 
virtual SGVector< index_tdecide_label_multiple_output (SGVector< float64_t > outputs, int32_t n_outputs)
 
virtual int32_t get_num_machines ()
 
virtual const char * get_name () const
 
virtual void rescale_outputs (SGVector< float64_t > outputs)
 
virtual void rescale_outputs (SGVector< float64_t > outputs, const SGVector< float64_t > As, const SGVector< float64_t > Bs)
 
void set_num_classes (int32_t num_classes)
 
int32_t get_num_classes () const
 
CRejectionStrategyget_rejection_strategy ()
 
void set_rejection_strategy (CRejectionStrategy *rejection_strategy)
 
virtual void train_stop ()
 
EProbHeuristicType get_prob_heuris_type ()
 
void set_prob_heuris_type (EProbHeuristicType prob_heuris)
 
virtual CSGObjectshallow_copy () const
 
virtual CSGObjectdeep_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)
 
SGIOget_global_io ()
 
void set_global_parallel (Parallel *parallel)
 
Parallelget_global_parallel ()
 
void set_global_version (Version *version)
 
Versionget_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 >
get (const Tag< T > &_tag) const
 
template<typename T , typename U = void>
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 CSGObjectclone ()
 

Public Attributes

SGIOio
 
Parallelparallel
 
Versionversion
 
Parameterm_parameters
 
Parameterm_model_selection_parameters
 
Parameterm_gradient_parameters
 
uint32_t m_hash
 

Protected Member Functions

void rescale_heuris_norm (SGVector< float64_t > outputs)
 
void rescale_heuris_softmax (SGVector< float64_t > outputs, const SGVector< float64_t > As, const SGVector< float64_t > Bs)
 
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

CRejectionStrategym_rejection_strategy
 rejection strategy More...
 
CBinaryLabelsm_train_labels
 labels used to train the submachines More...
 
CMulticlassLabelsm_orig_labels
 original multiclass labels More...
 
int32_t m_train_iter
 index of current iterations More...
 
int32_t m_num_classes
 number of classes in this problem More...
 
EProbHeuristicType m_prob_heuris
 prob output heuristic More...
 

Constructor & Destructor Documentation

constructor

Definition at line 18 of file MulticlassOneVsRestStrategy.cpp.

constructor

Parameters
prob_heurisprobability estimation heuristic

Definition at line 23 of file MulticlassOneVsRestStrategy.cpp.

virtual ~CMulticlassOneVsRestStrategy ( )
virtual

destructor

Definition at line 45 of file MulticlassOneVsRestStrategy.h.

Member Function Documentation

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.

Parameters
dictdictionary of parameters to be built.

Definition at line 630 of file SGObject.cpp.

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.

Returns
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

Definition at line 747 of file SGObject.cpp.

int32_t decide_label ( SGVector< float64_t outputs)
virtual

decide the final label.

Parameters
outputsa vector of output from each machine (in that order)

Implements CMulticlassStrategy.

Definition at line 44 of file MulticlassOneVsRestStrategy.cpp.

SGVector< index_t > decide_label_multiple_output ( SGVector< float64_t outputs,
int32_t  n_outputs 
)
virtual

decide the final label.

Parameters
outputsa vector of output from each machine (in that order)
n_outputsnumber of outputs

Reimplemented from CMulticlassStrategy.

Definition at line 52 of file MulticlassOneVsRestStrategy.cpp.

CSGObject * deep_copy ( ) const
virtualinherited

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

Definition at line 231 of file SGObject.cpp.

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.

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

Definition at line 651 of file SGObject.cpp.

T get ( const Tag< T > &  _tag) const
inherited

Getter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.

Parameters
_tagname and type information of parameter
Returns
value of the parameter identified by the input tag

Definition at line 367 of file SGObject.h.

T get ( const std::string &  name) const
inherited

Getter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.

Parameters
namename of the parameter
Returns
value of the parameter corresponding to the input name and type

Definition at line 388 of file SGObject.h.

SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 268 of file SGObject.cpp.

Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 310 of file SGObject.cpp.

Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 323 of file SGObject.cpp.

SGStringList< char > get_modelsel_names ( )
inherited
Returns
vector of names of all parameters which are registered for model selection

Definition at line 531 of file SGObject.cpp.

char * get_modsel_param_descr ( const char *  param_name)
inherited

Returns description of a given parameter string, if it exists. SG_ERROR otherwise

Parameters
param_namename of the parameter
Returns
description of the parameter

Definition at line 555 of file SGObject.cpp.

index_t get_modsel_param_index ( const char *  param_name)
inherited

Returns index of model selection parameter with provided index

Parameters
param_namename of model selection parameter
Returns
index of model selection parameter with provided name, -1 if there is no such

Definition at line 568 of file SGObject.cpp.

virtual const char* get_name ( ) const
virtual

get name

Reimplemented from CMulticlassStrategy.

Definition at line 83 of file MulticlassOneVsRestStrategy.h.

int32_t get_num_classes ( ) const
inherited

get number of classes

Definition at line 76 of file MulticlassStrategy.h.

virtual int32_t get_num_machines ( )
virtual

get number of machines used in this strategy.

Implements CMulticlassStrategy.

Definition at line 77 of file MulticlassOneVsRestStrategy.h.

EProbHeuristicType get_prob_heuris_type ( )
inherited

get prob output heuristic type

Definition at line 130 of file MulticlassStrategy.h.

CRejectionStrategy* get_rejection_strategy ( )
inherited

get rejection strategy

Definition at line 82 of file MulticlassStrategy.h.

bool has ( const std::string &  name) const
inherited

Checks if object has a class parameter identified by a name.

Parameters
namename of the parameter
Returns
true if the parameter exists with the input name

Definition at line 289 of file SGObject.h.

bool has ( const Tag< T > &  tag) const
inherited

Checks if object has a class parameter identified by a Tag.

Parameters
tagtag of the parameter containing name and type information
Returns
true if the parameter exists with the input tag

Definition at line 301 of file SGObject.h.

bool has ( const std::string &  name) const
inherited

Checks if a type exists for a class parameter identified by a name.

Parameters
namename of the parameter
Returns
true if the parameter exists with the input name and type

Definition at line 312 of file SGObject.h.

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.

Parameters
genericset to the type of the generic if returning TRUE
Returns
TRUE if a class template.

Definition at line 329 of file SGObject.cpp.

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!

Parameters
filewhere to load from
prefixprefix for members
Returns
TRUE if done, otherwise FALSE

Definition at line 402 of file SGObject.cpp.

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.

Exceptions
ShogunExceptionwill 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.

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.

Exceptions
ShogunExceptionwill 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.

bool parameter_hash_changed ( )
virtualinherited
Returns
whether parameter combination has changed since last update

Definition at line 295 of file SGObject.cpp.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 507 of file SGObject.cpp.

void print_serializable ( const char *  prefix = "")
virtualinherited

prints registered parameters out

Parameters
prefixprefix for members

Definition at line 341 of file SGObject.cpp.

void register_param ( Tag< T > &  _tag,
const T &  value 
)
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.

Parameters
_tagname and type information of parameter
valuevalue of the parameter

Definition at line 439 of file SGObject.h.

void register_param ( const std::string &  name,
const T &  value 
)
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.

Parameters
namename of the parameter
valuevalue of the parameter along with type information

Definition at line 452 of file SGObject.h.

void rescale_heuris_norm ( SGVector< float64_t outputs)
protected

OVA normalization heuristic

Parameters
outputsa vector of output from each machine (in that order)

Definition at line 97 of file MulticlassOneVsRestStrategy.cpp.

void rescale_heuris_softmax ( SGVector< float64_t outputs,
const SGVector< float64_t As,
const SGVector< float64_t Bs 
)
protected

OVA softmax heuristic

Parameters
outputsa vector of output from each machine (in that order)
Asfitted sigmoid parameters a one for each machine
Bsfitted sigmoid parameters b one for each machine

Definition at line 111 of file MulticlassOneVsRestStrategy.cpp.

void rescale_outputs ( SGVector< float64_t outputs)
virtual

rescale multiclass outputs according to the selected heuristic

Parameters
outputsa vector of output from each machine (in that order)

Reimplemented from CMulticlassStrategy.

Definition at line 70 of file MulticlassOneVsRestStrategy.cpp.

void rescale_outputs ( SGVector< float64_t outputs,
const SGVector< float64_t As,
const SGVector< float64_t Bs 
)
virtual

rescale multiclass outputs according to the selected heuristic this function only being called with OVA_SOFTMAX heuristic

Parameters
outputsa vector of output from each machine (in that order)
Asfitted sigmoid parameters a one for each machine
Bsfitted sigmoid parameters b one for each machine

Reimplemented from CMulticlassStrategy.

Definition at line 88 of file MulticlassOneVsRestStrategy.cpp.

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

Save this object to file.

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

Definition at line 347 of file SGObject.cpp.

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.

Exceptions
ShogunExceptionwill be thrown if an error occurs.

Reimplemented in CKernel.

Definition at line 469 of file SGObject.cpp.

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.

Exceptions
ShogunExceptionwill 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.

void set ( const Tag< T > &  _tag,
const T &  value 
)
inherited

Setter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.

Parameters
_tagname and type information of parameter
valuevalue of the parameter

Definition at line 328 of file SGObject.h.

void set ( const std::string &  name,
const T &  value 
)
inherited

Setter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.

Parameters
namename of the parameter
valuevalue of the parameter along with type information

Definition at line 354 of file SGObject.h.

void set_generic ( )
inherited

Definition at line 74 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 79 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 84 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 89 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 94 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 99 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 104 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 109 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 114 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 119 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 124 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 129 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 134 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 139 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 144 of file SGObject.cpp.

void set_generic ( )
inherited

set generic type to T

void set_global_io ( SGIO io)
inherited

set the io object

Parameters
ioio object to use

Definition at line 261 of file SGObject.cpp.

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 274 of file SGObject.cpp.

void set_global_version ( Version version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 316 of file SGObject.cpp.

void set_num_classes ( int32_t  num_classes)
inherited

set number of classes

Definition at line 70 of file MulticlassStrategy.h.

void set_prob_heuris_type ( EProbHeuristicType  prob_heuris)
inherited

set prob output heuristic type

Parameters
prob_heuristype of probability heuristic

Definition at line 138 of file MulticlassStrategy.h.

void set_rejection_strategy ( CRejectionStrategy rejection_strategy)
inherited

set rejection strategy

Definition at line 89 of file MulticlassStrategy.h.

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

virtual bool train_has_more ( )
virtual

has more training phase

Implements CMulticlassStrategy.

Definition at line 54 of file MulticlassOneVsRestStrategy.h.

SGVector< int32_t > train_prepare_next ( )
virtual

prepare for the next training phase.

Returns
NULL, since no subset is needed in one-vs-rest strategy

Reimplemented from CMulticlassStrategy.

Definition at line 28 of file MulticlassOneVsRestStrategy.cpp.

virtual void train_start ( CMulticlassLabels orig_labels,
CBinaryLabels train_labels 
)
virtual

start training

Reimplemented from CMulticlassStrategy.

Definition at line 48 of file MulticlassOneVsRestStrategy.h.

void train_stop ( )
virtualinherited

finish training, release resources

Definition at line 63 of file MulticlassStrategy.cpp.

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

Definition at line 336 of file SGObject.cpp.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 281 of file SGObject.cpp.

Member Data Documentation

SGIO* io
inherited

io

Definition at line 537 of file SGObject.h.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

Definition at line 552 of file SGObject.h.

uint32_t m_hash
inherited

Hash of parameter values

Definition at line 555 of file SGObject.h.

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 549 of file SGObject.h.

int32_t m_num_classes
protectedinherited

number of classes in this problem

Definition at line 176 of file MulticlassStrategy.h.

CMulticlassLabels* m_orig_labels
protectedinherited

original multiclass labels

Definition at line 174 of file MulticlassStrategy.h.

Parameter* m_parameters
inherited

parameters

Definition at line 546 of file SGObject.h.

EProbHeuristicType m_prob_heuris
protectedinherited

prob output heuristic

Definition at line 177 of file MulticlassStrategy.h.

CRejectionStrategy* m_rejection_strategy
protectedinherited

rejection strategy

Definition at line 172 of file MulticlassStrategy.h.

int32_t m_train_iter
protectedinherited

index of current iterations

Definition at line 175 of file MulticlassStrategy.h.

CBinaryLabels* m_train_labels
protectedinherited

labels used to train the submachines

Definition at line 173 of file MulticlassStrategy.h.

Parallel* parallel
inherited

parallel

Definition at line 540 of file SGObject.h.

Version* version
inherited

version

Definition at line 543 of file SGObject.h.


The documentation for this class was generated from the following files:

SHOGUN Machine Learning Toolbox - Documentation