|
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.
在文件 CrossValidationOutput.h 第 43 行定义.
Public 成员函数 | |
| 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="") |
| 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 属性 | |
| SGIO * | io |
| Parallel * | parallel |
| Version * | version |
| Parameter * | m_parameters |
| Parameter * | m_model_selection_parameters |
| Parameter * | m_gradient_parameters |
| uint32_t | m_hash |
Protected 成员函数 | |
| 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 属性 | |
| index_t | m_current_run_index |
| index_t | m_current_fold_index |
| index_t | m_num_runs |
| index_t | m_num_folds |
constructor
在文件 CrossValidationOutput.h 第 48 行定义.
|
virtual |
destructor
在文件 CrossValidationOutput.h 第 57 行定义.
|
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. |
在文件 SGObject.cpp 第 597 行定义.
|
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.
在文件 SGObject.cpp 第 714 行定义.
|
virtualinherited |
A deep copy. All the instance variables will also be copied.
在文件 SGObject.cpp 第 198 行定义.
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) |
在文件 SGObject.cpp 第 618 行定义.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
在文件 SGObject.cpp 第 498 行定义.
|
inherited |
Returns description of a given parameter string, if it exists. SG_ERROR otherwise
| param_name | name of the parameter |
在文件 SGObject.cpp 第 522 行定义.
|
inherited |
Returns index of model selection parameter with provided index
| param_name | name of model selection parameter |
在文件 SGObject.cpp 第 535 行定义.
|
pure virtual |
实现了 CSGObject.
在 CCrossValidationMulticlassStorage, CCrossValidationPrintOutput , 以及 CCrossValidationMKLStorage 内被实现.
|
virtual |
initially expose labels before usage
| labels | labels to expose to CV output |
被 CCrossValidationMulticlassStorage 重载.
在文件 CrossValidationOutput.h 第 84 行定义.
|
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 |
被 CCrossValidationPrintOutput 重载.
在文件 CrossValidationOutput.h 第 76 行定义.
|
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 |
被 CCrossValidationPrintOutput 重载.
在文件 CrossValidationOutput.h 第 67 行定义.
|
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 |
在文件 SGObject.cpp 第 296 行定义.
|
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 |
在文件 SGObject.cpp 第 369 行定义.
|
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. |
被 CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel , 以及 CExponentialKernel 重载.
在文件 SGObject.cpp 第 426 行定义.
|
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. |
被 CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.
在文件 SGObject.cpp 第 421 行定义.
|
virtualinherited |
在文件 SGObject.cpp 第 262 行定义.
|
virtual |
post init action (called once)
被 CCrossValidationMulticlassStorage 重载.
在文件 CrossValidationOutput.h 第 87 行定义.
|
virtual |
post update test and true results
被 CCrossValidationMulticlassStorage 重载.
在文件 CrossValidationOutput.h 第 153 行定义.
|
inherited |
prints all parameter registered for model selection and their type
在文件 SGObject.cpp 第 474 行定义.
|
virtualinherited |
|
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 |
在文件 SGObject.cpp 第 314 行定义.
|
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. |
被 CKernel 重载.
在文件 SGObject.cpp 第 436 行定义.
|
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. |
被 CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.
在文件 SGObject.cpp 第 431 行定义.
|
inherited |
在文件 SGObject.cpp 第 41 行定义.
|
inherited |
在文件 SGObject.cpp 第 46 行定义.
|
inherited |
在文件 SGObject.cpp 第 51 行定义.
|
inherited |
在文件 SGObject.cpp 第 56 行定义.
|
inherited |
在文件 SGObject.cpp 第 61 行定义.
|
inherited |
在文件 SGObject.cpp 第 66 行定义.
|
inherited |
在文件 SGObject.cpp 第 71 行定义.
|
inherited |
在文件 SGObject.cpp 第 76 行定义.
|
inherited |
在文件 SGObject.cpp 第 81 行定义.
|
inherited |
在文件 SGObject.cpp 第 86 行定义.
|
inherited |
在文件 SGObject.cpp 第 91 行定义.
|
inherited |
在文件 SGObject.cpp 第 96 行定义.
|
inherited |
在文件 SGObject.cpp 第 101 行定义.
|
inherited |
在文件 SGObject.cpp 第 106 行定义.
|
inherited |
在文件 SGObject.cpp 第 111 行定义.
|
inherited |
set generic type to T
|
inherited |
|
inherited |
|
inherited |
|
virtualinherited |
A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.
被 CGaussianKernel 重载.
在文件 SGObject.cpp 第 192 行定义.
|
inherited |
unset generic type
this has to be called in classes specializing a template class
在文件 SGObject.cpp 第 303 行定义.
|
virtual |
update evaluate result
| result | evaluation result |
| prefix | prefix for output |
被 CCrossValidationPrintOutput 重载.
在文件 CrossValidationOutput.h 第 160 行定义.
|
virtual |
update fold index (called every iteration). saves to local variable
| fold_index | index of current run |
| prefix | prefix for output |
被 CCrossValidationPrintOutput 重载.
在文件 CrossValidationOutput.h 第 105 行定义.
|
virtualinherited |
Updates the hash of current parameter combination
在文件 SGObject.cpp 第 248 行定义.
|
virtual |
update run index (called every iteration). saves to local variable
| run_index | index of current run |
| prefix | prefix for output |
被 CCrossValidationPrintOutput 重载.
在文件 CrossValidationOutput.h 第 94 行定义.
update test indices
| indices | indices used for testing/validation |
| prefix | prefix for output |
被 CCrossValidationPrintOutput 重载.
在文件 CrossValidationOutput.h 第 124 行定义.
|
virtual |
update test result
| results | result labels for test/validation run |
| prefix | prefix for output |
被 CCrossValidationMulticlassStorage , 以及 CCrossValidationPrintOutput 重载.
在文件 CrossValidationOutput.h 第 140 行定义.
|
virtual |
update test true result
| results | ground truth labels for test/validation run |
| prefix | prefix for output |
被 CCrossValidationMulticlassStorage , 以及 CCrossValidationPrintOutput 重载.
在文件 CrossValidationOutput.h 第 148 行定义.
update train indices
| indices | indices used for training |
| prefix | prefix for output |
被 CCrossValidationPrintOutput 重载.
在文件 CrossValidationOutput.h 第 116 行定义.
|
virtual |
update trained machine
| machine | trained machine instance |
| prefix | prefix for output |
被 CCrossValidationPrintOutput , 以及 CCrossValidationMKLStorage 重载.
在文件 CrossValidationOutput.h 第 132 行定义.
|
inherited |
io
在文件 SGObject.h 第 369 行定义.
|
protected |
current fold index is written here
在文件 CrossValidationOutput.h 第 168 行定义.
|
protected |
current run index is written here
在文件 CrossValidationOutput.h 第 165 行定义.
|
inherited |
parameters wrt which we can compute gradients
在文件 SGObject.h 第 384 行定义.
|
inherited |
Hash of parameter values
在文件 SGObject.h 第 387 行定义.
|
inherited |
model selection parameters
在文件 SGObject.h 第 381 行定义.
|
protected |
number of folds is initialised here
在文件 CrossValidationOutput.h 第 174 行定义.
|
protected |
number of runs is initialised here
在文件 CrossValidationOutput.h 第 171 行定义.
|
inherited |
parameters
在文件 SGObject.h 第 378 行定义.
|
inherited |
parallel
在文件 SGObject.h 第 372 行定义.
|
inherited |
version
在文件 SGObject.h 第 375 行定义.
