Class CKernelDependenceMaximization, that uses an implementation of CKernelIndependenceTest to compute dependence measures for feature selection. Different kernels are used for labels and data. For the sake of computational convenience, the precompute() method is overridden to precompute the kernel for labels and save as an instance of CCustomKernel.
Definition at line 49 of file KernelDependenceMaximization.h.
|
| CKernelDependenceMaximization () |
|
virtual | ~CKernelDependenceMaximization () |
|
void | set_kernel_features (CKernel *kernel) |
|
CKernel * | get_kernel_features () const |
|
void | set_kernel_labels (CKernel *kernel) |
|
CKernel * | get_kernel_labels () const |
|
virtual void | set_algorithm (EFeatureSelectionAlgorithm algorithm)=0 |
|
virtual const char * | get_name () const |
|
virtual float64_t | compute_measures (CFeatures *features, index_t idx) |
|
virtual CFeatures * | remove_feats (CFeatures *features, SGVector< index_t > ranks) |
|
virtual void | set_policy (EFeatureRemovalPolicy policy) |
|
virtual bool | init (CFeatures *features) |
|
virtual void | set_labels (CLabels *labels) |
|
virtual CFeatures * | apply (CFeatures *features) |
|
virtual EFeatureClass | get_feature_class () |
|
virtual EFeatureType | get_feature_type () |
|
virtual EPreprocessorType | get_type () const |
|
void | set_target_dim (index_t target_dim) |
|
index_t | get_target_dim () const |
|
EFeatureSelectionAlgorithm | get_algorithm () const |
|
EFeatureRemovalPolicy | get_policy () const |
|
void | set_num_remove (index_t num_remove) |
|
index_t | get_num_remove () const |
|
CLabels * | get_labels () const |
|
virtual void | cleanup () |
|
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="", int32_t param_version=Version::get_version_parameter()) |
|
virtual bool | load_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=Version::get_version_parameter()) |
|
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) |
|
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 () |
|
virtual void adapt_params |
( |
CFeatures * |
features | ) |
|
|
protectedvirtualinherited |
Tunes the parameters which are required to compute the measure based on current features. Overridden in the subclasses. Here it does nothing.
- Parameters
-
features | the features based on which parameters are needed to be tuned for computing measures |
Generic interface for applying the feature selection preprocessor. Acts as a wrapper which decides which actual method to call based on the algorithm specified.
- Parameters
-
features | the input features |
- Returns
- the result feature object after applying the preprocessor
Implements CPreprocessor.
|
protectedvirtualinherited |
Applies backward elimination algorithm for performing feature selection. After performing necessary precomputing (defined by subclasses), it iteratively eliminates a number of features based on a measure until target dimension is reached.
- Parameters
-
features | the input features |
- Returns
- the result feature object after applying the preprocessor
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 1185 of file SGObject.cpp.
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.
- Returns
- 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
Definition at line 1302 of file SGObject.cpp.
Method that computes the measures using test statistic computed by an instance of CIndependenceTest wiht the provided features and the labels
- Parameters
-
features | the features on which the measure has to be computed |
idx | the index that decides which features should we compute the measure on |
- Returns
- the measure based on which features are selected
Implements CFeatureSelection< float64_t >.
Definition at line 105 of file DependenceMaximization.cpp.
|
protectedvirtualinherited |
Helper method which removes the dimension specified via the index. It copies the rest of the features into a separate object via copy_dimension_subset() call.
- Parameters
-
features | the features |
idx | index of the dimension which is required to be removed |
- Returns
- a new feature object with the specified dimension removed
Definition at line 77 of file DependenceMaximization.cpp.
A deep copy. All the instance variables will also be copied.
Definition at line 146 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.
- Parameters
-
other | object to compare with |
accuracy | accuracy to use for comparison (optional) |
tolerant | allows linient check on float equality (within accuracy) |
- Returns
- true if all parameters were equal, false if not
Definition at line 1206 of file SGObject.cpp.
- Returns
- the feature removal algorithm being used
get the io object
- Returns
- io object
Definition at line 183 of file SGObject.cpp.
get the parallel object
- Returns
- parallel object
Definition at line 224 of file SGObject.cpp.
get the version object
- Returns
- version object
Definition at line 237 of file SGObject.cpp.
CKernel * get_kernel_features |
( |
| ) |
const |
CKernel * get_kernel_labels |
( |
| ) |
const |
- Returns
- vector of names of all parameters which are registered for model selection
Definition at line 1077 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 1101 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 1114 of file SGObject.cpp.
virtual const char* get_name |
( |
| ) |
const |
|
virtual |
Returns the number of features of the provided feature object. Since the number of features doesn't make sense for all types of features, this helper method checks whether obtaining a num_features is possible and then calls get_num_features() on those features after proper type-cast
- Parameters
-
features | the feature object |
- Returns
- the number of features
- Returns
- number or percentage of features removed in each iteration
- Returns
- the feature removal policy being used
- Returns
- the target dimension
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.
- Parameters
-
generic | set to the type of the generic if returning TRUE |
- Returns
- TRUE if a class template.
Definition at line 243 of file SGObject.cpp.
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::get_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 648 of file SGObject.cpp.
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 489 of file SGObject.cpp.
Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!
- Parameters
-
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) |
- Returns
- TRUE if done, otherwise FALSE
Definition at line 320 of file SGObject.cpp.
|
protectedvirtualinherited |
|
protectedvirtualinherited |
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 686 of file SGObject.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
- 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 893 of file SGObject.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)
- 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 833 of file SGObject.cpp.
bool parameter_hash_changed |
( |
| ) |
|
|
virtualinherited |
- Returns
- whether parameter combination has changed since last update
Definition at line 209 of file SGObject.cpp.
void print_modsel_params |
( |
| ) |
|
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 1053 of file SGObject.cpp.
void print_serializable |
( |
const char * |
prefix = "" | ) |
|
|
virtualinherited |
prints registered parameters out
- Parameters
-
Definition at line 255 of file SGObject.cpp.
Method which handles the removal of features based on removal policy. see documentation of CFeatureSelection. For dependence maximization approach, the lowest scoring features are removed. Therefore, only m_policy can only be N_SMALLEST, PERCENTILE_SMALLEST. see set_policy() method for specifying the exact policy
- Parameters
-
features | the features object from which specific features has to be removed |
ranks | the ranks of the features based on their measures, 0 being the lowest rank which corresponds to smallest measure. |
- Returns
- the feature object after removal of features based on the policy
Implements CFeatureSelection< float64_t >.
Definition at line 129 of file DependenceMaximization.cpp.
Save this object to file.
- Parameters
-
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) |
- Returns
- TRUE if done, otherwise FALSE
Definition at line 261 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.
- Exceptions
-
Reimplemented in CKernel.
Definition at line 1014 of file SGObject.cpp.
|
protectedvirtualinherited |
Abstract method which is overridden in the subclasses to set accepted feature selection algorithm
- Parameters
-
algorithm | the feature selection algorithm to use |
Implements CDependenceMaximization.
Implemented in CBAHSIC.
void set_global_io |
( |
SGIO * |
io | ) |
|
|
inherited |
void set_global_parallel |
( |
Parallel * |
parallel | ) |
|
|
inherited |
set the parallel object
- Parameters
-
parallel | parallel object to use |
Definition at line 189 of file SGObject.cpp.
void set_global_version |
( |
Version * |
version | ) |
|
|
inherited |
set the version object
- Parameters
-
version | version object to use |
Definition at line 230 of file SGObject.cpp.
void set_kernel_features |
( |
CKernel * |
kernel | ) |
|
void set_kernel_labels |
( |
CKernel * |
kernel | ) |
|
void set_labels |
( |
CLabels * |
labels | ) |
|
|
virtualinherited |
Setter for labels. This method is overridden to internally convert the labels to a dense feature object and set this feature in the independence test estimator. These labels serve as samples \(\mathbf{Y}\sim q\) in the independence test
- Parameters
-
Reimplemented from CFeatureSelection< float64_t >.
Definition at line 181 of file DependenceMaximization.cpp.
void set_num_remove |
( |
index_t |
num_remove | ) |
|
|
inherited |
Use this method to set the number or percentile of features to be removed in each iteration.
- Parameters
-
num_remove | number or percentage of features to be removed in each iteration |
void set_target_dim |
( |
index_t |
target_dim | ) |
|
|
inherited |
- Parameters
-
target_dim | the target dimension to achieve |
A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.
Reimplemented in CGaussianKernel.
Definition at line 140 of file SGObject.cpp.
unset generic type
this has to be called in classes specializing a template class
Definition at line 250 of file SGObject.cpp.
void update_parameter_hash |
( |
| ) |
|
|
virtualinherited |
Updates the hash of current parameter combination
Definition at line 196 of file SGObject.cpp.
The estimator for performing statistical tests for independence which is used for computing measures
Definition at line 154 of file DependenceMaximization.h.
parameters wrt which we can compute gradients
Definition at line 476 of file SGObject.h.
Hash of parameter values
Definition at line 482 of file SGObject.h.
model selection parameters
Definition at line 473 of file SGObject.h.
Number or percentage of features to be removed. When the policy is set as ::N_SMALLEST or ::N_LARGEST, this number decides how many features in an iteration. For ::PERCENTILE_SMALLEST or ::PERCENTILE_LARGEST, this decides the percentage of current number of features to be removed in each iteration
Definition at line 304 of file FeatureSelection.h.
map for different parameter versions
Definition at line 479 of file SGObject.h.
The documentation for this class was generated from the following files: