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

Detailed Description

Binary Labels for binary classification.

valid values for labels are +1/-1

Scores may be converted into calibrated probabilities using scores_to_probabilities(), which implements the method described in Lin, H., Lin, C., and Weng, R. (2007). A note on Platt's probabilistic outputs for support vector machines. Should only be used in conjunction with SVM.

Definition at line 37 of file BinaryLabels.h.

Inheritance diagram for CBinaryLabels:
Inheritance graph
[legend]

Public Member Functions

 CBinaryLabels ()
 
 CBinaryLabels (int32_t num_labels)
 
 CBinaryLabels (SGVector< int32_t > src)
 
 CBinaryLabels (SGVector< int64_t > src)
 
 CBinaryLabels (SGVector< float64_t > src, float64_t threshold=0.0)
 
 CBinaryLabels (CFile *loader)
 
virtual void ensure_valid (const char *context=NULL)
 
virtual ELabelType get_label_type () const
 
void scores_to_probabilities (float64_t a=0, float64_t b=0)
 
virtual const char * get_name () const
 
virtual void load (CFile *loader)
 
virtual void save (CFile *writer)
 
bool set_label (int32_t idx, float64_t label)
 
bool set_int_label (int32_t idx, int32_t label)
 
float64_t get_label (int32_t idx)
 
int32_t get_int_label (int32_t idx)
 
SGVector< float64_t > get_labels ()
 
SGVector< float64_t > get_labels_copy ()
 
void set_labels (SGVector< float64_t > v)
 
void set_to_one ()
 
void zero ()
 
void set_to_const (float64_t c)
 
SGVector< int32_t > get_int_labels ()
 
void set_int_labels (SGVector< int32_t > labels)
 
void set_int_labels (SGVector< int64_t > labels)
 
virtual int32_t get_num_labels () const
 
virtual void add_subset (SGVector< index_t > subset)
 
virtual void add_subset_in_place (SGVector< index_t > subset)
 
virtual void remove_subset ()
 
virtual void remove_all_subsets ()
 
virtual void set_value (float64_t value, int32_t idx)
 
virtual float64_t get_value (int32_t idx)
 
virtual void set_values (SGVector< float64_t > values)
 
virtual SGVector< float64_t > get_values ()
 
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 Attributes

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

Static Public Attributes

static const int32_t REJECTION_LABEL = -2
 

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)
 

Protected Attributes

SGVector< float64_t > m_labels
 
CSubsetStack * m_subset_stack
 
SGVector< float64_t > m_current_values
 

Constructor & Destructor Documentation

CBinaryLabels ( )

default constructor

Definition at line 20 of file BinaryLabels.cpp.

CBinaryLabels ( int32_t  num_labels)

constructor

Parameters
num_labelsnumber of labels

Definition at line 24 of file BinaryLabels.cpp.

CBinaryLabels ( SGVector< int32_t >  src)

constructor sets labels with src elements

Parameters
srclabels to set

Definition at line 29 of file BinaryLabels.cpp.

CBinaryLabels ( SGVector< int64_t >  src)

constructor sets labels with src elements (int64 version)

Parameters
srclabels to set

Definition at line 40 of file BinaryLabels.cpp.

CBinaryLabels ( SGVector< float64_t >  src,
float64_t  threshold = 0.0 
)

constructor sets values from src vector sets labels with sign of src elements with added threshold

Parameters
srclabels to set
thresholdthreshold

Definition at line 52 of file BinaryLabels.cpp.

CBinaryLabels ( CFile *  loader)

constructor

Parameters
loaderFile object via which to load data

Definition at line 63 of file BinaryLabels.cpp.

Member Function Documentation

void add_subset ( SGVector< index_t >  subset)
virtualinherited

Adds a subset of indices on top of the current subsets (possibly subset of subset). Every call causes a new active index vector to be stored. Added subsets can be removed one-by-one. If this is not needed, add_subset_in_place() should be used (does not store intermediate index vectors)

Parameters
subsetsubset of indices to add

Definition at line 39 of file Labels.cpp.

void add_subset_in_place ( SGVector< index_t >  subset)
virtualinherited

Sets/changes latest added subset. This allows to add multiple subsets with in-place memory requirements. They cannot be removed one-by-one afterwards, only the latest active can. If this is needed, use add_subset(). If no subset is active, this just adds.

Parameters
subsetsubset of indices to replace the latest one with.

Definition at line 44 of file Labels.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 597 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 714 of file SGObject.cpp.

CSGObject * deep_copy ( ) const
virtualinherited

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

Definition at line 198 of file SGObject.cpp.

void ensure_valid ( const char *  context = NULL)
virtual

Make sure the label is valid, otherwise raise SG_ERROR.

possible with subset

Parameters
contextoptional message to convey the context

Reimplemented from CDenseLabels.

Definition at line 67 of file BinaryLabels.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 618 of file SGObject.cpp.

SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 235 of file SGObject.cpp.

Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 277 of file SGObject.cpp.

Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 290 of file SGObject.cpp.

int32_t get_int_label ( int32_t  idx)
inherited

get INT label

possible with subset

Parameters
idxindex of label to get
Returns
INT value of label

Definition at line 191 of file DenseLabels.cpp.

SGVector< int32_t > get_int_labels ( )
inherited

get INT label vector

possible with subset

Returns
INT labels

Definition at line 105 of file DenseLabels.cpp.

float64_t get_label ( int32_t  idx)
inherited

get label

possible with subset

Parameters
idxindex of label to get
Returns
value of label

Definition at line 184 of file DenseLabels.cpp.

ELabelType get_label_type ( ) const
virtual

get label type

Returns
label type binary

Implements CDenseLabels.

Definition at line 109 of file BinaryLabels.cpp.

SGVector< float64_t > get_labels ( )
inherited

Getter for labels

Returns
labels, a copy if a subset is set

Definition at line 82 of file DenseLabels.cpp.

SGVector< float64_t > get_labels_copy ( )
inherited

get copy of labels.

possible with subset

Returns
labels

Definition at line 90 of file DenseLabels.cpp.

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

Definition at line 498 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 522 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 535 of file SGObject.cpp.

virtual const char* get_name ( ) const
virtual
Returns
object name

Implements CSGObject.

Definition at line 115 of file BinaryLabels.h.

int32_t get_num_labels ( ) const
virtualinherited

get number of labels, depending on whether a subset is set

Returns
number of labels

Implements CLabels.

Definition at line 201 of file DenseLabels.cpp.

float64_t get_value ( int32_t  idx)
virtualinherited

get confidence value for a particular label

Parameters
idxlabel index
Returns
confidence value of label with index idx

Definition at line 59 of file Labels.cpp.

SGVector< float64_t > get_values ( )
virtualinherited

get confidence vector

Returns
confidences

Definition at line 90 of file Labels.cpp.

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 296 of file SGObject.cpp.

void load ( CFile *  loader)
virtualinherited

load labels from file

any subset is removed before

Parameters
loaderFile object via which to load data

Definition at line 145 of file DenseLabels.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 369 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 426 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 421 of file SGObject.cpp.

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

Definition at line 262 of file SGObject.cpp.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 474 of file SGObject.cpp.

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

prints registered parameters out

Parameters
prefixprefix for members

Definition at line 308 of file SGObject.cpp.

void remove_all_subsets ( )
virtualinherited

removes all subsets Calls subset_changed_post() afterwards

Definition at line 54 of file Labels.cpp.

void remove_subset ( )
virtualinherited

removes that last added subset from subset stack, if existing Calls subset_changed_post() afterwards

Definition at line 49 of file Labels.cpp.

void save ( CFile *  writer)
virtualinherited

save labels to file

not possible with subset

Parameters
writerFile object via which to save data

Definition at line 152 of file DenseLabels.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 314 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 436 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 431 of file SGObject.cpp.

void scores_to_probabilities ( float64_t  a = 0,
float64_t  b = 0 
)

Converts all scores to calibrated probabilities by fitting a sigmoid function using the method described in Lin, H., Lin, C., and Weng, R. (2007). A note on Platt's probabilistic outputs for support vector machines.

A sigmoid is fitted to the scores of the labels and then is used to compute porbabilities which are stored in the values vector. This is done via computing \(pf=x*a+b\) for a given score \(x\) and then computing \(\frac{\exp(-f)}{1+}exp(-f)}\) if \(f\geq 0\) and \(\frac{1}{(1+\exp(f)}\) otherwise, where \(a, bf\) are shape parameters of the sigmoid. These can be specified or learned automatically

Should only be used in conjunction with SVM.

Parameters
aparameter a of sigmoid, if a=b=0, both are learned
bparameter b of sigmoid, if a=b=0, both are learned

Definition at line 114 of file BinaryLabels.cpp.

void set_generic ( )
inherited

Definition at line 41 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 46 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 51 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 56 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 61 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 66 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 71 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 76 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 81 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 86 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 91 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 96 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 101 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 106 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 111 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 228 of file SGObject.cpp.

void set_global_parallel ( Parallel *  parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 241 of file SGObject.cpp.

void set_global_version ( Version *  version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 283 of file SGObject.cpp.

bool set_int_label ( int32_t  idx,
int32_t  label 
)
inherited

set INT label

possible with subset

Parameters
idxindex of label to set
labelINT value of label
Returns
if setting was successful

Definition at line 172 of file DenseLabels.cpp.

void set_int_labels ( SGVector< int32_t >  labels)
inherited

set INT labels

not possible on subset

Parameters
labelsINT labels

Definition at line 115 of file DenseLabels.cpp.

void set_int_labels ( SGVector< int64_t >  labels)
inherited

set INT64 labels

not possible on subset

Parameters
labelsINT labels

Definition at line 127 of file DenseLabels.cpp.

bool set_label ( int32_t  idx,
float64_t  label 
)
inherited

set label

possible with subset

Parameters
idxindex of label to set
labelvalue of label
Returns
if setting was successful

Definition at line 160 of file DenseLabels.cpp.

void set_labels ( SGVector< float64_t >  v)
inherited

set labels

not possible with subset

Parameters
vlabels

Definition at line 74 of file DenseLabels.cpp.

void set_to_const ( float64_t  c)
inherited

set all labels to a const value

possible with subset

Parameters
cconst to set labels to

Definition at line 63 of file DenseLabels.cpp.

void set_to_one ( )
inherited

set all labels to +1

possible with subset

Definition at line 53 of file DenseLabels.cpp.

void set_value ( float64_t  value,
int32_t  idx 
)
virtualinherited

set the confidence value for a particular label

Parameters
valuevalue to set
idxlabel index whose conf. value is to be changed

Definition at line 66 of file Labels.cpp.

void set_values ( SGVector< float64_t >  values)
virtualinherited

set confidence vector

Parameters
valuesto be set (should have zero length to disable values or length must match the number of labels)

Definition at line 78 of file Labels.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 192 of file SGObject.cpp.

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

Definition at line 303 of file SGObject.cpp.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 248 of file SGObject.cpp.

void zero ( )
inherited

set all labels to zero

possible with subset

Definition at line 58 of file DenseLabels.cpp.

Member Data Documentation

SGIO* io
inherited

io

Definition at line 369 of file SGObject.h.

SGVector<float64_t> m_current_values
protectedinherited

current active value vector

Definition at line 135 of file Labels.h.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

Definition at line 384 of file SGObject.h.

uint32_t m_hash
inherited

Hash of parameter values

Definition at line 387 of file SGObject.h.

SGVector<float64_t> m_labels
protectedinherited

the label vector

Definition at line 210 of file DenseLabels.h.

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 381 of file SGObject.h.

Parameter* m_parameters
inherited

parameters

Definition at line 378 of file SGObject.h.

CSubsetStack* m_subset_stack
protectedinherited

subset class to enable subset support for this class

Definition at line 132 of file Labels.h.

Parallel* parallel
inherited

parallel

Definition at line 372 of file SGObject.h.

const int32_t REJECTION_LABEL = -2
staticinherited

label designates classify reject

Definition at line 203 of file DenseLabels.h.

Version* version
inherited

version

Definition at line 375 of file SGObject.h.

The documentation for this class was generated from the following files:
SHOGUN Machine Learning Toolbox - Documentation