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
CGaussianNaiveBayes Class Reference

Detailed Description

Class GaussianNaiveBayes, a Gaussian Naive Bayes classifier.

This classifier assumes that a posteriori conditional probabilities are gaussian pdfs. For each vector gaussian naive bayes chooses the class C with maximal

\[ P(c) \prod_{i} P(x_i|c) \]

Definition at line 37 of file GaussianNaiveBayes.h.

Inheritance diagram for CGaussianNaiveBayes:
[legend]

Public Member Functions

 CGaussianNaiveBayes ()
 
 CGaussianNaiveBayes (CFeatures *train_examples, CLabels *train_labels)
 
virtual ~CGaussianNaiveBayes ()
 
virtual void set_features (CFeatures *features)
 
virtual CFeatures * get_features ()
 
virtual CMulticlassLabels * apply_multiclass (CFeatures *data=NULL)
 
virtual float64_t apply_one (int32_t idx)
 
virtual const char * get_name () const
 
virtual EMachineType get_classifier_type ()
 
virtual void set_labels (CLabels *lab)
 
bool set_machine (int32_t num, CMachine *machine)
 
CMachine * get_machine (int32_t num) const
 
virtual CBinaryLabels * get_submachine_outputs (int32_t i)
 
virtual float64_t get_submachine_output (int32_t i, int32_t num)
 
virtual CMultilabelLabels * apply_multilabel_output (CFeatures *data=NULL, int32_t n_outputs=5)
 
CMulticlassStrategy * get_multiclass_strategy () const
 
CRejectionStrategy * get_rejection_strategy () const
 
void set_rejection_strategy (CRejectionStrategy *rejection_strategy)
 
EProbHeuristicType get_prob_heuris ()
 
void set_prob_heuris (EProbHeuristicType prob_heuris)
 
int32_t get_num_machines () const
 
virtual EProblemType get_machine_problem_type () const
 
virtual bool is_label_valid (CLabels *lab) const
 
virtual bool train (CFeatures *data=NULL)
 
virtual CLabels * apply (CFeatures *data=NULL)
 
virtual CBinaryLabels * apply_binary (CFeatures *data=NULL)
 
virtual CRegressionLabels * apply_regression (CFeatures *data=NULL)
 
virtual CStructuredLabels * apply_structured (CFeatures *data=NULL)
 
virtual CLatentLabels * apply_latent (CFeatures *data=NULL)
 
virtual CLabels * get_labels ()
 
void set_max_train_time (float64_t t)
 
float64_t get_max_train_time ()
 
void set_solver_type (ESolverType st)
 
ESolverType get_solver_type ()
 
virtual void set_store_model_features (bool store_model)
 
virtual bool train_locked (SGVector< index_t > indices)
 
virtual CLabels * apply_locked (SGVector< index_t > indices)
 
virtual CBinaryLabels * apply_locked_binary (SGVector< index_t > indices)
 
virtual CRegressionLabels * apply_locked_regression (SGVector< index_t > indices)
 
virtual CMulticlassLabels * apply_locked_multiclass (SGVector< index_t > indices)
 
virtual CStructuredLabels * apply_locked_structured (SGVector< index_t > indices)
 
virtual CLatentLabels * apply_locked_latent (SGVector< index_t > indices)
 
virtual void data_lock (CLabels *labs, CFeatures *features)
 
virtual void post_lock (CLabels *labs, CFeatures *features)
 
virtual void data_unlock ()
 
virtual bool supports_locking () const
 
bool is_data_locked () 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 bool train_machine (CFeatures *data=NULL)
 
void init_strategy ()
 
void clear_machines ()
 
virtual bool init_machine_for_train (CFeatures *data)
 
virtual bool init_machines_for_apply (CFeatures *data)
 
virtual bool is_ready ()
 
virtual CMachine * get_machine_from_trained (CMachine *machine)
 
virtual int32_t get_num_rhs_vectors ()
 
virtual void add_machine_subset (SGVector< index_t > subset)
 
virtual void remove_machine_subset ()
 
virtual bool is_acceptable_machine (CMachine *machine)
 
virtual void store_model_features ()
 
virtual bool train_require_labels () const
 
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

CDotFeatures * m_features
 features for training or classifying More...
 
int32_t m_min_label
 minimal label More...
 
int32_t m_num_classes
 number of different classes (labels) More...
 
int32_t m_dim
 dimensionality of feature space More...
 
SGMatrix< float64_t > m_means
 means for normal distributions of features More...
 
SGMatrix< float64_t > m_variances
 variances for normal distributions of features More...
 
SGVector< float64_t > m_label_prob
 a priori probabilities of labels More...
 
SGVector< float64_t > m_rates
 label rates More...
 
CMulticlassStrategy * m_multiclass_strategy
 
CMachine * m_machine
 
CDynamicObjectArray * m_machines
 
float64_t m_max_train_time
 
CLabels * m_labels
 
ESolverType m_solver_type
 
bool m_store_model_features
 
bool m_data_locked
 

Constructor & Destructor Documentation

CGaussianNaiveBayes ( )

default constructor

Definition at line 21 of file GaussianNaiveBayes.cpp.

CGaussianNaiveBayes ( CFeatures *  train_examples,
CLabels *  train_labels 
)

constructor

Parameters
train_examplestrain examples
train_labelslabels corresponding to train_examples

Definition at line 28 of file GaussianNaiveBayes.cpp.

~CGaussianNaiveBayes ( )
virtual

destructor

Definition at line 42 of file GaussianNaiveBayes.cpp.

Member Function Documentation

virtual void add_machine_subset ( SGVector< index_t >  subset)
protectedvirtualinherited

set subset to the features of the machine, deletes old one

Parameters
subsetsubset indices to set

Implements CMulticlassMachine.

Definition at line 68 of file NativeMulticlassMachine.h.

CLabels * apply ( CFeatures *  data = NULL)
virtualinherited

apply machine to data if data is not specified apply to the current features

Parameters
data(test)data to be classified
Returns
classified labels

Definition at line 152 of file Machine.cpp.

CBinaryLabels * apply_binary ( CFeatures *  data = NULL)
virtualinherited

apply machine to data in means of binary classification problem

Reimplemented in CKernelMachine, COnlineLinearMachine, CNeuralNetwork, CLinearMachine, CGaussianProcessClassification, CDomainAdaptationSVMLinear, CDomainAdaptationSVM, CPluginEstimate, and CBaggingMachine.

Definition at line 208 of file Machine.cpp.

CLatentLabels * apply_latent ( CFeatures *  data = NULL)
virtualinherited

apply machine to data in means of latent problem

Reimplemented in CLinearLatentMachine.

Definition at line 232 of file Machine.cpp.

CLabels * apply_locked ( SGVector< index_t >  indices)
virtualinherited

Applies a locked machine on a set of indices. Error if machine is not locked

Parameters
indicesindex vector (of locked features) that is predicted

Definition at line 187 of file Machine.cpp.

CBinaryLabels * apply_locked_binary ( SGVector< index_t >  indices)
virtualinherited

applies a locked machine on a set of indices for binary problems

Reimplemented in CKernelMachine.

Definition at line 238 of file Machine.cpp.

CLatentLabels * apply_locked_latent ( SGVector< index_t >  indices)
virtualinherited

applies a locked machine on a set of indices for latent problems

Definition at line 266 of file Machine.cpp.

CMulticlassLabels * apply_locked_multiclass ( SGVector< index_t >  indices)
virtualinherited

applies a locked machine on a set of indices for multiclass problems

Definition at line 252 of file Machine.cpp.

CRegressionLabels * apply_locked_regression ( SGVector< index_t >  indices)
virtualinherited

applies a locked machine on a set of indices for regression problems

Reimplemented in CKernelMachine.

Definition at line 245 of file Machine.cpp.

CStructuredLabels * apply_locked_structured ( SGVector< index_t >  indices)
virtualinherited

applies a locked machine on a set of indices for structured problems

Definition at line 259 of file Machine.cpp.

CMulticlassLabels * apply_multiclass ( CFeatures *  data = NULL)
virtual

classify specified examples

Parameters
dataexamples to be classified
Returns
labels corresponding to data

Reimplemented from CMulticlassMachine.

Definition at line 175 of file GaussianNaiveBayes.cpp.

CMultilabelLabels * apply_multilabel_output ( CFeatures *  data = NULL,
int32_t  n_outputs = 5 
)
virtualinherited

classify all examples with multiple output

Returns
resulting labels

Definition at line 195 of file MulticlassMachine.cpp.

float64_t apply_one ( int32_t  idx)
virtual

classifiy specified example

Parameters
idxexample index
Returns
label

Reimplemented from CMulticlassMachine.

Definition at line 199 of file GaussianNaiveBayes.cpp.

CRegressionLabels * apply_regression ( CFeatures *  data = NULL)
virtualinherited

apply machine to data in means of regression problem

Reimplemented in CKernelMachine, COnlineLinearMachine, CNeuralNetwork, CLinearMachine, CCHAIDTree, CStochasticGBMachine, CCARTree, CGaussianProcessRegression, and CBaggingMachine.

Definition at line 214 of file Machine.cpp.

CStructuredLabels * apply_structured ( CFeatures *  data = NULL)
virtualinherited

apply machine to data in means of SO classification problem

Reimplemented in CLinearStructuredOutputMachine.

Definition at line 226 of file Machine.cpp.

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.

void clear_machines ( )
protectedinherited

clear machines

Definition at line 47 of file NativeMulticlassMachine.h.

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.

void data_lock ( CLabels *  labs,
CFeatures *  features 
)
virtualinherited

Locks the machine on given labels and data. After this call, only train_locked and apply_locked may be called

Only possible if supports_locking() returns true

Parameters
labslabels used for locking
featuresfeatures used for locking

Reimplemented in CKernelMachine.

Definition at line 112 of file Machine.cpp.

void data_unlock ( )
virtualinherited

Unlocks a locked machine and restores previous state

Reimplemented in CKernelMachine.

Definition at line 143 of file Machine.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.

virtual EMachineType get_classifier_type ( )
virtual

get classifier type

Returns
classifier type

Reimplemented from CMachine.

Definition at line 89 of file GaussianNaiveBayes.h.

CFeatures * get_features ( )
virtual

get features for classify

Returns
current features

Definition at line 47 of file GaussianNaiveBayes.cpp.

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.

CLabels * get_labels ( )
virtualinherited

get labels

Returns
labels

Definition at line 76 of file Machine.cpp.

CMachine* get_machine ( int32_t  num) const
inherited

get machine

Parameters
numindex of machine to get
Returns
SVM at number num

Definition at line 74 of file MulticlassMachine.h.

virtual CMachine* get_machine_from_trained ( CMachine *  machine)
protectedvirtualinherited

obtain machine from trained one

Implements CMulticlassMachine.

Definition at line 59 of file NativeMulticlassMachine.h.

EProblemType get_machine_problem_type ( ) const
virtualinherited

get problem type

Reimplemented from CMachine.

Reimplemented in CCHAIDTree, and CCARTree.

Definition at line 32 of file BaseMulticlassMachine.cpp.

float64_t get_max_train_time ( )
inherited

get maximum training time

Returns
maximum training time

Definition at line 87 of file Machine.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.

CMulticlassStrategy* get_multiclass_strategy ( ) const
inherited

get the type of multiclass'ness

Returns
multiclass type one vs one etc

Definition at line 114 of file MulticlassMachine.h.

virtual const char* get_name ( ) const
virtual

get name

Returns
classifier name

Reimplemented from CNativeMulticlassMachine.

Definition at line 84 of file GaussianNaiveBayes.h.

int32_t get_num_machines ( ) const
inherited

get number of machines

Returns
number of machines

Definition at line 27 of file BaseMulticlassMachine.cpp.

virtual int32_t get_num_rhs_vectors ( )
protectedvirtualinherited

get num rhs vectors

Implements CMulticlassMachine.

Definition at line 62 of file NativeMulticlassMachine.h.

EProbHeuristicType get_prob_heuris ( )
inherited

get prob output heuristic of multiclass strategy

Definition at line 145 of file MulticlassMachine.h.

CRejectionStrategy* get_rejection_strategy ( ) const
inherited

returns rejection strategy

Returns
rejection strategy

Definition at line 124 of file MulticlassMachine.h.

ESolverType get_solver_type ( )
inherited

get solver type

Returns
solver

Definition at line 102 of file Machine.cpp.

float64_t get_submachine_output ( int32_t  i,
int32_t  num 
)
virtualinherited

get output of i-th submachine for num-th vector

Parameters
inumber of submachine
numnumber of feature vector
Returns
output

Definition at line 80 of file MulticlassMachine.cpp.

CBinaryLabels * get_submachine_outputs ( int32_t  i)
virtualinherited

get outputs of i-th submachine

Parameters
inumber of submachine
Returns
outputs

Reimplemented in CDomainAdaptationMulticlassLibLinear.

Definition at line 71 of file MulticlassMachine.cpp.

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.

virtual bool init_machine_for_train ( CFeatures *  data)
protectedvirtualinherited

abstract init machine for training method

Implements CMulticlassMachine.

Definition at line 50 of file NativeMulticlassMachine.h.

virtual bool init_machines_for_apply ( CFeatures *  data)
protectedvirtualinherited

abstract init machines for applying method

Implements CMulticlassMachine.

Definition at line 53 of file NativeMulticlassMachine.h.

void init_strategy ( )
protectedinherited

init strategy

Definition at line 44 of file NativeMulticlassMachine.h.

virtual bool is_acceptable_machine ( CMachine *  machine)
protectedvirtualinherited

whether the machine is acceptable in set_machine

Reimplemented from CMulticlassMachine.

Definition at line 74 of file NativeMulticlassMachine.h.

bool is_data_locked ( ) const
inherited
Returns
whether this machine is locked

Definition at line 296 of file Machine.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 is_label_valid ( CLabels *  lab) const
virtualinherited

check whether the labels is valid.

Parameters
labthe labels being checked, guaranteed to be non-NULL

Reimplemented from CMachine.

Reimplemented in CCARTree, and CCHAIDTree.

Definition at line 37 of file BaseMulticlassMachine.cpp.

virtual bool is_ready ( )
protectedvirtualinherited

check whether machine is ready

Implements CMulticlassMachine.

Definition at line 56 of file NativeMulticlassMachine.h.

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.

virtual void post_lock ( CLabels *  labs,
CFeatures *  features 
)
virtualinherited

post lock

Definition at line 287 of file Machine.h.

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.

virtual void remove_machine_subset ( )
protectedvirtualinherited

deletes any subset set to the features of the machine

Implements CMulticlassMachine.

Definition at line 71 of file NativeMulticlassMachine.h.

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_features ( CFeatures *  features)
virtual

set features for classify

Parameters
featuresfeatures to be set

Definition at line 53 of file GaussianNaiveBayes.cpp.

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_labels ( CLabels *  lab)
virtualinherited

set labels

Parameters
lablabels

Reimplemented from CMachine.

Definition at line 52 of file MulticlassMachine.cpp.

bool set_machine ( int32_t  num,
CMachine *  machine 
)
inherited

set machine

Parameters
numindex of machine
machinemachine to set
Returns
if setting was successful

Definition at line 59 of file MulticlassMachine.h.

void set_max_train_time ( float64_t  t)
inherited

set maximum training time

Parameters
tmaximimum training time

Definition at line 82 of file Machine.cpp.

void set_prob_heuris ( EProbHeuristicType  prob_heuris)
inherited

set prob output heuristic of multiclass strategy

Parameters
prob_heuristype of probability heuristic

Definition at line 153 of file MulticlassMachine.h.

void set_rejection_strategy ( CRejectionStrategy *  rejection_strategy)
inherited

sets rejection strategy

Parameters
rejection_strategyrejection strategy to be set

Definition at line 133 of file MulticlassMachine.h.

void set_solver_type ( ESolverType  st)
inherited

set solver type

Parameters
stsolver type

Definition at line 97 of file Machine.cpp.

void set_store_model_features ( bool  store_model)
virtualinherited

Setter for store-model-features-after-training flag

Parameters
store_modelwhether model should be stored after training

Definition at line 107 of file Machine.cpp.

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 void store_model_features ( )
protectedvirtualinherited

Stores feature data of underlying model. After this method has been called, it is possible to change the machine's feature data and call apply(), which is then performed on the training feature data that is part of the machine's model.

Base method, has to be implemented in order to allow cross-validation and model selection.

NOT IMPLEMENTED! Has to be done in subclasses

Reimplemented in CKernelMachine, CKNN, CLinearMachine, CLinearMulticlassMachine, CKMeansBase, CTreeMachine< T >, CTreeMachine< ConditionalProbabilityTreeNodeData >, CTreeMachine< RelaxedTreeNodeData >, CTreeMachine< id3TreeNodeData >, CTreeMachine< VwConditionalProbabilityTreeNodeData >, CTreeMachine< CARTreeNodeData >, CTreeMachine< C45TreeNodeData >, CTreeMachine< CHAIDTreeNodeData >, CTreeMachine< NbodyTreeNodeData >, CGaussianProcessMachine, CHierarchical, CDistanceMachine, CKernelMulticlassMachine, and CLinearStructuredOutputMachine.

Definition at line 335 of file Machine.h.

virtual bool supports_locking ( ) const
virtualinherited
Returns
whether this machine supports locking

Reimplemented in CKernelMachine.

Definition at line 293 of file Machine.h.

bool train ( CFeatures *  data = NULL)
virtualinherited

train machine

Parameters
datatraining data (parameter can be avoided if distance or kernel-based classifiers are used and distance/kernels are initialized with train data). If flag is set, model features will be stored after training.
Returns
whether training was successful

Reimplemented in CRelaxedTree, CAutoencoder, CLinearMachine, CSGDQN, and COnlineSVMSGD.

Definition at line 39 of file Machine.cpp.

virtual bool train_locked ( SGVector< index_t >  indices)
virtualinherited

Trains a locked machine on a set of indices. Error if machine is not locked

NOT IMPLEMENTED

Parameters
indicesindex vector (of locked features) that is used for training
Returns
whether training was successful

Reimplemented in CKernelMachine.

Definition at line 239 of file Machine.h.

bool train_machine ( CFeatures *  data = NULL)
protectedvirtual

train classifier

Parameters
datatrain examples
Returns
true if successful

Reimplemented from CMulticlassMachine.

Definition at line 63 of file GaussianNaiveBayes.cpp.

virtual bool train_require_labels ( ) const
protectedvirtualinherited

returns whether machine require labels for training

Reimplemented in COnlineLinearMachine, CKMeansBase, CHierarchical, CLinearLatentMachine, CVwConditionalProbabilityTree, CConditionalProbabilityTree, and CLibSVMOneClass.

Definition at line 354 of file Machine.h.

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.

bool m_data_locked
protectedinherited

whether data is locked

Definition at line 370 of file Machine.h.

int32_t m_dim
protected

dimensionality of feature space

Definition at line 111 of file GaussianNaiveBayes.h.

CDotFeatures* m_features
protected

features for training or classifying

Definition at line 102 of file GaussianNaiveBayes.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.

SGVector<float64_t> m_label_prob
protected

a priori probabilities of labels

Definition at line 120 of file GaussianNaiveBayes.h.

CLabels* m_labels
protectedinherited

labels

Definition at line 361 of file Machine.h.

CMachine* m_machine
protectedinherited

machine

Definition at line 208 of file MulticlassMachine.h.

CDynamicObjectArray* m_machines
protectedinherited

machines

Definition at line 56 of file BaseMulticlassMachine.h.

float64_t m_max_train_time
protectedinherited

maximum training time

Definition at line 358 of file Machine.h.

SGMatrix<float64_t> m_means
protected

means for normal distributions of features

Definition at line 114 of file GaussianNaiveBayes.h.

int32_t m_min_label
protected

minimal label

Definition at line 105 of file GaussianNaiveBayes.h.

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 549 of file SGObject.h.

CMulticlassStrategy* m_multiclass_strategy
protectedinherited

type of multiclass strategy

Definition at line 205 of file MulticlassMachine.h.

int32_t m_num_classes
protected

number of different classes (labels)

Definition at line 108 of file GaussianNaiveBayes.h.

Parameter* m_parameters
inherited

parameters

Definition at line 546 of file SGObject.h.

SGVector<float64_t> m_rates
protected

label rates

Definition at line 123 of file GaussianNaiveBayes.h.

ESolverType m_solver_type
protectedinherited

solver type

Definition at line 364 of file Machine.h.

bool m_store_model_features
protectedinherited

whether model features should be stored after training

Definition at line 367 of file Machine.h.

SGMatrix<float64_t> m_variances
protected

variances for normal distributions of features

Definition at line 117 of file GaussianNaiveBayes.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