SHOGUN
4.2.0
|
Multiclass Labels for multi-class classification.
valid values for labels are 0...nr_classes-1
Definition at line 36 of file MulticlassLabels.h.
Public Member Functions | |
CMulticlassLabels () | |
CMulticlassLabels (int32_t num_labels) | |
CMulticlassLabels (SGVector< float64_t > src) | |
CMulticlassLabels (CFile *loader) | |
~CMulticlassLabels () | |
virtual void | ensure_valid (const char *context=NULL) |
virtual ELabelType | get_label_type () const |
CBinaryLabels * | get_binary_for_class (int32_t i) |
SGVector< float64_t > | get_unique_labels () |
int32_t | get_num_classes () |
SGVector< float64_t > | get_multiclass_confidences (int32_t i) |
void | set_multiclass_confidences (int32_t i, SGVector< float64_t > confidences) |
void | allocate_confidences_for (int32_t n_classes) |
virtual const char * | get_name () const |
virtual CLabels * | shallow_subset_copy () |
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) |
SGVector< float64_t > | get_labels () |
float64_t | get_label (int32_t idx) |
template<typename ST > | |
ST | get_label_t (int32_t idx) |
int32_t | get_int_label (int32_t idx) |
SGVector< float64_t > | get_labels_copy () |
template<typename ST > | |
SGVector< ST > | get_labels_t () |
template<> | |
SGVector< float64_t > | get_labels_t () |
template<typename ST > | |
SGVector< ST > | get_labels_copy_t () |
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) |
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 |
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) |
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 | |
SGMatrix< float64_t > | m_multiclass_confidences |
SGVector< float64_t > | m_labels |
CSubsetStack * | m_subset_stack |
SGVector< float64_t > | m_current_values |
default constructor
Definition at line 7 of file MulticlassLabels.cpp.
CMulticlassLabels | ( | int32_t | num_labels | ) |
constructor
num_labels | number of labels |
Definition at line 12 of file MulticlassLabels.cpp.
CMulticlassLabels | ( | SGVector< float64_t > | src | ) |
CMulticlassLabels | ( | CFile * | loader | ) |
constructor
loader | File object via which to load data |
Definition at line 23 of file MulticlassLabels.cpp.
~CMulticlassLabels | ( | ) |
destructor
Definition at line 28 of file MulticlassLabels.cpp.
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)
subset | subset of indices to add |
Definition at line 39 of file Labels.cpp.
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.
subset | subset of indices to replace the latest one with. |
Definition at line 44 of file Labels.cpp.
void allocate_confidences_for | ( | int32_t | n_classes | ) |
allocates matrix to store confidences. should always be called before setting confidences with set_multiclass_confidences
n_classes | number of classes |
Definition at line 57 of file MulticlassLabels.cpp.
|
inherited |
Builds a dictionary of all parameters in SGObject as well of those of SGObjects that are parameters of this object. Dictionary maps parameters to the objects that own them.
dict | dictionary of parameters to be built. |
Definition at line 630 of file SGObject.cpp.
|
virtualinherited |
Creates a clone of the current object. This is done via recursively traversing all parameters, which corresponds to a deep copy. Calling equals on the cloned object always returns true although none of the memory of both objects overlaps.
Definition at line 747 of file SGObject.cpp.
|
virtualinherited |
A deep copy. All the instance variables will also be copied.
Definition at line 231 of file SGObject.cpp.
|
virtual |
Make sure the label is valid, otherwise raise SG_ERROR.
possible with subset
context | optional message to convey the context |
Reimplemented from CDenseLabels.
Definition at line 66 of file MulticlassLabels.cpp.
Recursively compares the current SGObject to another one. Compares all registered numerical parameters, recursion upon complex (SGObject) parameters. Does not compare pointers!
May be overwritten but please do with care! Should not be necessary in most cases.
other | object to compare with |
accuracy | accuracy to use for comparison (optional) |
tolerant | allows linient check on float equality (within accuracy) |
Definition at line 651 of file SGObject.cpp.
|
inherited |
Getter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.
_tag | name and type information of parameter |
Definition at line 367 of file SGObject.h.
|
inherited |
Getter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.
name | name of the parameter |
Definition at line 388 of file SGObject.h.
CBinaryLabels * get_binary_for_class | ( | int32_t | i | ) |
returns labels containing +1 at positions with ith class and -1 at other positions
i | index of class |
Definition at line 89 of file MulticlassLabels.cpp.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
get INT label
possible with subset
idx | index of label to get |
Definition at line 191 of file DenseLabels.cpp.
|
inherited |
get INT label vector
possible with subset
Definition at line 105 of file DenseLabels.cpp.
|
inherited |
get label
possible with subset
idx | index of label to get |
Definition at line 184 of file DenseLabels.cpp.
|
inherited |
get label
possible with subset
idx | index of label to get |
Definition at line 123 of file DenseLabels.h.
|
virtual |
get label type
Implements CDenseLabels.
Definition at line 84 of file MulticlassLabels.cpp.
Getter for labels
Definition at line 82 of file DenseLabels.cpp.
Gets a copy of the labels.
possible with subset
Definition at line 90 of file DenseLabels.cpp.
|
inherited |
Get copy of labels.
possible with subset
Definition at line 175 of file DenseLabels.h.
|
inherited |
Getter for labels
Definition at line 156 of file DenseLabels.h.
Specialization of get_labels for float64_t
Definition at line 283 of file DenseLabels.h.
|
inherited |
Definition at line 531 of file SGObject.cpp.
|
inherited |
Returns description of a given parameter string, if it exists. SG_ERROR otherwise
param_name | name of the parameter |
Definition at line 555 of file SGObject.cpp.
|
inherited |
Returns index of model selection parameter with provided index
param_name | name of model selection parameter |
Definition at line 568 of file SGObject.cpp.
returns multiclass confidences
i | index |
Definition at line 48 of file MulticlassLabels.cpp.
|
virtual |
int32_t get_num_classes | ( | ) |
return number of classes (for multiclass)
possible with subset
Definition at line 132 of file MulticlassLabels.cpp.
|
virtualinherited |
get number of labels, depending on whether a subset is set
Implements CLabels.
Definition at line 201 of file DenseLabels.cpp.
get unique labels (new SGVector)
possible with subset
Definition at line 118 of file MulticlassLabels.cpp.
|
virtualinherited |
get confidence value for a particular label
idx | label index |
Definition at line 59 of file Labels.cpp.
|
inherited |
Checks if object has a class parameter identified by a name.
name | name of the parameter |
Definition at line 289 of file SGObject.h.
|
inherited |
Checks if object has a class parameter identified by a Tag.
tag | tag of the parameter containing name and type information |
Definition at line 301 of file SGObject.h.
|
inherited |
Checks if a type exists for a class parameter identified by a name.
name | name of the parameter |
Definition at line 312 of file SGObject.h.
|
virtualinherited |
If the SGSerializable is a class template then TRUE will be returned and GENERIC is set to the type of the generic.
generic | set to the type of the generic if returning TRUE |
Definition at line 329 of file SGObject.cpp.
|
virtualinherited |
load labels from file
any subset is removed before
loader | File object via which to load data |
Definition at line 145 of file DenseLabels.cpp.
|
virtualinherited |
Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!
file | where to load from |
prefix | prefix for members |
Definition at line 402 of file SGObject.cpp.
|
protectedvirtualinherited |
Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_POST is called.
ShogunException | will be thrown if an error occurs. |
Reimplemented in CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.
Definition at line 459 of file SGObject.cpp.
|
protectedvirtualinherited |
Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_PRE is called.
ShogunException | will be thrown if an error occurs. |
Reimplemented in CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.
Definition at line 454 of file SGObject.cpp.
|
virtualinherited |
Definition at line 295 of file SGObject.cpp.
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 507 of file SGObject.cpp.
|
virtualinherited |
prints registered parameters out
prefix | prefix for members |
Definition at line 341 of file SGObject.cpp.
|
protectedinherited |
Registers a class parameter which is identified by a tag. This enables the parameter to be modified by set() and retrieved by get(). Parameters can be registered in the constructor of the class.
_tag | name and type information of parameter |
value | value of the parameter |
Definition at line 439 of file SGObject.h.
|
protectedinherited |
Registers a class parameter which is identified by a name. This enables the parameter to be modified by set() and retrieved by get(). Parameters can be registered in the constructor of the class.
name | name of the parameter |
value | value of the parameter along with type information |
Definition at line 452 of file SGObject.h.
|
virtualinherited |
removes all subsets Calls subset_changed_post() afterwards
Definition at line 54 of file Labels.cpp.
|
virtualinherited |
removes that last added subset from subset stack, if existing Calls subset_changed_post() afterwards
Definition at line 49 of file Labels.cpp.
|
virtualinherited |
save labels to file
not possible with subset
writer | File object via which to save data |
Definition at line 152 of file DenseLabels.cpp.
|
virtualinherited |
Save this object to file.
file | where to save the object; will be closed during returning if PREFIX is an empty string. |
prefix | prefix for members |
Definition at line 347 of file SGObject.cpp.
|
protectedvirtualinherited |
Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_POST is called.
ShogunException | will be thrown if an error occurs. |
Reimplemented in CKernel.
Definition at line 469 of file SGObject.cpp.
|
protectedvirtualinherited |
Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_PRE is called.
ShogunException | will be thrown if an error occurs. |
Reimplemented in CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.
Definition at line 464 of file SGObject.cpp.
|
inherited |
Setter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.
_tag | name and type information of parameter |
value | value of the parameter |
Definition at line 328 of file SGObject.h.
|
inherited |
Setter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.
name | name of the parameter |
value | value of the parameter along with type information |
Definition at line 354 of file SGObject.h.
|
inherited |
Definition at line 74 of file SGObject.cpp.
|
inherited |
Definition at line 79 of file SGObject.cpp.
|
inherited |
Definition at line 84 of file SGObject.cpp.
|
inherited |
Definition at line 89 of file SGObject.cpp.
|
inherited |
Definition at line 94 of file SGObject.cpp.
|
inherited |
Definition at line 99 of file SGObject.cpp.
|
inherited |
Definition at line 104 of file SGObject.cpp.
|
inherited |
Definition at line 109 of file SGObject.cpp.
|
inherited |
Definition at line 114 of file SGObject.cpp.
|
inherited |
Definition at line 119 of file SGObject.cpp.
|
inherited |
Definition at line 124 of file SGObject.cpp.
|
inherited |
Definition at line 129 of file SGObject.cpp.
|
inherited |
Definition at line 134 of file SGObject.cpp.
|
inherited |
Definition at line 139 of file SGObject.cpp.
|
inherited |
Definition at line 144 of file SGObject.cpp.
|
inherited |
set generic type to T
|
inherited |
|
inherited |
set the parallel object
parallel | parallel object to use |
Definition at line 274 of file SGObject.cpp.
|
inherited |
set the version object
version | version object to use |
Definition at line 316 of file SGObject.cpp.
|
inherited |
set INT label
possible with subset
idx | index of label to set |
label | INT value of label |
Definition at line 172 of file DenseLabels.cpp.
|
inherited |
set INT labels
not possible on subset
labels | INT labels |
Definition at line 115 of file DenseLabels.cpp.
|
inherited |
set INT64 labels
not possible on subset
labels | INT labels |
Definition at line 127 of file DenseLabels.cpp.
|
inherited |
set label
possible with subset
idx | index of label to set |
label | value of label |
Definition at line 160 of file DenseLabels.cpp.
set labels
not possible with subset
v | labels |
Definition at line 74 of file DenseLabels.cpp.
sets multiclass confidences. to prepare labels for storing multiclass confidences call allocate_confidences_for
i | index |
confidences | confidences to be set for ith result |
Definition at line 37 of file MulticlassLabels.cpp.
|
inherited |
set all labels to a const value
possible with subset
c | const to set labels to |
Definition at line 63 of file DenseLabels.cpp.
|
inherited |
|
virtualinherited |
set the confidence value for a particular label
value | value to set |
idx | label index whose conf. value is to be changed |
Definition at line 66 of file Labels.cpp.
set confidence vector
values | to 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.
|
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 |
Reimplemented from CLabels.
Definition at line 138 of file MulticlassLabels.cpp.
|
inherited |
unset generic type
this has to be called in classes specializing a template class
Definition at line 336 of file SGObject.cpp.
|
virtualinherited |
Updates the hash of current parameter combination
Definition at line 281 of file SGObject.cpp.
|
inherited |
|
inherited |
io
Definition at line 537 of file SGObject.h.
|
inherited |
parameters wrt which we can compute gradients
Definition at line 552 of file SGObject.h.
|
inherited |
Hash of parameter values
Definition at line 555 of file SGObject.h.
the label vector
Definition at line 274 of file DenseLabels.h.
|
inherited |
model selection parameters
Definition at line 549 of file SGObject.h.
multiclass confidences
Definition at line 137 of file MulticlassLabels.h.
|
inherited |
parameters
Definition at line 546 of file SGObject.h.
|
protectedinherited |
|
inherited |
parallel
Definition at line 540 of file SGObject.h.
|
staticinherited |
label designates classify reject
Definition at line 267 of file DenseLabels.h.
|
inherited |
version
Definition at line 543 of file SGObject.h.