SHOGUN
4.2.0
|
Class for storing multiclass evaluation information in every fold of cross-validation.
Be careful - can be very expensive memory-wise.
Definition at line 33 of file CrossValidationMulticlassStorage.h.
Public Member Functions | |
CCrossValidationMulticlassStorage (bool compute_ROC=true, bool compute_PRC=false, bool compute_conf_matrices=false) | |
virtual | ~CCrossValidationMulticlassStorage () |
SGMatrix< float64_t > | get_fold_ROC (int32_t run, int32_t fold, int32_t c) |
SGMatrix< float64_t > | get_fold_PRC (int32_t run, int32_t fold, int32_t c) |
void | append_binary_evaluation (CBinaryClassEvaluation *evaluation) |
CBinaryClassEvaluation * | get_binary_evaluation (int32_t idx) |
float64_t | get_fold_evaluation_result (int32_t run, int32_t fold, int32_t c, int32_t e) |
float64_t | get_fold_accuracy (int32_t run, int32_t fold) |
SGMatrix< int32_t > | get_fold_conf_matrix (int32_t run, int32_t fold) |
virtual void | post_init () |
virtual void | post_update_results () |
virtual void | init_expose_labels (CLabels *labels) |
virtual void | update_test_result (CLabels *results, const char *prefix="") |
virtual void | update_test_true_result (CLabels *results, const char *prefix="") |
virtual const char * | get_name () const |
virtual void | init_num_runs (index_t num_runs, const char *prefix="") |
virtual void | init_num_folds (index_t num_folds, const char *prefix="") |
virtual void | update_run_index (index_t run_index, const char *prefix="") |
virtual void | update_fold_index (index_t fold_index, const char *prefix="") |
virtual void | update_train_indices (SGVector< index_t > indices, const char *prefix="") |
virtual void | update_test_indices (SGVector< index_t > indices, const char *prefix="") |
virtual void | update_trained_machine (CMachine *machine, const char *prefix="") |
virtual void | update_evaluation_result (float64_t result, const char *prefix="") |
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 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 | |
bool | m_initialized |
CDynamicObjectArray * | m_binary_evaluations |
SGVector< float64_t > | m_evaluations_results |
SGVector< float64_t > | m_accuracies |
bool | m_compute_ROC |
SGMatrix< float64_t > * | m_fold_ROC_graphs |
bool | m_compute_PRC |
SGMatrix< float64_t > * | m_fold_PRC_graphs |
bool | m_compute_conf_matrices |
SGMatrix< int32_t > * | m_conf_matrices |
CMulticlassLabels * | m_pred_labels |
CMulticlassLabels * | m_true_labels |
int32_t | m_num_classes |
index_t | m_current_run_index |
index_t | m_current_fold_index |
index_t | m_num_runs |
index_t | m_num_folds |
CCrossValidationMulticlassStorage | ( | bool | compute_ROC = true , |
bool | compute_PRC = false , |
||
bool | compute_conf_matrices = false |
||
) |
constructor
compute_ROC | whether to compute ROCs |
compute_PRC | whether to compute PRCs |
compute_conf_matrices | whether to compute confusion matrices |
Definition at line 17 of file CrossValidationMulticlassStorage.cpp.
|
virtual |
destructor
Definition at line 34 of file CrossValidationMulticlassStorage.cpp.
void append_binary_evaluation | ( | CBinaryClassEvaluation * | evaluation | ) |
appends a binary evaluation instance
evaluation | binary evaluation to add |
Definition at line 89 of file CrossValidationMulticlassStorage.h.
|
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.
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.
CBinaryClassEvaluation* get_binary_evaluation | ( | int32_t | idx | ) |
returns binary evalution appended before
idx |
Definition at line 98 of file CrossValidationMulticlassStorage.h.
float64_t get_fold_accuracy | ( | int32_t | run, |
int32_t | fold | ||
) |
returns accuracy of fold and run
run | run |
fold | fold |
Definition at line 128 of file CrossValidationMulticlassStorage.h.
SGMatrix<int32_t> get_fold_conf_matrix | ( | int32_t | run, |
int32_t | fold | ||
) |
returns confusion matrix of fold and run
run | run |
fold | fold |
Definition at line 141 of file CrossValidationMulticlassStorage.h.
float64_t get_fold_evaluation_result | ( | int32_t | run, |
int32_t | fold, | ||
int32_t | c, | ||
int32_t | e | ||
) |
returns evaluation result of 1-v-R in given fold and run
run | run |
fold | fold |
c | class |
e | evaluation number |
Definition at line 110 of file CrossValidationMulticlassStorage.h.
returns PRC of 1-v-R in given fold and run
run | run |
fold | fold |
c | class |
Definition at line 73 of file CrossValidationMulticlassStorage.h.
returns ROC of 1-v-R in given fold and run
run | run |
fold | fold |
c | class |
Definition at line 54 of file CrossValidationMulticlassStorage.h.
|
inherited |
|
inherited |
|
inherited |
|
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.
|
virtual |
Implements CCrossValidationOutput.
Definition at line 179 of file CrossValidationMulticlassStorage.h.
|
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.
|
virtual |
expose labels
labels | labels to expose |
Reimplemented from CCrossValidationOutput.
Definition at line 94 of file CrossValidationMulticlassStorage.cpp.
|
virtualinherited |
init number of folds (called once). saves them to local variable
num_folds | number of folds that will be performed |
prefix | prefix for output |
Reimplemented in CCrossValidationPrintOutput.
Definition at line 76 of file CrossValidationOutput.h.
|
virtualinherited |
init number of runs (called once). saves them to local variable
num_runs | number of runs that will be performed |
prefix | prefix for output |
Reimplemented in CCrossValidationPrintOutput.
Definition at line 67 of file CrossValidationOutput.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 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.
|
virtual |
post init
Reimplemented from CCrossValidationOutput.
Definition at line 58 of file CrossValidationMulticlassStorage.cpp.
|
virtual |
post update results
Reimplemented from CCrossValidationOutput.
Definition at line 100 of file CrossValidationMulticlassStorage.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 |
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.
|
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.
|
inherited |
unset generic type
this has to be called in classes specializing a template class
Definition at line 336 of file SGObject.cpp.
|
virtualinherited |
update evaluate result
result | evaluation result |
prefix | prefix for output |
Reimplemented in CCrossValidationPrintOutput.
Definition at line 160 of file CrossValidationOutput.h.
|
virtualinherited |
update fold index (called every iteration). saves to local variable
fold_index | index of current run |
prefix | prefix for output |
Reimplemented in CCrossValidationPrintOutput.
Definition at line 105 of file CrossValidationOutput.h.
|
virtualinherited |
Updates the hash of current parameter combination
Definition at line 281 of file SGObject.cpp.
|
virtualinherited |
update run index (called every iteration). saves to local variable
run_index | index of current run |
prefix | prefix for output |
Reimplemented in CCrossValidationPrintOutput.
Definition at line 94 of file CrossValidationOutput.h.
|
virtualinherited |
update test indices
indices | indices used for testing/validation |
prefix | prefix for output |
Reimplemented in CCrossValidationPrintOutput.
Definition at line 124 of file CrossValidationOutput.h.
|
virtual |
update test result
results | result labels for test/validation run |
prefix | prefix for output |
Reimplemented from CCrossValidationOutput.
Definition at line 144 of file CrossValidationMulticlassStorage.cpp.
|
virtual |
update test true result
results | ground truth labels for test/validation run |
prefix | prefix for output |
Reimplemented from CCrossValidationOutput.
Definition at line 149 of file CrossValidationMulticlassStorage.cpp.
|
virtualinherited |
update train indices
indices | indices used for training |
prefix | prefix for output |
Reimplemented in CCrossValidationPrintOutput.
Definition at line 116 of file CrossValidationOutput.h.
|
virtualinherited |
update trained machine
machine | trained machine instance |
prefix | prefix for output |
Reimplemented in CCrossValidationPrintOutput, and CCrossValidationMKLStorage.
Definition at line 132 of file CrossValidationOutput.h.
|
inherited |
io
Definition at line 537 of file SGObject.h.
accuracies
Definition at line 193 of file CrossValidationMulticlassStorage.h.
|
protected |
custom binary evaluators
Definition at line 187 of file CrossValidationMulticlassStorage.h.
|
protected |
whether compute confusion matrices
Definition at line 208 of file CrossValidationMulticlassStorage.h.
|
protected |
whether compute PRCs
Definition at line 202 of file CrossValidationMulticlassStorage.h.
|
protected |
whether compute ROCs
Definition at line 196 of file CrossValidationMulticlassStorage.h.
|
protected |
confusion matrices
Definition at line 211 of file CrossValidationMulticlassStorage.h.
|
protectedinherited |
current fold index is written here
Definition at line 168 of file CrossValidationOutput.h.
|
protectedinherited |
current run index is written here
Definition at line 165 of file CrossValidationOutput.h.
fold evaluation results
Definition at line 190 of file CrossValidationMulticlassStorage.h.
fold PRC graphs
Definition at line 205 of file CrossValidationMulticlassStorage.h.
fold ROC graphs
Definition at line 199 of file CrossValidationMulticlassStorage.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.
|
protected |
is initialized
Definition at line 184 of file CrossValidationMulticlassStorage.h.
|
inherited |
model selection parameters
Definition at line 549 of file SGObject.h.
|
protected |
number of classes
Definition at line 220 of file CrossValidationMulticlassStorage.h.
|
protectedinherited |
number of folds is initialised here
Definition at line 174 of file CrossValidationOutput.h.
|
protectedinherited |
number of runs is initialised here
Definition at line 171 of file CrossValidationOutput.h.
|
inherited |
parameters
Definition at line 546 of file SGObject.h.
|
protected |
predicted results
Definition at line 214 of file CrossValidationMulticlassStorage.h.
|
protected |
true labels
Definition at line 217 of file CrossValidationMulticlassStorage.h.
|
inherited |
parallel
Definition at line 540 of file SGObject.h.
|
inherited |
version
Definition at line 543 of file SGObject.h.