SHOGUN  4.1.0
CLogitDVGLikelihood Class Reference

## Detailed Description

Class that models dual variational logit likelihood.

This likelihood model is described in the reference paper Mohammad Emtiyaz Khan, Aleksandr Y. Aravkin, Michael P. Friedlander, Matthias Seeger Fast Dual Variational Inference for Non-Conjugate Latent Gaussian Models. ICML2013

The mathematically definition (equation 19 in the paper) is as below

$Fenchel_i(\alpha_i,\lambda_i) = max_{h_i,\rho_i}{\alpha_i h_i+\lambda_i \rho_i /2 - E_{q(f_i|h_i,\rho_i)}(-log(p(y_i|f_i)))}$

where $$\alpha_i$$, $$\lambda_i$$ are Lagrange multipliers with respective to constraints $$h_i=\mu_i$$ and $$\rho_i=\sigma_i^2$$ respectively, $$\mu$$ and $$\sigma_i$$ are variational Gaussian parameters, $$y_i$$ is data label, $$q(f_i)$$ is the variational Gaussian distribution, and $$p(y_i)$$ is the data distribution to be specified. In this setting, $$\alpha$$ and $$\lambda$$ are called dual parameters for $$\mu$$ and $$\sigma^2$$ respectively.

Note that $$p(y_i)$$ is Logistic distribution and a local variational bound defined as below is used to approximate -E_{q(f_i|h_i,)}(-log(p(y_i|f_i)))

The local variational bound used here is

$log(x) \leq t^{-1}x+log(t)-1$

, where t is a local variable and the inequality holds for every t>0. See Bernoulli-logit in Table 2 of the paper for detailed information

Definition at line 75 of file LogitDVGLikelihood.h.

Inheritance diagram for CLogitDVGLikelihood:
[legend]

## Public Member Functions

CLogitDVGLikelihood ()

virtual ~CLogitDVGLikelihood ()

virtual const char * get_name () const

virtual SGVector< float64_tget_dual_objective_value ()

virtual SGVector< float64_tget_dual_first_derivative (const TParameter *param) const

virtual float64_t get_dual_upper_bound () const

virtual float64_t get_dual_lower_bound () const

virtual bool dual_upper_bound_strict () const

virtual bool dual_lower_bound_strict () const

virtual SGVector< float64_tget_mu_dual_parameter () const

virtual SGVector< float64_tget_variance_dual_parameter () const

virtual SGVector< float64_tget_variational_expection ()

virtual SGVector< float64_tget_variational_first_derivative (const TParameter *param) const

virtual bool supports_derivative_wrt_hyperparameter () const

virtual SGVector< float64_tget_first_derivative_wrt_hyperparameter (const TParameter *param) const

virtual bool set_variational_distribution (SGVector< float64_t > mu, SGVector< float64_t > s2, const CLabels *lab)

virtual bool dual_parameters_valid () const

virtual float64_t adjust_step_wrt_dual_parameter (SGVector< float64_t > direction, const float64_t step) const

virtual void set_dual_parameters (SGVector< float64_t > the_lambda, const CLabels *lab)

virtual void set_strict_scale (float64_t strict_scale)

virtual void set_noise_factor (float64_t noise_factor)

virtual SGVector< float64_tget_predictive_means (SGVector< float64_t > mu, SGVector< float64_t > s2, const CLabels *lab=NULL) const

virtual SGVector< float64_tget_predictive_variances (SGVector< float64_t > mu, SGVector< float64_t > s2, const CLabels *lab=NULL) const

virtual ELikelihoodModelType get_model_type () const

virtual SGVector< float64_tget_log_probability_f (const CLabels *lab, SGVector< float64_t > func) const

virtual SGVector< float64_tget_log_probability_derivative_f (const CLabels *lab, SGVector< float64_t > func, index_t i) const

virtual SGVector< float64_tget_log_zeroth_moments (SGVector< float64_t > mu, SGVector< float64_t > s2, const CLabels *lab) const

virtual float64_t get_first_moment (SGVector< float64_t > mu, SGVector< float64_t > s2, const CLabels *lab, index_t i) const

virtual float64_t get_second_moment (SGVector< float64_t > mu, SGVector< float64_t > s2, const CLabels *lab, index_t i) const

virtual bool supports_regression () const

virtual bool supports_binary () const

virtual bool supports_multiclass () const

virtual SGVector< float64_tget_first_derivative (const CLabels *lab, SGVector< float64_t > func, const TParameter *param) const

virtual SGVector< float64_tget_second_derivative (const CLabels *lab, SGVector< float64_t > func, const TParameter *param) const

virtual SGVector< float64_tget_third_derivative (const CLabels *lab, SGVector< float64_t > func, const TParameter *param) const

virtual SGVector< float64_tget_predictive_log_probabilities (SGVector< float64_t > mu, SGVector< float64_t > s2, const CLabels *lab=NULL)

virtual SGVector< float64_tget_log_probability_fmatrix (const CLabels *lab, SGMatrix< float64_t > F) const

virtual SGVector< float64_tget_first_moments (SGVector< float64_t > mu, SGVector< float64_t > s2, const CLabels *lab) const

virtual SGVector< float64_tget_second_moments (SGVector< float64_t > mu, SGVector< float64_t > s2, const CLabels *lab) const

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="", 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)

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

ParameterMapm_parameter_map

uint32_t m_hash

## Protected Member Functions

virtual void init_likelihood ()

virtual void precompute ()

virtual
CVariationalGaussianLikelihood
get_variational_likelihood () const

virtual void set_likelihood (CLikelihoodModel *lik)

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)

## Protected Attributes

SGVector< float64_tm_lambda

float64_t m_strict_scale

bool m_is_valid

SGVector< float64_tm_mu

SGVector< float64_tm_s2

SGVector< float64_tm_lab

CLikelihoodModelm_likelihood

## Constructor & Destructor Documentation

 CLogitDVGLikelihood ( )

default constructor

Definition at line 47 of file LogitDVGLikelihood.cpp.

 ~CLogitDVGLikelihood ( )
virtual

Definition at line 53 of file LogitDVGLikelihood.cpp.

## Member Function Documentation

 float64_t adjust_step_wrt_dual_parameter ( SGVector< float64_t > direction, const float64_t step ) const
virtualinherited

this method is used for adjusting step size to ensure the updated value satisfied lower/upper bound constrain

The updated value is defined as below. lambda_new = m_lambda + direction * step

Parameters
 direction direction for m_lambda update step original step size (non-negative)
Returns

Definition at line 111 of file DualVariationalGaussianLikelihood.cpp.

 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
 dict dictionary of parameters to be built.

Definition at line 1244 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 1361 of file SGObject.cpp.

 CSGObject * deep_copy ( ) const
virtualinherited

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

Definition at line 200 of file SGObject.cpp.

 virtual bool dual_lower_bound_strict ( ) const
virtual

whether the lower bound is strict

Returns
true if the lower bound is strict

Implements CDualVariationalGaussianLikelihood.

Definition at line 125 of file LogitDVGLikelihood.h.

 bool dual_parameters_valid ( ) const
virtualinherited

check whether the dual parameters are valid or not.

Returns
true if dual parameters are valid

Definition at line 182 of file DualVariationalGaussianLikelihood.cpp.

 virtual bool dual_upper_bound_strict ( ) const
virtual

whether the upper bound is strict

Returns
true if the upper bound is strict

Implements CDualVariationalGaussianLikelihood.

Definition at line 119 of file LogitDVGLikelihood.h.

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

 SGVector< float64_t > get_dual_first_derivative ( const TParameter * param ) const
virtual

get the derivative of the dual objective function with respect to param

Parameters
 param parameter
Returns
the value of of the derivative

Implements CDualVariationalGaussianLikelihood.

Definition at line 93 of file LogitDVGLikelihood.cpp.

 virtual float64_t get_dual_lower_bound ( ) const
virtual

get the lower bound for dual parameter (lambda)

Returns
the lower bound

Implements CDualVariationalGaussianLikelihood.

Definition at line 113 of file LogitDVGLikelihood.h.

 SGVector< float64_t > get_dual_objective_value ( )
virtual

evaluate the dual objective function

Returns
the value of Fenchel conjugates given m_lambda

Implements CDualVariationalGaussianLikelihood.

Definition at line 74 of file LogitDVGLikelihood.cpp.

 virtual float64_t get_dual_upper_bound ( ) const
virtual

get the upper bound for dual parameter (lambda)

Returns
the upper bound

Implements CDualVariationalGaussianLikelihood.

Definition at line 107 of file LogitDVGLikelihood.h.

 SGVector< float64_t > get_first_derivative ( const CLabels * lab, SGVector< float64_t > func, const TParameter * param ) const
virtualinherited

get derivative of log likelihood $$log(p(y|f))$$ with respect to given parameter

Parameters
 lab labels used func function location param parameter
Returns
derivative

Reimplemented from CLikelihoodModel.

Definition at line 88 of file VariationalLikelihood.cpp.

 SGVector< float64_t > get_first_derivative_wrt_hyperparameter ( const TParameter * param ) const
virtualinherited

get derivative of log likelihood $$log(p(y|f))$$ with respect to given hyperparameter Note that variational parameters are NOT considered as hyperparameters

Parameters
 param parameter
Returns
derivative

Implements CVariationalLikelihood.

Definition at line 90 of file DualVariationalGaussianLikelihood.cpp.

 float64_t get_first_moment ( SGVector< float64_t > mu, SGVector< float64_t > s2, const CLabels * lab, index_t i ) const
virtualinherited

returns the first moment of a given (unnormalized) probability distribution $$q(f_i) = Z_i^-1 p(y_i|f_i)\mathcal{N}(f_i|\mu,\sigma^2)$$, where $$Z_i=\int p(y_i|f_i)\mathcal{N}(f_i|\mu,\sigma^2) df_i$$.

This method is useful for EP local likelihood approximation.

Parameters
 mu mean of the $$\mathcal{N}(f_i|\mu,\sigma^2)$$ s2 variance of the $$\mathcal{N}(f_i|\mu,\sigma^2)$$ lab labels $$y_i$$ i index i
Returns
first moment of $$q(f_i)$$

Implements CLikelihoodModel.

Definition at line 140 of file VariationalLikelihood.cpp.

 SGVector< float64_t > get_first_moments ( SGVector< float64_t > mu, SGVector< float64_t > s2, const CLabels * lab ) const
virtualinherited

returns the first moment of a given (unnormalized) probability distribution $$q(f_i) = Z_i^-1 p(y_i|f_i)\mathcal{N}(f_i|\mu,\sigma^2)$$ for each $$f_i$$, where $$Z_i=\int p(y_i|f_i)\mathcal{N}(f_i|\mu,\sigma^2) df_i$$.

Wrapper method which calls get_first_moment multiple times.

Parameters
 mu mean of the $$\mathcal{N}(f_i|\mu,\sigma^2)$$ s2 variance of the $$\mathcal{N}(f_i|\mu,\sigma^2)$$ lab labels $$y_i$$
Returns
the first moment of $$q(f_i)$$ for each $$f_i$$

Definition at line 72 of file LikelihoodModel.cpp.

 SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 237 of file SGObject.cpp.

 Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 279 of file SGObject.cpp.

 Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 292 of file SGObject.cpp.

 SGVector< float64_t > get_log_probability_derivative_f ( const CLabels * lab, SGVector< float64_t > func, index_t i ) const
virtualinherited

get derivative of log likelihood $$log(p(y|f))$$ with respect to location function $$f$$

Parameters
 lab labels used func function location i index, choices are 1, 2, and 3 for first, second, and third derivatives respectively
Returns
derivative

Implements CLikelihoodModel.

Definition at line 125 of file VariationalLikelihood.cpp.

 SGVector< float64_t > get_log_probability_f ( const CLabels * lab, SGVector< float64_t > func ) const
virtualinherited

Returns the logarithm of the point-wise likelihood $$log(p(y_i|f_i))$$ for each label $$y_i$$.

One can evaluate log-likelihood like: $$log(p(y|f)) = \sum_{i=1}^{n} log(p(y_i|f_i))$$

Parameters
 lab labels $$y_i$$ func values of the function $$f_i$$
Returns
logarithm of the point-wise likelihood

Implements CLikelihoodModel.

Definition at line 118 of file VariationalLikelihood.cpp.

 SGVector< float64_t > get_log_probability_fmatrix ( const CLabels * lab, SGMatrix< float64_t > F ) const
virtualinherited

Returns the log-likelihood $$log(p(y|f)) = \sum_{i=1}^{n} log(p(y_i|f_i))$$ for each of the provided functions $$f$$ in the given matrix.

Wrapper method which calls get_log_probability_f multiple times.

Parameters
 lab labels $$y_i$$ F values of the function $$f_i$$ where each column of the matrix is one function $$f$$.
Returns
log-likelihood for every provided function

Definition at line 51 of file LikelihoodModel.cpp.

 SGVector< float64_t > get_log_zeroth_moments ( SGVector< float64_t > mu, SGVector< float64_t > s2, const CLabels * lab ) const
virtualinherited

returns the zeroth moment of a given (unnormalized) probability distribution:

$log(Z_i) = log\left(\int p(y_i|f_i) \mathcal{N}(f_i|\mu,\sigma^2) df_i\right)$

for each $$f_i$$.

Parameters
 mu mean of the $$\mathcal{N}(f_i|\mu,\sigma^2)$$ s2 variance of the $$\mathcal{N}(f_i|\mu,\sigma^2)$$ lab labels $$y_i$$
Returns
log zeroth moment $$log(Z_i)$$

Implements CLikelihoodModel.

Definition at line 132 of file VariationalLikelihood.cpp.

 ELikelihoodModelType get_model_type ( ) const
virtualinherited

get model type

Returns
model type NONE

Reimplemented from CLikelihoodModel.

Definition at line 112 of file VariationalLikelihood.cpp.

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

Definition at line 1136 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 1160 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 1173 of file SGObject.cpp.

 SGVector< float64_t > get_mu_dual_parameter ( ) const
virtual

get the dual parameter (alpha) for variational mu

Note that alpha = m_lambda - label For detailed information, please refer to the paper.

Returns
the dual parameter (alpha)

Implements CDualVariationalGaussianLikelihood.

Definition at line 64 of file LogitDVGLikelihood.cpp.

 virtual const char* get_name ( ) const
virtual

returns the name of the likelihood model

Returns
name LogitDVGLikelihood

Reimplemented from CDualVariationalGaussianLikelihood.

Definition at line 87 of file LogitDVGLikelihood.h.

 SGVector< float64_t > get_predictive_log_probabilities ( SGVector< float64_t > mu, SGVector< float64_t > s2, const CLabels * lab = NULL )
virtualinherited

returns the logarithm of the predictive density of $$y_*$$:

$log(p(y_*|X,y,x_*)) = log\left(\int p(y_*|f_*) p(f_*|X,y,x_*) df_*\right)$

which approximately equals to

$log\left(\int p(y_*|f_*) \mathcal{N}(f_*|\mu,\sigma^2) df_*\right)$

where normal distribution $$\mathcal{N}(\mu,\sigma^2)$$ is an approximation to the posterior marginal $$p(f_*|X,y,x_*)$$.

NOTE: if lab equals to NULL, then each $$y_*$$ equals to one.

Parameters
 mu posterior mean of a Gaussian distribution $$\mathcal{N}(\mu,\sigma^2)$$, which is an approximation to the posterior marginal $$p(f_*|X,y,x_*)$$ s2 posterior variance of a Gaussian distribution $$\mathcal{N}(\mu,\sigma^2)$$, which is an approximation to the posterior marginal $$p(f_*|X,y,x_*)$$ lab labels $$y_*$$
Returns
$$log(p(y_*|X, y, x*))$$ for each label $$y_*$$

Reimplemented in CSoftMaxLikelihood.

Definition at line 45 of file LikelihoodModel.cpp.

 SGVector< float64_t > get_predictive_means ( SGVector< float64_t > mu, SGVector< float64_t > s2, const CLabels * lab = NULL ) const
virtualinherited

returns mean of the predictive marginal $$p(y_*|X,y,x_*)$$

NOTE: if lab equals to NULL, then each $$y_*$$ equals to one.

Parameters
 mu posterior mean of a Gaussian distribution $$\mathcal{N}(\mu,\sigma^2)$$, which is an approximation to the posterior marginal $$p(f_*|X,y,x_*)$$ s2 posterior variance of a Gaussian distribution $$\mathcal{N}(\mu,\sigma^2)$$, which is an approximation to the posterior marginal $$p(f_*|X,y,x_*)$$ lab labels $$y_*$$
Returns
final means evaluated by likelihood function

Implements CLikelihoodModel.

Definition at line 72 of file VariationalLikelihood.cpp.

 SGVector< float64_t > get_predictive_variances ( SGVector< float64_t > mu, SGVector< float64_t > s2, const CLabels * lab = NULL ) const
virtualinherited

returns variance of the predictive marginal $$p(y_*|X,y,x_*)$$

NOTE: if lab equals to NULL, then each $$y_*$$ equals to one.

Parameters
 mu posterior mean of a Gaussian distribution $$\mathcal{N}(\mu,\sigma^2)$$, which is an approximation to the posterior marginal $$p(f_*|X,y,x_*)$$ s2 posterior variance of a Gaussian distribution $$\mathcal{N}(\mu,\sigma^2)$$, which is an approximation to the posterior marginal $$p(f_*|X,y,x_*)$$ lab labels $$y_*$$
Returns
final variances evaluated by likelihood function

Implements CLikelihoodModel.

Definition at line 80 of file VariationalLikelihood.cpp.

 SGVector< float64_t > get_second_derivative ( const CLabels * lab, SGVector< float64_t > func, const TParameter * param ) const
virtualinherited

get derivative of the first derivative of log likelihood with respect to function location, i.e. $$\frac{\partial log(p(y|f))}{\partial f}$$ with respect to given parameter

Parameters
 lab labels used func function location param parameter
Returns
derivative

Reimplemented from CLikelihoodModel.

Definition at line 96 of file VariationalLikelihood.cpp.

 float64_t get_second_moment ( SGVector< float64_t > mu, SGVector< float64_t > s2, const CLabels * lab, index_t i ) const
virtualinherited

returns the second moment of a given (unnormalized) probability distribution $$q(f_i) = Z_i^-1 p(y_i|f_i)\mathcal{N}(f_i|\mu,\sigma^2)$$, where $$Z_i=\int p(y_i|f_i)\mathcal{N}(f_i|\mu,\sigma^2) df_i$$.

This method is useful for EP local likelihood approximation.

Parameters
 mu mean of the $$\mathcal{N}(f_i|\mu,\sigma^2)$$ s2 variance of the $$\mathcal{N}(f_i|\mu,\sigma^2)$$ lab labels $$y_i$$ i index i
Returns
the second moment of $$q(f_i)$$

Implements CLikelihoodModel.

Definition at line 148 of file VariationalLikelihood.cpp.

 SGVector< float64_t > get_second_moments ( SGVector< float64_t > mu, SGVector< float64_t > s2, const CLabels * lab ) const
virtualinherited

returns the second moment of a given (unnormalized) probability distribution $$q(f_i) = Z_i^-1 p(y_i|f_i)\mathcal{N}(f_i|\mu,\sigma^2)$$ for each $$f_i$$, where $$Z_i=\int p(y_i|f_i)\mathcal{N}(f_i|\mu,\sigma^2) df_i$$.

Wrapper method which calls get_second_moment multiple times.

Parameters
 mu mean of the $$\mathcal{N}(f_i|\mu,\sigma^2)$$ s2 variance of the $$\mathcal{N}(f_i|\mu,\sigma^2)$$ lab labels $$y_i$$
Returns
the second moment of $$q(f_i)$$ for each $$f_i$$

Definition at line 89 of file LikelihoodModel.cpp.

 SGVector< float64_t > get_third_derivative ( const CLabels * lab, SGVector< float64_t > func, const TParameter * param ) const
virtualinherited

get derivative of the second derivative of log likelihood with respect to function location, i.e. $$\frac{\partial^{2} log(p(y|f))}{\partial f^{2}}$$ with respect to given parameter

Parameters
 lab labels used func function location param parameter
Returns
derivative

Reimplemented from CLikelihoodModel.

Definition at line 104 of file VariationalLikelihood.cpp.

 SGVector< float64_t > get_variance_dual_parameter ( ) const
virtual

get the dual parameter (lambda) for variational s2

Returns
the dual parameter (lambda)

Implements CDualVariationalGaussianLikelihood.

Definition at line 57 of file LogitDVGLikelihood.cpp.

 SGVector< float64_t > get_variational_expection ( )
virtualinherited

returns the expection of the logarithm of a given probability distribution wrt the variational distribution given m_mu and m_s2

Returns
expection

Implements CVariationalLikelihood.

Definition at line 66 of file DualVariationalGaussianLikelihood.cpp.

 SGVector< float64_t > get_variational_first_derivative ( const TParameter * param ) const
virtualinherited

get derivative of the variational expection of log likelihood with respect to given parameter

Parameters
 param parameter
Returns
derivative

Implements CVariationalLikelihood.

Definition at line 78 of file DualVariationalGaussianLikelihood.cpp.

 CVariationalGaussianLikelihood * get_variational_likelihood ( ) const
protectedvirtualinherited

this method is used to dynamic-cast the likelihood model, m_likelihood, to variational likelihood model.

Definition at line 55 of file DualVariationalGaussianLikelihood.cpp.

 void init_likelihood ( )
protectedvirtual

this method is called to initialize m_likelihood in init()

Implements CVariationalGaussianLikelihood.

Definition at line 121 of file LogitDVGLikelihood.cpp.

 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 298 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::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 705 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 546 of file SGObject.cpp.

 bool load_serializable ( CSerializableFile * file, const char * prefix = "", int32_t param_version = Version::get_version_parameter() )
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
 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 375 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
 ShogunException will be thrown if an error occurs.

Definition at line 1063 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
 ShogunException will be thrown if an error occurs.

Definition at line 1058 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 743 of file SGObject.cpp.

 TParameter * migrate ( DynArray< TParameter * > * param_base, const SGParamInfo * target )
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 950 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 )
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 890 of file SGObject.cpp.

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

Definition at line 264 of file SGObject.cpp.

 void precompute ( )
protectedvirtualinherited

compute common variables later used in get_variational_expection and get_variational_first_derivative. Note that this method will automatically be called when set_variational_distribution is called

Definition at line 213 of file DualVariationalGaussianLikelihood.cpp.

 void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 1112 of file SGObject.cpp.

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

prints registered parameters out

Parameters
 prefix prefix for members

Definition at line 310 of file SGObject.cpp.

 bool save_serializable ( CSerializableFile * file, const char * prefix = "", int32_t param_version = Version::get_version_parameter() )
virtualinherited

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 316 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
 ShogunException will be thrown if an error occurs.

Reimplemented in CKernel.

Definition at line 1073 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
 ShogunException will be thrown if an error occurs.

Definition at line 1068 of file SGObject.cpp.

 void set_dual_parameters ( SGVector< float64_t > the_lambda, const CLabels * lab )
virtualinherited

set dual parameters for variational parameters

Parameters
 the_lambda dual parameter for variational mean lab labels/data used

Note that dual parameter (alpha) for the variational variance is implicitly set based on lambda

Definition at line 157 of file DualVariationalGaussianLikelihood.cpp.

 void set_generic ( )
inherited

Definition at line 42 of file SGObject.cpp.

 void set_generic ( )
inherited

Definition at line 47 of file SGObject.cpp.

 void set_generic ( )
inherited

Definition at line 52 of file SGObject.cpp.

 void set_generic ( )
inherited

Definition at line 57 of file SGObject.cpp.

 void set_generic ( )
inherited

Definition at line 62 of file SGObject.cpp.

 void set_generic ( )
inherited

Definition at line 67 of file SGObject.cpp.

 void set_generic ( )
inherited

Definition at line 72 of file SGObject.cpp.

 void set_generic ( )
inherited

Definition at line 77 of file SGObject.cpp.

 void set_generic ( )
inherited

Definition at line 82 of file SGObject.cpp.

 void set_generic ( )
inherited

Definition at line 87 of file SGObject.cpp.

 void set_generic ( )
inherited

Definition at line 92 of file SGObject.cpp.

 void set_generic ( )
inherited

Definition at line 97 of file SGObject.cpp.

 void set_generic ( )
inherited

Definition at line 102 of file SGObject.cpp.

 void set_generic ( )
inherited

Definition at line 107 of file SGObject.cpp.

 void set_generic ( )
inherited

Definition at line 112 of file SGObject.cpp.

 void set_generic ( )
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 230 of file SGObject.cpp.

 void set_global_parallel ( Parallel * parallel )
inherited

set the parallel object

Parameters
 parallel parallel object to use

Definition at line 243 of file SGObject.cpp.

 void set_global_version ( Version * version )
inherited

set the version object

Parameters
 version version object to use

Definition at line 285 of file SGObject.cpp.

 void set_likelihood ( CLikelihoodModel * lik )
protectedvirtualinherited

this method used to set m_likelihood

Definition at line 49 of file VariationalLikelihood.cpp.

 void set_noise_factor ( float64_t noise_factor )
virtualinherited

set a non-negative noise factor in order to correct the variance if variance is close to zero or negative setting 0 means correction is not applied

Parameters
 noise_factor noise factor

The default value is 1e-6.

Reimplemented from CVariationalGaussianLikelihood.

Definition at line 72 of file DualVariationalGaussianLikelihood.cpp.

 void set_strict_scale ( float64_t strict_scale )
virtualinherited

set the m_strict_scale

Parameters
 strict_scale must be between 0 and 1 exclusively

Definition at line 103 of file DualVariationalGaussianLikelihood.cpp.

 bool set_variational_distribution ( SGVector< float64_t > mu, SGVector< float64_t > s2, const CLabels * lab )
virtualinherited

set the variational distribution given data and parameters

Parameters
 mu mean of the variational distribution s2 variance of the variational distribution lab labels/data used
Returns
true if variational parameters are valid

Note that the variational distribution is Gaussian

Reimplemented from CVariationalGaussianLikelihood.

Definition at line 96 of file DualVariationalGaussianLikelihood.cpp.

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

 bool supports_binary ( ) const
virtualinherited

return whether likelihood function supports binary classification

Returns
boolean

Reimplemented from CLikelihoodModel.

Definition at line 162 of file VariationalLikelihood.cpp.

 bool supports_derivative_wrt_hyperparameter ( ) const
virtualinherited

return whether likelihood function supports computing the derivative wrt hyperparameter Note that variational parameters are NOT considered as hyperparameters

Returns
boolean

Implements CVariationalLikelihood.

Definition at line 84 of file DualVariationalGaussianLikelihood.cpp.

 bool supports_multiclass ( ) const
virtualinherited

return whether likelihood function supports multiclass classification

Returns
boolean

Reimplemented from CLikelihoodModel.

Definition at line 168 of file VariationalLikelihood.cpp.

 bool supports_regression ( ) const
virtualinherited

return whether likelihood function supports regression

Returns
boolean

Reimplemented from CLikelihoodModel.

Definition at line 156 of file VariationalLikelihood.cpp.

 void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

Definition at line 305 of file SGObject.cpp.

 void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 250 of file SGObject.cpp.

## Member Data Documentation

 SGIO* io
inherited

io

Definition at line 496 of file SGObject.h.

inherited

parameters wrt which we can compute gradients

Definition at line 511 of file SGObject.h.

 uint32_t m_hash
inherited

Hash of parameter values

Definition at line 517 of file SGObject.h.

 bool m_is_valid
protectedinherited

whether m_lambda is satisfied lower bound and/or upper bound condition.

Definition at line 238 of file DualVariationalGaussianLikelihood.h.

 SGVector m_lab
protectedinherited

the label of data

Definition at line 277 of file VariationalLikelihood.h.

 SGVector m_lambda
protectedinherited

The dual variables (lambda) for the variational parameter s2.

Note that in variational Gaussian inference, there is a relationship between lambda and alpha, where alpha is the dual parameter for variational parameter mu

Therefore, the dual variables (alpha) for variational parameter mu is not explicitly saved.

Definition at line 227 of file DualVariationalGaussianLikelihood.h.

 CLikelihoodModel* m_likelihood
protectedinherited

the distribution used to model data

Definition at line 280 of file VariationalLikelihood.h.

 Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 508 of file SGObject.h.

 SGVector m_mu
protectedinherited

The mean of variational Gaussian distribution

Definition at line 79 of file VariationalGaussianLikelihood.h.

 ParameterMap* m_parameter_map
inherited

map for different parameter versions

Definition at line 514 of file SGObject.h.

 Parameter* m_parameters
inherited

parameters

Definition at line 505 of file SGObject.h.

 SGVector m_s2
protectedinherited

The variance of variational Gaussian distribution

Definition at line 82 of file VariationalGaussianLikelihood.h.

 float64_t m_strict_scale
protectedinherited

The value used to ensure strict bound(s) for m_lambda in adjust_step_wrt_dual_parameter()

Note that the value should be between 0 and 1 exclusively.

The default value is 1e-5.

Definition at line 235 of file DualVariationalGaussianLikelihood.h.

 Parallel* parallel
inherited

parallel

Definition at line 499 of file SGObject.h.

 Version* version
inherited

version

Definition at line 502 of file SGObject.h.

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

SHOGUN Machine Learning Toolbox - Documentation