SHOGUN  4.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
List of all members | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
CMultitaskKernelMaskNormalizer Class Reference

Detailed Description

The MultitaskKernel allows Multitask Learning via a modified kernel function.

The user defines a set of active tasks. Subsequently, only similarities between active tasks are taken into account. Kernel entries between tasks of which at least one is not an active tasks are set to zero.

\[ K_S(x,y)=\left\{\begin{array}{cl} K_B(x,y), & \mbox{if } t(x) \in S \wedge t(y) \in S\\ 0, & \mbox{else} \end{array}\right. \]

Definition at line 36 of file MultitaskKernelMaskNormalizer.h.

Inheritance diagram for CMultitaskKernelMaskNormalizer:
Inheritance graph
[legend]

Public Member Functions

 CMultitaskKernelMaskNormalizer ()
 
 CMultitaskKernelMaskNormalizer (std::vector< int32_t > task_lhs, std::vector< int32_t > task_rhs, std::vector< int32_t > active_tasks_vec)
 
virtual ~CMultitaskKernelMaskNormalizer ()
 
virtual bool init (CKernel *k)
 
virtual float64_t normalize (float64_t value, int32_t idx_lhs, int32_t idx_rhs)
 
virtual float64_t normalize_lhs (float64_t value, int32_t idx_lhs)
 
virtual float64_t normalize_rhs (float64_t value, int32_t idx_rhs)
 
std::vector< int32_t > get_task_vector_lhs () const
 
void set_task_vector_lhs (std::vector< int32_t > vec)
 
std::vector< int32_t > get_task_vector_rhs () const
 
void set_task_vector_rhs (std::vector< int32_t > vec)
 
void set_task_vector (std::vector< int32_t > vec)
 
float64_t get_similarity (int32_t task_lhs, int32_t task_rhs)
 
std::vector< int32_t > get_active_tasks ()
 
float64_t get_normalization_constant () const
 
float64_t set_normalization_constant (float64_t constant)
 
virtual const char * get_name () const
 
CMultitaskKernelMaskNormalizerKernelNormalizerToMultitaskKernelMaskNormalizer (CKernelNormalizer *n)
 
virtual void register_params ()
 
ENormalizerType get_normalizer_type ()
 
void set_normalizer_type (ENormalizerType type)
 
virtual CSGObjectshallow_copy () const
 
virtual CSGObjectdeep_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)
 
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_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 CSGObjectclone ()
 

Public Attributes

SGIOio
 
Parallelparallel
 
Versionversion
 
Parameterm_parameters
 
Parameterm_model_selection_parameters
 
Parameterm_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)
 

Protected Attributes

std::set< int32_t > active_tasks
 
std::vector< int32_t > task_vector_lhs
 
std::vector< int32_t > task_vector_rhs
 
float64_t scale
 
float64_t normalization_constant
 
ENormalizerType m_type
 

Constructor & Destructor Documentation

default constructor

Definition at line 43 of file MultitaskKernelMaskNormalizer.h.

CMultitaskKernelMaskNormalizer ( std::vector< int32_t >  task_lhs,
std::vector< int32_t >  task_rhs,
std::vector< int32_t >  active_tasks_vec 
)

default constructor

Parameters
task_lhstask vector with containing task_id for each example for left hand side
task_rhstask vector with containing task_id for each example for right hand side
active_tasks_vec

Definition at line 54 of file MultitaskKernelMaskNormalizer.h.

virtual ~CMultitaskKernelMaskNormalizer ( )
virtual

default destructor

Definition at line 74 of file MultitaskKernelMaskNormalizer.h.

Member Function Documentation

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.

Parameters
dictdictionary of parameters to be built.

Definition at line 597 of file SGObject.cpp.

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.

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 714 of file SGObject.cpp.

CSGObject * deep_copy ( ) const
virtualinherited

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

Definition at line 198 of file SGObject.cpp.

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.

Parameters
otherobject to compare with
accuracyaccuracy to use for comparison (optional)
tolerantallows linient check on float equality (within accuracy)
Returns
true if all parameters were equal, false if not

Definition at line 618 of file SGObject.cpp.

std::vector<int32_t> get_active_tasks ( )
Returns
list of active task ids

Definition at line 229 of file MultitaskKernelMaskNormalizer.h.

SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 235 of file SGObject.cpp.

Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 277 of file SGObject.cpp.

Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 290 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 498 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_namename of the parameter
Returns
description of the parameter

Definition at line 522 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_namename of model selection parameter
Returns
index of model selection parameter with provided name, -1 if there is no such

Definition at line 535 of file SGObject.cpp.

virtual const char* get_name ( ) const
virtual
Returns
object name

Implements CSGObject.

Definition at line 263 of file MultitaskKernelMaskNormalizer.h.

float64_t get_normalization_constant ( ) const
Returns
normalization constant

Definition at line 246 of file MultitaskKernelMaskNormalizer.h.

ENormalizerType get_normalizer_type ( )
inherited

getter for normalizer type

Definition at line 102 of file KernelNormalizer.h.

float64_t get_similarity ( int32_t  task_lhs,
int32_t  task_rhs 
)
Parameters
task_lhstask_id on left hand side
task_rhstask_id on right hand side
Returns
similarity between tasks

Definition at line 209 of file MultitaskKernelMaskNormalizer.h.

std::vector<int32_t> get_task_vector_lhs ( ) const
Returns
vec task vector with containing task_id for each example on left hand side

Definition at line 156 of file MultitaskKernelMaskNormalizer.h.

std::vector<int32_t> get_task_vector_rhs ( ) const
Returns
vec task vector with containing task_id for each example on right hand side

Definition at line 177 of file MultitaskKernelMaskNormalizer.h.

virtual bool init ( CKernel k)
virtual

initialization of the normalizer

Parameters
kkernel

Implements CKernelNormalizer.

Definition at line 80 of file MultitaskKernelMaskNormalizer.h.

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
genericset to the type of the generic if returning TRUE
Returns
TRUE if a class template.

Definition at line 296 of file SGObject.cpp.

CMultitaskKernelMaskNormalizer* KernelNormalizerToMultitaskKernelMaskNormalizer ( CKernelNormalizer n)

casts kernel normalizer to multitask kernel mask normalizer

Parameters
nkernel normalizer to cast

Definition at line 271 of file MultitaskKernelMaskNormalizer.h.

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!

Parameters
filewhere to load from
prefixprefix 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 369 of file SGObject.cpp.

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.

Exceptions
ShogunExceptionwill be thrown if an error occurs.

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

Definition at line 426 of file SGObject.cpp.

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.

Exceptions
ShogunExceptionwill 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 421 of file SGObject.cpp.

virtual float64_t normalize ( float64_t  value,
int32_t  idx_lhs,
int32_t  idx_rhs 
)
virtual

normalize the kernel value

Parameters
valuekernel value
idx_lhsindex of left hand side vector
idx_rhsindex of right hand side vector

Implements CKernelNormalizer.

Definition at line 117 of file MultitaskKernelMaskNormalizer.h.

virtual float64_t normalize_lhs ( float64_t  value,
int32_t  idx_lhs 
)
virtual

normalize only the left hand side vector

Parameters
valuevalue of a component of the left hand side feature vector
idx_lhsindex of left hand side vector

Implements CKernelNormalizer.

Definition at line 139 of file MultitaskKernelMaskNormalizer.h.

virtual float64_t normalize_rhs ( float64_t  value,
int32_t  idx_rhs 
)
virtual

normalize only the right hand side vector

Parameters
valuevalue of a component of the right hand side feature vector
idx_rhsindex of right hand side vector

Implements CKernelNormalizer.

Definition at line 149 of file MultitaskKernelMaskNormalizer.h.

bool parameter_hash_changed ( )
virtualinherited
Returns
whether parameter combination has changed since last update

Definition at line 262 of file SGObject.cpp.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 474 of file SGObject.cpp.

void print_serializable ( const char *  prefix = "")
virtualinherited

prints registered parameters out

Parameters
prefixprefix for members

Definition at line 308 of file SGObject.cpp.

virtual void register_params ( )
virtualinherited

register the parameters

Reimplemented in CMultitaskKernelPlifNormalizer.

Definition at line 94 of file KernelNormalizer.h.

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

Save this object to file.

Parameters
filewhere to save the object; will be closed during returning if PREFIX is an empty string.
prefixprefix 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 314 of file SGObject.cpp.

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.

Exceptions
ShogunExceptionwill be thrown if an error occurs.

Reimplemented in CKernel.

Definition at line 436 of file SGObject.cpp.

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.

Exceptions
ShogunExceptionwill 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 431 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 41 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 46 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 51 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 56 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 61 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 66 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 71 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 76 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 81 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 86 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 91 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 96 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 101 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 106 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 111 of file SGObject.cpp.

void set_generic ( )
inherited

set generic type to T

void set_global_io ( SGIO io)
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_infoinformation of parameter
file_versionparameter version of the file, must be <= provided parameter version
filefile to load from
prefixprefix for members
Returns
new array with TParameter instances with the attached data set the io object
Parameters
ioio object to use

Definition at line 228 of file SGObject.cpp.

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 241 of file SGObject.cpp.

void set_global_version ( Version version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 283 of file SGObject.cpp.

float64_t set_normalization_constant ( float64_t  constant)
Parameters
constantnormalization constant

Definition at line 254 of file MultitaskKernelMaskNormalizer.h.

void set_normalizer_type ( ENormalizerType  type)
inherited

setter for normalizer type

Parameters
typetype of normalizer

Definition at line 110 of file KernelNormalizer.h.

void set_task_vector ( std::vector< int32_t >  vec)
Parameters
vectask vector with containing task_id for each example

Definition at line 197 of file MultitaskKernelMaskNormalizer.h.

void set_task_vector_lhs ( std::vector< int32_t >  vec)
Parameters
vectask vector with containing task_id for each example

Definition at line 163 of file MultitaskKernelMaskNormalizer.h.

void set_task_vector_rhs ( std::vector< int32_t >  vec)
Parameters
vectask vector with containing task_id for each example

Definition at line 184 of file MultitaskKernelMaskNormalizer.h.

CSGObject * shallow_copy ( ) const
virtualinherited

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

Reimplemented in CGaussianKernel.

Definition at line 192 of file SGObject.cpp.

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

Definition at line 303 of file SGObject.cpp.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 248 of file SGObject.cpp.

Member Data Documentation

std::set<int32_t> active_tasks
protected

list of active tasks

Definition at line 278 of file MultitaskKernelMaskNormalizer.h.

SGIO* io
inherited

io

Definition at line 387 of file SGObject.h.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

Definition at line 402 of file SGObject.h.

uint32_t m_hash
inherited

Hash of parameter values

Definition at line 405 of file SGObject.h.

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 399 of file SGObject.h.

Parameter* m_parameters
inherited

parameters

Definition at line 396 of file SGObject.h.

ENormalizerType m_type
protectedinherited

normalizer type

Definition at line 117 of file KernelNormalizer.h.

float64_t normalization_constant
protected

outer normalization constant

Definition at line 290 of file MultitaskKernelMaskNormalizer.h.

Parallel* parallel
inherited

parallel

Definition at line 390 of file SGObject.h.

float64_t scale
protected

value of first element

Definition at line 287 of file MultitaskKernelMaskNormalizer.h.

std::vector<int32_t> task_vector_lhs
protected

task vector indicating to which task each example on the left hand side belongs

Definition at line 281 of file MultitaskKernelMaskNormalizer.h.

std::vector<int32_t> task_vector_rhs
protected

task vector indicating to which task each example on the right hand side belongs

Definition at line 284 of file MultitaskKernelMaskNormalizer.h.

Version* version
inherited

version

Definition at line 393 of file SGObject.h.


The documentation for this class was generated from the following file:

SHOGUN Machine Learning Toolbox - Documentation