SHOGUN
6.1.3
|
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 71 of file ModelSelectionParameters.h.
Public Types | |
typedef rxcpp::subjects::subject< ObservedValue > | SGSubject |
typedef rxcpp::observable< ObservedValue, rxcpp::dynamic_observable< ObservedValue > > | SGObservable |
typedef rxcpp::subscriber< ObservedValue, rxcpp::observer< ObservedValue, void, void, void, void > > | SGSubscriber |
Public Member Functions | |
CModelSelectionParameters () | |
CModelSelectionParameters (const char *node_name) | |
int32_t | ref () |
int32_t | ref_count () |
int32_t | unref () |
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 |
SGObservable * | get_parameters_observable () |
void | subscribe_to_parameters (ParameterObserverInterface *obs) |
void | list_observable_parameters () |
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) |
bool | clone_parameters (CSGObject *other) |
void | observe (const ObservedValue value) |
void | register_observable_param (const std::string &name, const SG_OBS_VALUE_TYPE type, const std::string &description) |
name of the parameter of the CSGObject | |||
constructor for a CSGObject node
| |||
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) | ||
CDynamicObjectArray * | get_combinations (index_t prefix_num=1) | ||
CParameterCombination * | get_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 | ||
bool | has_children () const | ||
|
inherited |
Definition at line 130 of file SGObject.h.
|
inherited |
Definition at line 127 of file SGObject.h.
|
inherited |
Definition at line 133 of file SGObject.h.
constructor for a root node
Definition at line 22 of file ModelSelectionParameters.cpp.
CModelSelectionParameters | ( | const char * | node_name | ) |
constructor for a value node
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.
void append_child | ( | CModelSelectionParameters * | child | ) |
appends a child to this tree. only possible if this is no value node
child | child to append |
Definition at line 65 of file ModelSelectionParameters.cpp.
|
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 635 of file SGObject.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 95 of file ModelSelectionParameters.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 119 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 111 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 135 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 102 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 126 of file ModelSelectionParameters.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.
Reimplemented in CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, CDynamicObjectArray, CAlphabet, and CMKL.
Definition at line 734 of file SGObject.cpp.
|
protectedinherited |
Definition at line 759 of file SGObject.cpp.
|
virtualinherited |
A deep copy. All the instance variables will also be copied.
Definition at line 232 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 656 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 381 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 404 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.
prefix_num | a number of tabs that is put before each output to have a more readable print layout |
Definition at line 339 of file ModelSelectionParameters.cpp.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
Definition at line 536 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 560 of file SGObject.cpp.
|
inherited |
Returns index of model selection parameter with provided index
param_name | name of model selection parameter |
Definition at line 573 of file SGObject.cpp.
|
virtual |
Implements CSGObject.
Definition at line 168 of file ModelSelectionParameters.h.
|
inherited |
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.
rand | Is our choice random? |
Definition at line 196 of file ModelSelectionParameters.cpp.
|
inherited |
Checks if object has a class parameter identified by a name.
name | name of the parameter |
Definition at line 304 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 315 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 326 of file SGObject.h.
|
protected |
checks if this node has children
Definition at line 188 of file ModelSelectionParameters.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 330 of file SGObject.cpp.
|
inherited |
Print to stdout a list of observable parameters
Definition at line 878 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 403 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 460 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 455 of file SGObject.cpp.
|
protectedinherited |
Observe a parameter value and emit them to observer.
value | Observed parameter's value |
Definition at line 828 of file SGObject.cpp.
|
virtualinherited |
Definition at line 296 of file SGObject.cpp.
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 512 of file SGObject.cpp.
|
virtualinherited |
prints registered parameters out
prefix | prefix for members |
Definition at line 342 of file SGObject.cpp.
void print_tree | ( | int | prefix_num = 0 | ) |
SG_PRINT's the tree of which this node is the base
prefix_num | a number of tabs that is put before each output to have a more readable print layout |
Definition at line 612 of file ModelSelectionParameters.cpp.
|
inherited |
|
inherited |
|
protectedinherited |
Register which params this object can emit.
name | the param name |
type | the param type |
description | a user oriented description |
Definition at line 871 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 472 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 485 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 348 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 470 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 465 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 342 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 368 of file SGObject.h.
|
inherited |
Definition at line 73 of file SGObject.cpp.
|
inherited |
Definition at line 78 of file SGObject.cpp.
|
inherited |
Definition at line 83 of file SGObject.cpp.
|
inherited |
Definition at line 88 of file SGObject.cpp.
|
inherited |
Definition at line 93 of file SGObject.cpp.
|
inherited |
Definition at line 98 of file SGObject.cpp.
|
inherited |
Definition at line 103 of file SGObject.cpp.
|
inherited |
Definition at line 108 of file SGObject.cpp.
|
inherited |
Definition at line 113 of file SGObject.cpp.
|
inherited |
Definition at line 118 of file SGObject.cpp.
|
inherited |
Definition at line 123 of file SGObject.cpp.
|
inherited |
Definition at line 128 of file SGObject.cpp.
|
inherited |
Definition at line 133 of file SGObject.cpp.
|
inherited |
Definition at line 138 of file SGObject.cpp.
|
inherited |
Definition at line 143 of file SGObject.cpp.
|
inherited |
set generic type to T
|
inherited |
|
inherited |
set the parallel object
parallel | parallel object to use |
Definition at line 275 of file SGObject.cpp.
|
inherited |
set the version object
version | version object to use |
Definition at line 317 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.
values | value vector. no ref counting takes place here |
value_type | type of the provided vector |
Definition at line 107 of file ModelSelectionParameters.h.
|
virtualinherited |
A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.
Reimplemented in CGaussianKernel.
Definition at line 226 of file SGObject.cpp.
|
inherited |
Subscribe a parameter observer to watch over params
Definition at line 811 of file SGObject.cpp.
|
inherited |
decrement reference counter and deallocate object if refcount is zero before or after decrementing it
Definition at line 200 of file SGObject.cpp.
|
inherited |
unset generic type
this has to be called in classes specializing a template class
Definition at line 337 of file SGObject.cpp.
|
virtualinherited |
Updates the hash of current parameter combination
Definition at line 282 of file SGObject.cpp.
|
inherited |
io
Definition at line 600 of file SGObject.h.
|
inherited |
parameters wrt which we can compute gradients
Definition at line 615 of file SGObject.h.
|
inherited |
Hash of parameter values
Definition at line 618 of file SGObject.h.
|
inherited |
model selection parameters
Definition at line 612 of file SGObject.h.
|
inherited |
parameters
Definition at line 609 of file SGObject.h.
|
inherited |
parallel
Definition at line 603 of file SGObject.h.
|
inherited |
version
Definition at line 606 of file SGObject.h.