SHOGUN
4.1.0
|
Class for managing individual folds in cross-validation.
It is often desired to print/save informations that occur during individual folds in cross-validation, such as indices, parameters of underlying machine etc. This abstract base class might be called from the CCrossValidation class after each fold in order to collect these things. Different implementations then could output the informations, or even store them to make them accessible later. Since is different for every underlying machine, individual sub-classes have to handle this separately. When writing new subclasses, try to make the design as inheritance based as possible, such that future sub-sub-classes can use yours. Note that subclasses only need to implement methods that they need since all methods in this class are already implemented empty, except for num/fold stuff. These number of runs/folds and their current indices are stored since these might be used from many subclasses.
Definition at line 43 of file CrossValidationOutput.h.
Public Member Functions | |
CCrossValidationOutput () | |
virtual | ~CCrossValidationOutput () |
virtual const char * | get_name () const =0 |
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 | init_expose_labels (CLabels *labels) |
virtual void | post_init () |
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_test_result (CLabels *results, const char *prefix="") |
virtual void | update_test_true_result (CLabels *results, const char *prefix="") |
virtual void | post_update_results () |
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="", int32_t param_version=Version::get_version_parameter()) |
virtual bool | load_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=Version::get_version_parameter()) |
DynArray< TParameter * > * | load_file_parameters (const SGParamInfo *param_info, int32_t file_version, CSerializableFile *file, const char *prefix="") |
DynArray< TParameter * > * | load_all_file_parameters (int32_t file_version, int32_t current_version, CSerializableFile *file, const char *prefix="") |
void | map_parameters (DynArray< TParameter * > *param_base, int32_t &base_version, DynArray< const SGParamInfo * > *target_param_infos) |
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 |
ParameterMap * | m_parameter_map |
uint32_t | m_hash |
Protected Member Functions | |
virtual TParameter * | migrate (DynArray< TParameter * > *param_base, const SGParamInfo *target) |
virtual void | one_to_one_migration_prepare (DynArray< TParameter * > *param_base, const SGParamInfo *target, TParameter *&replacement, TParameter *&to_migrate, char *old_name=NULL) |
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 | |
index_t | m_current_run_index |
index_t | m_current_fold_index |
index_t | m_num_runs |
index_t | m_num_folds |
constructor
Definition at line 48 of file CrossValidationOutput.h.
|
virtual |
destructor
Definition at line 57 of file CrossValidationOutput.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 1244 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 1361 of file SGObject.cpp.
|
virtualinherited |
A deep copy. All the instance variables will also be copied.
Definition at line 200 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 1265 of file SGObject.cpp.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
Definition at line 1136 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 1160 of file SGObject.cpp.
|
inherited |
Returns index of model selection parameter with provided index
param_name | name of model selection parameter |
Definition at line 1173 of file SGObject.cpp.
|
pure virtual |
Implements CSGObject.
Implemented in CCrossValidationMulticlassStorage, CCrossValidationPrintOutput, and CCrossValidationMKLStorage.
|
virtual |
initially expose labels before usage
labels | labels to expose to CV output |
Reimplemented in CCrossValidationMulticlassStorage.
Definition at line 84 of file CrossValidationOutput.h.
|
virtual |
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.
|
virtual |
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 298 of file SGObject.cpp.
|
inherited |
maps all parameters of this instance to the provided file version and loads all parameter data from the file into an array, which is sorted (basically calls load_file_parameter(...) for all parameters and puts all results into a sorted array)
file_version | parameter version of the file |
current_version | version from which mapping begins (you want to use Version::get_version_parameter() for this in most cases) |
file | file to load from |
prefix | prefix for members |
Definition at line 705 of file SGObject.cpp.
|
inherited |
loads some specified parameters from a file with a specified version The provided parameter info has a version which is recursively mapped until the file parameter version is reached. Note that there may be possibly multiple parameters in the mapping, therefore, a set of TParameter instances is returned
param_info | information of parameter |
file_version | parameter version of the file, must be <= provided parameter version |
file | file to load from |
prefix | prefix for members |
Definition at line 546 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 |
param_version | (optional) a parameter version different to (this is mainly for testing, better do not use) |
Definition at line 375 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 1063 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 1058 of file SGObject.cpp.
|
inherited |
Takes a set of TParameter instances (base) with a certain version and a set of target parameter infos and recursively maps the base level wise to the current version using CSGObject::migrate(...). The base is replaced. After this call, the base version containing parameters should be of same version/type as the initial target parameter infos. Note for this to work, the migrate methods and all the internal parameter mappings have to match
param_base | set of TParameter instances that are mapped to the provided target parameter infos |
base_version | version of the parameter base |
target_param_infos | set of SGParamInfo instances that specify the target parameter base |
Definition at line 743 of file SGObject.cpp.
|
protectedvirtualinherited |
creates a new TParameter instance, which contains migrated data from the version that is provided. The provided parameter data base is used for migration, this base is a collection of all parameter data of the previous version. Migration is done FROM the data in param_base TO the provided param info Migration is always one version step. Method has to be implemented in subclasses, if no match is found, base method has to be called.
If there is an element in the param_base which equals the target, a copy of the element is returned. This represents the case when nothing has changed and therefore, the migrate method is not overloaded in a subclass
param_base | set of TParameter instances to use for migration |
target | parameter info for the resulting TParameter |
Definition at line 950 of file SGObject.cpp.
|
protectedvirtualinherited |
This method prepares everything for a one-to-one parameter migration. One to one here means that only ONE element of the parameter base is needed for the migration (the one with the same name as the target). Data is allocated for the target (in the type as provided in the target SGParamInfo), and a corresponding new TParameter instance is written to replacement. The to_migrate pointer points to the single needed TParameter instance needed for migration. If a name change happened, the old name may be specified by old_name. In addition, the m_delete_data flag of to_migrate is set to true. So if you want to migrate data, the only thing to do after this call is converting the data in the m_parameter fields. If unsure how to use - have a look into an example for this. (base_migration_type_conversion.cpp for example)
param_base | set of TParameter instances to use for migration |
target | parameter info for the resulting TParameter |
replacement | (used as output) here the TParameter instance which is returned by migration is created into |
to_migrate | the only source that is used for migration |
old_name | with this parameter, a name change may be specified |
Definition at line 890 of file SGObject.cpp.
|
virtualinherited |
Definition at line 264 of file SGObject.cpp.
|
virtual |
post init action (called once)
Reimplemented in CCrossValidationMulticlassStorage.
Definition at line 87 of file CrossValidationOutput.h.
|
virtual |
post update test and true results
Reimplemented in CCrossValidationMulticlassStorage.
Definition at line 153 of file CrossValidationOutput.h.
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 1112 of file SGObject.cpp.
|
virtualinherited |
prints registered parameters out
prefix | prefix for members |
Definition at line 310 of file SGObject.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 |
param_version | (optional) a parameter version different to (this is mainly for testing, better do not use) |
Definition at line 316 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 1073 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 1068 of file SGObject.cpp.
|
inherited |
Definition at line 42 of file SGObject.cpp.
|
inherited |
Definition at line 47 of file SGObject.cpp.
|
inherited |
Definition at line 52 of file SGObject.cpp.
|
inherited |
Definition at line 57 of file SGObject.cpp.
|
inherited |
Definition at line 62 of file SGObject.cpp.
|
inherited |
Definition at line 67 of file SGObject.cpp.
|
inherited |
Definition at line 72 of file SGObject.cpp.
|
inherited |
Definition at line 77 of file SGObject.cpp.
|
inherited |
Definition at line 82 of file SGObject.cpp.
|
inherited |
Definition at line 87 of file SGObject.cpp.
|
inherited |
Definition at line 92 of file SGObject.cpp.
|
inherited |
Definition at line 97 of file SGObject.cpp.
|
inherited |
Definition at line 102 of file SGObject.cpp.
|
inherited |
Definition at line 107 of file SGObject.cpp.
|
inherited |
Definition at line 112 of file SGObject.cpp.
|
inherited |
set generic type to T
|
inherited |
|
inherited |
set the parallel object
parallel | parallel object to use |
Definition at line 243 of file SGObject.cpp.
|
inherited |
set the version object
version | version object to use |
Definition at line 285 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 194 of file SGObject.cpp.
|
inherited |
unset generic type
this has to be called in classes specializing a template class
Definition at line 305 of file SGObject.cpp.
|
virtual |
update evaluate result
result | evaluation result |
prefix | prefix for output |
Reimplemented in CCrossValidationPrintOutput.
Definition at line 160 of file CrossValidationOutput.h.
|
virtual |
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 250 of file SGObject.cpp.
|
virtual |
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.
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 in CCrossValidationMulticlassStorage, and CCrossValidationPrintOutput.
Definition at line 140 of file CrossValidationOutput.h.
|
virtual |
update test true result
results | ground truth labels for test/validation run |
prefix | prefix for output |
Reimplemented in CCrossValidationMulticlassStorage, and CCrossValidationPrintOutput.
Definition at line 148 of file CrossValidationOutput.h.
update train indices
indices | indices used for training |
prefix | prefix for output |
Reimplemented in CCrossValidationPrintOutput.
Definition at line 116 of file CrossValidationOutput.h.
|
virtual |
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 496 of file SGObject.h.
|
protected |
current fold index is written here
Definition at line 168 of file CrossValidationOutput.h.
|
protected |
current run index is written here
Definition at line 165 of file CrossValidationOutput.h.
|
inherited |
parameters wrt which we can compute gradients
Definition at line 511 of file SGObject.h.
|
inherited |
Hash of parameter values
Definition at line 517 of file SGObject.h.
|
inherited |
model selection parameters
Definition at line 508 of file SGObject.h.
|
protected |
number of folds is initialised here
Definition at line 174 of file CrossValidationOutput.h.
|
protected |
number of runs is initialised here
Definition at line 171 of file CrossValidationOutput.h.
|
inherited |
map for different parameter versions
Definition at line 514 of file SGObject.h.
|
inherited |
parameters
Definition at line 505 of file SGObject.h.
|
inherited |
parallel
Definition at line 499 of file SGObject.h.
|
inherited |
version
Definition at line 502 of file SGObject.h.