SHOGUN
v3.0.0
|
Class that holds ONE combination of parameters for a learning machine. The structure is organized as a tree. Every node may hold a name or an instance of a Parameter class. Nodes may have children. The nodes are organized in such way, that every parameter of a model for model selection has one node and sub-parameters are stored in sub-nodes. Using a tree of this class, parameters of models may easily be set. There are these types of nodes:
-root node: no name and no Parameter instance, every tree has such a node as root. Has children.
-Parameter node: a node with no name and an instance of Parameter, filled with one or more values. There may be different elements in these Parameter instances. Parameter nodes may have children with sub-parameters.
Again: Leafs of the tree may only be Parameter nodes.
Definition at line 41 of file ParameterCombination.h.
Static Public Member Functions | |
static CDynamicObjectArray * | leaf_sets_multiplication (const CDynamicObjectArray &sets, const CParameterCombination *new_root) |
static DynArray< Parameter * > * | parameter_set_multiplication (const DynArray< Parameter * > &set_1, const DynArray< Parameter * > &set_2) |
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 | |
TParameter * | get_parameter_helper (const char *name) |
bool | set_parameter_helper (const char *name, bool value, index_t index) |
bool | set_parameter_helper (const char *name, int32_t value, index_t index) |
bool | set_parameter_helper (const char *name, float64_t value, index_t index) |
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) |
Static Protected Member Functions | |
static CDynamicObjectArray * | non_value_tree_multiplication (const CDynamicObjectArray *sets, const CParameterCombination *new_root) |
static CDynamicObjectArray * | extract_trees_with_name (const CDynamicObjectArray *sets, const char *desired_name) |
Protected Attributes | |
Parameter * | m_param |
CDynamicObjectArray * | m_child_nodes |
uint32_t | m_parameters_length |
Friends | |
class | CModelSelectionParameters |
constructor for a root node
Definition at line 22 of file ParameterCombination.cpp.
CParameterCombination | ( | Parameter * | param | ) |
constructor for a parameter node
param | parameter node |
Definition at line 27 of file ParameterCombination.cpp.
CParameterCombination | ( | CSGObject * | obj | ) |
constructor for an object. Builds parameter combination of the gradient parameters.
It adds parameters recursively starting from given object (given object becomes the root node).
obj | object to build parameter combination |
Definition at line 34 of file ParameterCombination.cpp.
|
virtual |
destructor also recursively destroys complete tree (SG_UNREF of child nodes)
Definition at line 118 of file ParameterCombination.cpp.
void append_child | ( | CParameterCombination * | child | ) |
appends a child to this node
child | child to append |
Definition at line 124 of file ParameterCombination.cpp.
void apply_to_machine | ( | CMachine * | machine | ) | const |
applies this parameter tree to a learning machine (wrapper for apply_to_modesel_parameter() method)
machine | learning machine to apply parameter tree to |
Definition at line 696 of file ParameterCombination.cpp.
void apply_to_modsel_parameter | ( | Parameter * | parameter | ) | const |
applies this parameter tree to a parameter instance
Recursively iterates over all children of the tree and sets model selection parameters of children to sub-parameters
parameter | Parameter instance to apply parameter tree to |
Definition at line 701 of file ParameterCombination.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 1196 of file SGObject.cpp.
|
virtual |
builds map, which contains parameters and its parents
parent_map | map, which contains parameters and its parents |
Definition at line 795 of file ParameterCombination.cpp.
|
virtual |
builds map, which contains parameters and its values.
This method adds to map only parameters of floating point type.
values_map | map, which contains parameters and its values |
Definition at line 757 of file ParameterCombination.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 1313 of file SGObject.cpp.
CParameterCombination * copy_tree | ( | ) | const |
Copies the complete tree of this node. Note that nodes are actually copied. If this is a parameter node, a NEW Parameter instance to the same data is created in the copy
Definition at line 670 of file ParameterCombination.cpp.
|
virtualinherited |
A deep copy. All the instance variables will also be copied.
Definition at line 160 of file SGObject.h.
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) |
Definition at line 1217 of file SGObject.cpp.
|
staticprotected |
Takes a set of sets of trees and extracts all trees with a given name. Assumes that in a (inner) set, all trees have the same name on their single parameter. Used by get_combinations
sets | set of sets of CParameterCombination instances to search in |
desired_name | tree with this name is searched |
Definition at line 640 of file ParameterCombination.cpp.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
Definition at line 1100 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 1124 of file SGObject.cpp.
|
inherited |
Returns index of model selection parameter with provided index
param_name | name of model selection parameter |
Definition at line 1137 of file SGObject.cpp.
|
virtual |
Implements CSGObject.
Definition at line 211 of file ParameterCombination.h.
TParameter * get_parameter | ( | const char * | name, |
CSGObject * | parent | ||
) |
Gets specific parameter by name.
name | Name of parameter |
parent | The CSObject that directly holds this parameter |
return specified parameter. NULL if not found.
Definition at line 235 of file ParameterCombination.cpp.
|
protected |
Gets parameter by name in current node.
name | name of parameter |
Definition at line 219 of file ParameterCombination.cpp.
|
virtual |
returns total length of the parameters in combination
Definition at line 220 of file ParameterCombination.h.
bool has_children | ( | ) | const |
checks whether this node has children
Definition at line 194 of file ParameterCombination.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 268 of file SGObject.cpp.
|
static |
Takes a set of sets of leafs nodes (!) and produces a set of instances of this class that contain every combination of the parameters in the leaf nodes in their Parameter variables. All combinations are put into a newly created tree. The root of this tree will be a copy of a specified node
created Parameter instances are added to the result set.
sets | Set of sets of leafs to combine |
new_root | root node that is copied and put as root into all result trees |
Definition at line 407 of file ParameterCombination.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 673 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 514 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 345 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 occurres. |
Reimplemented in CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.
Definition at line 1029 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 occurres. |
Reimplemented in CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, CDynamicArray< uint64_t >, and CDynamicObjectArray.
Definition at line 1024 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 711 of file SGObject.cpp.
void merge_with | ( | CParameterCombination * | node | ) |
Adds (copies of) all children of given node
node | (copies of) children of given node are added to this one |
Definition at line 281 of file ParameterCombination.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 918 of file SGObject.cpp.
|
staticprotected |
Takes a set of sets of (non-value) trees and returns a set with all combinations of the elements, where only combinations of trees with different names are built.
sets | set of sets of CParameterCombination instances which represent the trees to be multiplied |
new_root | this new root is put in front of all products |
Definition at line 528 of file ParameterCombination.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 858 of file SGObject.cpp.
|
static |
Returns a newly created array with pointers to newly created Parameter instances, which contain all combinations of the provided Parameters.
Definition at line 371 of file ParameterCombination.cpp.
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 1076 of file SGObject.cpp.
|
virtualinherited |
prints registered parameters out
prefix | prefix for members |
Definition at line 280 of file SGObject.cpp.
void print_tree | ( | int | prefix_num = 0 | ) | const |
Prints a representation of the current node
prefix_num | number of tabs that will be prefixed for every output. At each recursion level, one is added. |
Definition at line 292 of file ParameterCombination.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 286 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 occurres. |
Reimplemented in CKernel.
Definition at line 1039 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 occurres. |
Reimplemented in CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, CDynamicArray< uint64_t >, and CDynamicObjectArray.
Definition at line 1034 of file SGObject.cpp.
|
inherited |
set generic type to T
Definition at line 41 of file SGObject.cpp.
|
inherited |
|
inherited |
set the parallel object
parallel | parallel object to use |
Definition at line 220 of file SGObject.cpp.
|
inherited |
set the version object
version | version object to use |
Definition at line 255 of file SGObject.cpp.
Sets specific parameter to specified value.
name | Name of parameter |
value | value to be set |
parent | The CSObject that directly holds this parameter |
index | index if the parameter is a vector |
Definition at line 139 of file ParameterCombination.h.
|
protected |
Sets parameter by name in current node.
name | name of parameter |
value | of parameter |
index | index if parameter is a vector |
Definition at line 129 of file ParameterCombination.cpp.
|
protected |
Sets parameter by name in current node.
name | name of parameter |
value | of parameter |
index | index if parameter is a vector |
Definition at line 159 of file ParameterCombination.cpp.
Sets parameter by name in current node.
name | name of parameter |
value | of parameter |
index | index if parameter is a vector |
Definition at line 188 of file ParameterCombination.cpp.
|
virtualinherited |
A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.
Reimplemented in CGaussianKernel.
Definition at line 151 of file SGObject.h.
|
inherited |
unset generic type
this has to be called in classes specializing a template class
Definition at line 275 of file SGObject.cpp.
|
virtualinherited |
Updates the hash of current parameter combination.
Definition at line 227 of file SGObject.cpp.
|
friend |
Definition at line 43 of file ParameterCombination.h.
|
inherited |
io
Definition at line 514 of file SGObject.h.
|
protected |
child parameters
Definition at line 309 of file ParameterCombination.h.
|
inherited |
parameters wrt which we can compute gradients
Definition at line 529 of file SGObject.h.
|
inherited |
Hash of parameter values
Definition at line 535 of file SGObject.h.
|
inherited |
model selection parameters
Definition at line 526 of file SGObject.h.
|
protected |
parameter of combination
Definition at line 306 of file ParameterCombination.h.
|
inherited |
map for different parameter versions
Definition at line 532 of file SGObject.h.
|
inherited |
parameters
Definition at line 523 of file SGObject.h.
|
protected |
total length of the parameters in combination
Definition at line 312 of file ParameterCombination.h.
|
inherited |
parallel
Definition at line 517 of file SGObject.h.
|
inherited |
version
Definition at line 520 of file SGObject.h.