Public Member Functions | Public Attributes | Protected Member Functions

CModelSelectionParameters Class Reference


Detailed Description

Class to select parameters and their ranges for model selection. The structure is organized as a tree with different kinds of nodes, depending on the values of its member variables of name and CSGObject.

-root node: no name and no CSGObject, may have children

-CSGObject node: has name and a CSGObject, may have children which are the parameters of the CSGObject. CSGObjects are SG_REF'ed/SG_UNREF'ed

-value node: a node with a (parameter) name and an array of values for that parameter. These ranges may be set using build_values(). This node is always a leaf.

After a (legal!) tree is constructed with the append_child method, all possible combinations that are implied by this tree may be extracted with the get_combinations method. It generates a set of trees (different kind than this one) that contain the instantiated parameter combinations.

Definition at line 68 of file ModelSelectionParameters.h.

Inheritance diagram for CModelSelectionParameters:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CModelSelectionParameters ()
 CModelSelectionParameters (const char *node_name)
virtual CSGObjectshallow_copy () const
virtual CSGObjectdeep_copy () const
virtual bool is_generic (EPrimitiveType *generic) const
template<class T >
void set_generic ()
void unset_generic ()
virtual void print_serializable (const char *prefix="")
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)
SGIOget_global_io ()
void set_global_parallel (Parallel *parallel)
Parallelget_global_parallel ()
void set_global_version (Version *version)
Versionget_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_parameter_dictionary (CMap< TParameter *, CSGObject * > &dict)

Public Attributes

SGIOio
Parallelparallel
Versionversion
Parameterm_parameters
Parameterm_model_selection_parameters
ParameterMapm_parameter_map
uint32_t m_hash

Protected Member Functions

virtual TParametermigrate (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)
virtual bool update_parameter_hash ()

name of the parameter of the CSGObject

constructor for a CSGObject node

Parameters:
sgobject the CSGObject for this node. Is SG_REF'ed


 CModelSelectionParameters (const char *node_name, CSGObject *sgobject)
 ~CModelSelectionParameters ()
void append_child (CModelSelectionParameters *child)
template<class T >
void set_values (const SGVector< T > &values, EMSParamType value_type)
void print_tree (int prefix_num=0)
CDynamicObjectArrayget_combinations (index_t prefix_num=1)
CParameterCombinationget_single_combination (bool rand=true)
void build_values (float64_t min, float64_t max, ERangeType type, float64_t step=1.0, float64_t type_base=2.0)
void build_values_vector (float64_t min, float64_t max, ERangeType type, void *vector, index_t *size, float64_t step=1.0, float64_t type_base=2.0)
void build_values_sgvector (float64_t min, float64_t max, ERangeType type, void *vector, float64_t step=1.0, float64_t type_base=2.0)
void build_values (int32_t min, int32_t max, ERangeType type, int32_t step=1, int32_t type_base=2)
void build_values_vector (int32_t min, int32_t max, ERangeType type, void *vector, index_t *size, int32_t step=1, int32_t type_base=2)
void build_values_sgvector (int32_t min, int32_t max, ERangeType type, void *vector, int32_t step=1, int32_t type_base=2)
virtual const char * get_name () const
virtual bool save_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=VERSION_PARAMETER)
virtual bool load_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=VERSION_PARAMETER)
bool has_children () const

Constructor & Destructor Documentation

constructor for a root node

Definition at line 22 of file ModelSelectionParameters.cpp.

CModelSelectionParameters ( const char *  node_name  ) 

constructor for a value node

Parameters:
node_name name of the parameter the values will belong to

Definition at line 27 of file ModelSelectionParameters.cpp.

CModelSelectionParameters ( const char *  node_name,
CSGObject sgobject 
)

Definition at line 34 of file ModelSelectionParameters.cpp.

destructor. If set, deletes data array and SG_UNREF's the CSGObject

Definition at line 57 of file ModelSelectionParameters.cpp.


Member Function Documentation

void append_child ( CModelSelectionParameters child  ) 

appends a child to this tree. only possible if this is no value node

Parameters:
child child to append

Definition at line 65 of file ModelSelectionParameters.cpp.

void build_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.

Parameters:
dict dictionary of parameters to be built.

Definition at line 1201 of file SGObject.cpp.

void build_values ( int32_t  min,
int32_t  max,
ERangeType  type,
int32_t  step = 1,
int32_t  type_base = 2 
)

int32_t wrapper for build_values()

Definition at line 130 of file ModelSelectionParameters.cpp.

void build_values ( float64_t  min,
float64_t  max,
ERangeType  type,
float64_t  step = 1.0,
float64_t  type_base = 2.0 
)

float64_t wrapper for build_values()

Definition at line 106 of file ModelSelectionParameters.cpp.

void build_values_sgvector ( float64_t  min,
float64_t  max,
ERangeType  type,
void *  vector,
float64_t  step = 1.0,
float64_t  type_base = 2.0 
)

Definition at line 122 of file ModelSelectionParameters.cpp.

void build_values_sgvector ( int32_t  min,
int32_t  max,
ERangeType  type,
void *  vector,
int32_t  step = 1,
int32_t  type_base = 2 
)

Definition at line 146 of file ModelSelectionParameters.cpp.

void build_values_vector ( int32_t  min,
int32_t  max,
ERangeType  type,
void *  vector,
index_t size,
int32_t  step = 1,
int32_t  type_base = 2 
)

Definition at line 137 of file ModelSelectionParameters.cpp.

void build_values_vector ( float64_t  min,
float64_t  max,
ERangeType  type,
void *  vector,
index_t size,
float64_t  step = 1.0,
float64_t  type_base = 2.0 
)

Definition at line 113 of file ModelSelectionParameters.cpp.

virtual CSGObject* deep_copy (  )  const [virtual, inherited]

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

Definition at line 131 of file SGObject.h.

CDynamicObjectArray * get_combinations ( index_t  prefix_num = 1  ) 

most important method. If the tree was regarding node types and structure, a set of trees which contain all combinations of parameters that are implied by this tree is generated.

Parameters:
prefix_num a number of tabs that is put before each output to have a more readable print layout
Returns:
result all trees of parameter combinations are put into here

Definition at line 350 of file ModelSelectionParameters.cpp.

SGIO * get_global_io (  )  [inherited]

get the io object

Returns:
io object

Definition at line 224 of file SGObject.cpp.

Parallel * get_global_parallel (  )  [inherited]

get the parallel object

Returns:
parallel object

Definition at line 259 of file SGObject.cpp.

Version * get_global_version (  )  [inherited]

get the version object

Returns:
version object

Definition at line 272 of file SGObject.cpp.

SGStringList< char > get_modelsel_names (  )  [inherited]
Returns:
vector of names of all parameters which are registered for model selection

Definition at line 1108 of file SGObject.cpp.

char * get_modsel_param_descr ( const char *  param_name  )  [inherited]

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

Parameters:
param_name name of the parameter
Returns:
description of the parameter

Definition at line 1132 of file SGObject.cpp.

index_t get_modsel_param_index ( const char *  param_name  )  [inherited]

Returns index of model selection parameter with provided index

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

Definition at line 1145 of file SGObject.cpp.

virtual const char* get_name (  )  const [virtual]
Returns:
name of the SGSerializable

Implements CSGObject.

Definition at line 158 of file ModelSelectionParameters.h.

CParameterCombination * get_single_combination ( bool  rand = true  ) 

Instead of generating an array of combinations, get_single_combination generates a single combination of parameters. The choice of values is constrained by the value arrays built by build_values. The choice of values may be random. If not, the lowest possible values are chosen.

Parameters:
rand Is our choice random?
Returns:
parameter tree of random parameter values.

Definition at line 207 of file ModelSelectionParameters.cpp.

bool has_children (  )  const [protected]

checks if this node has children

Returns:
true if it has children

Definition at line 194 of file ModelSelectionParameters.h.

bool is_generic ( EPrimitiveType *  generic  )  const [virtual, inherited]

If the SGSerializable is a class template then TRUE will be returned and GENERIC is set to the type of the generic.

Parameters:
generic set to the type of the generic if returning TRUE
Returns:
TRUE if a class template.

Definition at line 278 of file SGObject.cpp.

DynArray< TParameter * > * load_all_file_parameters ( int32_t  file_version,
int32_t  current_version,
CSerializableFile file,
const char *  prefix = "" 
) [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)

Parameters:
file_version parameter version of the file
current_version version from which mapping begins (you want to use VERSION_PARAMETER for this in most cases)
file file to load from
prefix prefix for members
Returns:
(sorted) array of created TParameter instances with file data

Definition at line 679 of file SGObject.cpp.

DynArray< TParameter * > * load_file_parameters ( const SGParamInfo param_info,
int32_t  file_version,
CSerializableFile file,
const char *  prefix = "" 
) [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

Parameters:
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
Returns:
new array with TParameter instances with the attached data

Definition at line 523 of file SGObject.cpp.

virtual bool load_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = VERSION_PARAMETER 
) [virtual]

Not allowed for this class, throws an error

Reimplemented from CSGObject.

Definition at line 172 of file ModelSelectionParameters.h.

void load_serializable_post (  )  throw (ShogunException) [protected, virtual, inherited]

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.

Exceptions:
ShogunException Will be thrown if an error occurres.

Reimplemented in CLinearHMM, CAlphabet, CANOVAKernel, CCircularKernel, CExponentialKernel, CGaussianKernel, CInverseMultiQuadricKernel, CKernel, CWeightedDegreePositionStringKernel, and CList.

Definition at line 1033 of file SGObject.cpp.

void load_serializable_pre (  )  throw (ShogunException) [protected, virtual, inherited]

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.

Exceptions:
ShogunException Will be thrown if an error occurres.

Definition at line 1028 of file SGObject.cpp.

void map_parameters ( DynArray< TParameter * > *  param_base,
int32_t &  base_version,
DynArray< const SGParamInfo * > *  target_param_infos 
) [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

Parameters:
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 717 of file SGObject.cpp.

TParameter * migrate ( DynArray< TParameter * > *  param_base,
const SGParamInfo target 
) [protected, virtual, inherited]

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

Parameters:
param_base set of TParameter instances to use for migration
target parameter info for the resulting TParameter
Returns:
a new TParameter instance with migrated data from the base of the type which is specified by the target parameter

Definition at line 923 of file SGObject.cpp.

void one_to_one_migration_prepare ( DynArray< TParameter * > *  param_base,
const SGParamInfo target,
TParameter *&  replacement,
TParameter *&  to_migrate,
char *  old_name = NULL 
) [protected, virtual, inherited]

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)

Parameters:
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 864 of file SGObject.cpp.

void print_modsel_params (  )  [inherited]

prints all parameter registered for model selection and their type

Definition at line 1084 of file SGObject.cpp.

void print_serializable ( const char *  prefix = ""  )  [virtual, inherited]

prints registered parameters out

Parameters:
prefix prefix for members

Definition at line 290 of file SGObject.cpp.

void print_tree ( int  prefix_num = 0  ) 

SG_PRINT's the tree of which this node is the base

Parameters:
prefix_num a number of tabs that is put before each output to have a more readable print layout

Definition at line 623 of file ModelSelectionParameters.cpp.

virtual bool save_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = VERSION_PARAMETER 
) [virtual]

Not allowed for this class, throws an error

Reimplemented from CSGObject.

Definition at line 164 of file ModelSelectionParameters.h.

void save_serializable_post (  )  throw (ShogunException) [protected, virtual, inherited]

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.

Exceptions:
ShogunException Will be thrown if an error occurres.

Reimplemented in CKernel.

Definition at line 1043 of file SGObject.cpp.

void save_serializable_pre (  )  throw (ShogunException) [protected, virtual, inherited]

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.

Exceptions:
ShogunException Will be thrown if an error occurres.

Reimplemented in CKernel.

Definition at line 1038 of file SGObject.cpp.

void set_generic< floatmax_t > (  )  [inherited]

set generic type to T

void set_global_io ( SGIO io  )  [inherited]

set the io object

Parameters:
io io object to use

Definition at line 217 of file SGObject.cpp.

void set_global_parallel ( Parallel parallel  )  [inherited]

set the parallel object

Parameters:
parallel parallel object to use

Definition at line 230 of file SGObject.cpp.

void set_global_version ( Version version  )  [inherited]

set the version object

Parameters:
version version object to use

Definition at line 265 of file SGObject.cpp.

void set_values ( const SGVector< T > &  values,
EMSParamType  value_type 
)

setter for values of this node. If the latter are not possible to be produced by set_range, a vector may be specified directly.

Parameters:
values value vector. no ref counting takes place here
value_type type of the provided vector

Definition at line 96 of file ModelSelectionParameters.cpp.

virtual CSGObject* shallow_copy (  )  const [virtual, inherited]

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

Reimplemented in CGaussianKernel.

Definition at line 122 of file SGObject.h.

void unset_generic (  )  [inherited]

unset generic type

this has to be called in classes specializing a template class

Definition at line 285 of file SGObject.cpp.

bool update_parameter_hash (  )  [protected, virtual, inherited]

Updates the hash of current parameter combination.

Returns:
bool if parameter combination has changed since last update.

Definition at line 237 of file SGObject.cpp.


Member Data Documentation

SGIO* io [inherited]

io

Definition at line 462 of file SGObject.h.

uint32_t m_hash [inherited]

Hash of parameter values

Definition at line 480 of file SGObject.h.

model selection parameters

Definition at line 474 of file SGObject.h.

map for different parameter versions

Definition at line 477 of file SGObject.h.

Parameter* m_parameters [inherited]

parameters

Definition at line 471 of file SGObject.h.

Parallel* parallel [inherited]

parallel

Definition at line 465 of file SGObject.h.

Version* version [inherited]

version

Definition at line 468 of file SGObject.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

SHOGUN Machine Learning Toolbox - Documentation