CCrossValidationMulticlassStorage类 参考

详细描述

Class for storing multiclass evaluation information in every fold of cross-validation.

Be careful - can be very expensive memory-wise.

在文件 CrossValidationMulticlassStorage.h 第 33 行定义.

类 CCrossValidationMulticlassStorage 继承关系图:

Public 成员函数
	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)
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 属性
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

在文件 CrossValidationMulticlassStorage.cpp 第 17 行定义.

~CCrossValidationMulticlassStorage ( )

virtual

destructor

在文件 CrossValidationMulticlassStorage.cpp 第 34 行定义.

成员函数说明

void append_binary_evaluation

(

CBinaryClassEvaluation *

evaluation

)

appends a binary evaluation instance

参数

evaluation

binary evaluation to add

在文件 CrossValidationMulticlassStorage.h 第 89 行定义.

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.

参数

dict	dictionary of parameters to be built.

在文件 SGObject.cpp 第 597 行定义.

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.

返回

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

在文件 SGObject.cpp 第 714 行定义.

CSGObject * deep_copy ( ) const

virtualinherited

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

在文件 SGObject.cpp 第 198 行定义.

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.

参数

other	object to compare with
accuracy	accuracy to use for comparison (optional)
tolerant	allows linient check on float equality (within accuracy)

返回

true if all parameters were equal, false if not

在文件 SGObject.cpp 第 618 行定义.

CBinaryClassEvaluation* get_binary_evaluation

(

int32_t

idx

)

returns binary evalution appended before

参数

idx

在文件 CrossValidationMulticlassStorage.h 第 98 行定义.

float64_t get_fold_accuracy	(	int32_t	run,
		int32_t	fold
	)

returns accuracy of fold and run

参数

run	run
fold	fold

在文件 CrossValidationMulticlassStorage.h 第 128 行定义.

SGMatrix<int32_t> get_fold_conf_matrix	(	int32_t	run,
		int32_t	fold
	)

returns confusion matrix of fold and run

参数

run	run
fold	fold

在文件 CrossValidationMulticlassStorage.h 第 141 行定义.

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

在文件 CrossValidationMulticlassStorage.h 第 110 行定义.

SGMatrix<float64_t> get_fold_PRC	(	int32_t	run,
		int32_t	fold,
		int32_t	c
	)

returns PRC of 1-v-R in given fold and run

参数

run	run
fold	fold
c	class

返回

ROC of 'run' run, 'fold' fold and 'c' class

在文件 CrossValidationMulticlassStorage.h 第 73 行定义.

SGMatrix<float64_t> get_fold_ROC	(	int32_t	run,
		int32_t	fold,
		int32_t	c
	)

returns ROC of 1-v-R in given fold and run

参数

run	run
fold	fold
c	class

返回

ROC of 'run' run, 'fold' fold and 'c' class

在文件 CrossValidationMulticlassStorage.h 第 54 行定义.

SGIO * get_global_io ( )

inherited

get the io object

返回

io object

在文件 SGObject.cpp 第 235 行定义.

Parallel * get_global_parallel ( )

inherited

get the parallel object

返回

parallel object

在文件 SGObject.cpp 第 277 行定义.

Version * get_global_version ( )

inherited

get the version object

返回

version object

在文件 SGObject.cpp 第 290 行定义.

SGStringList< char > get_modelsel_names ( )

inherited

返回

vector of names of all parameters which are registered for model selection

在文件 SGObject.cpp 第 498 行定义.

char * get_modsel_param_descr ( const char *  param_name )

inherited

Returns description of a given parameter string, if it exists. SG_ERROR otherwise

参数

param_name

name of the parameter

返回

description of the parameter

在文件 SGObject.cpp 第 522 行定义.

index_t get_modsel_param_index ( const char *  param_name )

inherited

Returns index of model selection parameter with provided index

参数

param_name

name of model selection parameter

返回

index of model selection parameter with provided name, -1 if there is no such

在文件 SGObject.cpp 第 535 行定义.

virtual const char* get_name ( ) const

virtual

返回

name of SG_SERIALIZABLE

实现了 CCrossValidationOutput.

在文件 CrossValidationMulticlassStorage.h 第 179 行定义.

void init_expose_labels ( CLabels *  labels )

virtual

expose labels

参数

labels

labels to expose

重载 CCrossValidationOutput .

在文件 CrossValidationMulticlassStorage.cpp 第 94 行定义.

virtual void init_num_folds ( index_t  num_folds, const char *  prefix = ""  )

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

被 CCrossValidationPrintOutput 重载.

在文件 CrossValidationOutput.h 第 76 行定义.

virtual void init_num_runs ( index_t  num_runs, const char *  prefix = ""  )

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

被 CCrossValidationPrintOutput 重载.

在文件 CrossValidationOutput.h 第 67 行定义.

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.

参数

generic

set to the type of the generic if returning TRUE

返回

TRUE if a class template.

在文件 SGObject.cpp 第 296 行定义.

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!

参数

file	where to load from
prefix	prefix for members

返回

TRUE if done, otherwise FALSE

在文件 SGObject.cpp 第 369 行定义.

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.

异常

ShogunException

will be thrown if an error occurs.

被 CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel , 以及 CExponentialKernel 重载.

在文件 SGObject.cpp 第 426 行定义.

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.

异常

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 行定义.

bool parameter_hash_changed ( )

virtualinherited

返回

whether parameter combination has changed since last update

在文件 SGObject.cpp 第 262 行定义.

void post_init ( )

virtual

post init

重载 CCrossValidationOutput .

在文件 CrossValidationMulticlassStorage.cpp 第 58 行定义.

void post_update_results ( )

virtual

post update results

重载 CCrossValidationOutput .

在文件 CrossValidationMulticlassStorage.cpp 第 100 行定义.

void print_modsel_params ( )

inherited

prints all parameter registered for model selection and their type

在文件 SGObject.cpp 第 474 行定义.

void print_serializable ( const char *  prefix = "" )

virtualinherited

prints registered parameters out

参数

prefix

prefix for members

在文件 SGObject.cpp 第 308 行定义.

bool save_serializable ( CSerializableFile *  file, const char *  prefix = ""  )

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

返回

TRUE if done, otherwise FALSE

在文件 SGObject.cpp 第 314 行定义.

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.

异常

ShogunException

will be thrown if an error occurs.

被 CKernel 重载.

在文件 SGObject.cpp 第 436 行定义.

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.

异常

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 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 41 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 46 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 51 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 56 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 61 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 66 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 71 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 76 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 81 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 86 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 91 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 96 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 101 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 106 行定义.

void set_generic ( )

inherited

在文件 SGObject.cpp 第 111 行定义.

void set_generic ( )

inherited

set generic type to T

void set_global_io ( SGIO *  io )

inherited

set the io object

参数

io	io object to use

在文件 SGObject.cpp 第 228 行定义.

void set_global_parallel ( Parallel *  parallel )

inherited

set the parallel object

参数

parallel

parallel object to use

在文件 SGObject.cpp 第 241 行定义.

void set_global_version ( Version *  version )

inherited

set the version object

参数

version

version object to use

在文件 SGObject.cpp 第 283 行定义.

CSGObject * shallow_copy ( ) const

virtualinherited

A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.

被 CGaussianKernel 重载.

在文件 SGObject.cpp 第 192 行定义.

void unset_generic ( )

inherited

unset generic type

this has to be called in classes specializing a template class

在文件 SGObject.cpp 第 303 行定义.

virtual void update_evaluation_result ( float64_t  result, const char *  prefix = ""  )

virtualinherited

update evaluate result

参数

result	evaluation result
prefix	prefix for output

被 CCrossValidationPrintOutput 重载.

在文件 CrossValidationOutput.h 第 160 行定义.

virtual void update_fold_index ( index_t  fold_index, const char *  prefix = ""  )

virtualinherited

update fold index (called every iteration). saves to local variable

参数

fold_index	index of current run
prefix	prefix for output

被 CCrossValidationPrintOutput 重载.

在文件 CrossValidationOutput.h 第 105 行定义.

void update_parameter_hash ( )

virtualinherited

Updates the hash of current parameter combination

在文件 SGObject.cpp 第 248 行定义.

virtual void update_run_index ( index_t  run_index, const char *  prefix = ""  )

virtualinherited

update run index (called every iteration). saves to local variable

参数

run_index	index of current run
prefix	prefix for output

被 CCrossValidationPrintOutput 重载.

在文件 CrossValidationOutput.h 第 94 行定义.

virtual void update_test_indices ( SGVector< index_t >  indices, const char *  prefix = ""  )

virtualinherited

update test indices

参数

indices	indices used for testing/validation
prefix	prefix for output

被 CCrossValidationPrintOutput 重载.

在文件 CrossValidationOutput.h 第 124 行定义.

void update_test_result ( CLabels *  results, const char *  prefix = ""  )

virtual

update test result

参数

results	result labels for test/validation run
prefix	prefix for output

重载 CCrossValidationOutput .

在文件 CrossValidationMulticlassStorage.cpp 第 144 行定义.

void update_test_true_result ( CLabels *  results, const char *  prefix = ""  )

virtual

update test true result

参数

results	ground truth labels for test/validation run
prefix	prefix for output

重载 CCrossValidationOutput .

在文件 CrossValidationMulticlassStorage.cpp 第 149 行定义.

virtual void update_train_indices ( SGVector< index_t >  indices, const char *  prefix = ""  )

virtualinherited

update train indices

参数

indices	indices used for training
prefix	prefix for output

被 CCrossValidationPrintOutput 重载.

在文件 CrossValidationOutput.h 第 116 行定义.

virtual void update_trained_machine ( CMachine *  machine, const char *  prefix = ""  )

virtualinherited

update trained machine

参数

machine	trained machine instance
prefix	prefix for output

被 CCrossValidationPrintOutput , 以及 CCrossValidationMKLStorage 重载.

在文件 CrossValidationOutput.h 第 132 行定义.

类成员变量说明

SGIO* io

inherited

io

在文件 SGObject.h 第 369 行定义.

SGVector<float64_t> m_accuracies

protected

accuracies

在文件 CrossValidationMulticlassStorage.h 第 193 行定义.

CDynamicObjectArray* m_binary_evaluations

protected

custom binary evaluators

在文件 CrossValidationMulticlassStorage.h 第 187 行定义.

bool m_compute_conf_matrices

protected

whether compute confusion matrices

在文件 CrossValidationMulticlassStorage.h 第 208 行定义.

bool m_compute_PRC

protected

whether compute PRCs

在文件 CrossValidationMulticlassStorage.h 第 202 行定义.

bool m_compute_ROC

protected

whether compute ROCs

在文件 CrossValidationMulticlassStorage.h 第 196 行定义.

SGMatrix<int32_t>* m_conf_matrices

protected

confusion matrices

在文件 CrossValidationMulticlassStorage.h 第 211 行定义.

index_t m_current_fold_index

protectedinherited

current fold index is written here

在文件 CrossValidationOutput.h 第 168 行定义.

index_t m_current_run_index

protectedinherited

current run index is written here

在文件 CrossValidationOutput.h 第 165 行定义.

SGVector<float64_t> m_evaluations_results

protected

fold evaluation results

在文件 CrossValidationMulticlassStorage.h 第 190 行定义.

SGMatrix<float64_t>* m_fold_PRC_graphs

protected

fold PRC graphs

在文件 CrossValidationMulticlassStorage.h 第 205 行定义.

SGMatrix<float64_t>* m_fold_ROC_graphs

protected

fold ROC graphs

在文件 CrossValidationMulticlassStorage.h 第 199 行定义.

Parameter* m_gradient_parameters

inherited

parameters wrt which we can compute gradients

在文件 SGObject.h 第 384 行定义.

uint32_t m_hash

inherited

Hash of parameter values

在文件 SGObject.h 第 387 行定义.

bool m_initialized

protected

is initialized

在文件 CrossValidationMulticlassStorage.h 第 184 行定义.

Parameter* m_model_selection_parameters

inherited

model selection parameters

在文件 SGObject.h 第 381 行定义.

int32_t m_num_classes

protected

number of classes

在文件 CrossValidationMulticlassStorage.h 第 220 行定义.

index_t m_num_folds

protectedinherited

number of folds is initialised here

在文件 CrossValidationOutput.h 第 174 行定义.

index_t m_num_runs

protectedinherited

number of runs is initialised here

在文件 CrossValidationOutput.h 第 171 行定义.

Parameter* m_parameters

inherited

parameters

在文件 SGObject.h 第 378 行定义.

CMulticlassLabels* m_pred_labels

protected

predicted results

在文件 CrossValidationMulticlassStorage.h 第 214 行定义.

CMulticlassLabels* m_true_labels

protected

true labels

在文件 CrossValidationMulticlassStorage.h 第 217 行定义.

Parallel* parallel

inherited

parallel

在文件 SGObject.h 第 372 行定义.

Version* version

inherited

version

在文件 SGObject.h 第 375 行定义.

---

该类的文档由以下文件生成:

• CrossValidationMulticlassStorage.h
• CrossValidationMulticlassStorage.cpp