SHOGUN  4.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
KLDualInferenceMethod.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) The Shogun Machine Learning Toolbox
3  * Written (w) 2014 Wu Lin
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright notice, this
10  * list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation
13  * and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
19  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  * The views and conclusions contained in the software and documentation are those
27  * of the authors and should not be interpreted as representing official policies,
28  * either expressed or implied, of the Shogun Development Team.
29  *
30  * the reference paper is
31  * Mohammad Emtiyaz Khan, Aleksandr Y. Aravkin, Michael P. Friedlander, Matthias Seeger
32  * Fast Dual Variational Inference for Non-Conjugate Latent Gaussian Models. ICML2013
33  *
34  */
35 
36 #ifndef _KLDUALINFERENCEMETHOD_H_
37 #define _KLDUALINFERENCEMETHOD_H_
38 
39 #include <shogun/lib/config.h>
40 
41 #ifdef HAVE_EIGEN3
44 
45 namespace shogun
46 {
47 
66 {
67 public:
70 
79  CKLDualInferenceMethod(CKernel* kernel, CFeatures* features,
80  CMeanFunction* mean, CLabels* labels, CLikelihoodModel* model);
81 
82  virtual ~CKLDualInferenceMethod();
83 
88  virtual const char* get_name() const { return "KLDualInferenceMethod"; }
89 
94  virtual EInferenceType get_inference_type() const { return INF_KL_DUAL; }
95 
102 
113  virtual SGVector<float64_t> get_alpha();
114 
127 
132  void set_model(CLikelihoodModel* mod);
133 protected:
134 
141 
146 
152  virtual void check_dual_inference(CLikelihoodModel* mod) const;
153 
155  virtual void update_approx_cov();
156 
158  virtual void update_alpha();
159 
161  virtual void update_chol();
162 
166  virtual void update_deriv();
167 
174 
183  virtual bool lbfgs_precompute();
184 
198 
200  virtual float64_t lbfgs_optimization();
201 
219 
236 
237 private:
238  void init();
239 
241  SGVector<float64_t> m_sW;
242 
247 
251  SGVector<float64_t> m_dv;
252 
254  SGVector<float64_t> m_df;
255 
266  bool m_is_dual_valid;
267 
279 
284  static float64_t evaluate(void *obj,
285  const float64_t *parameters,
286  float64_t *gradient, const int dim,
287  const float64_t step);
288 
294  static float64_t adjust_step(void *obj,
295  const float64_t *parameters,
296  const float64_t *direction,
297  const int dim, const float64_t step);
298 
299 };
300 }
301 #endif /* HAVE_EIGEN3 */
302 #endif /* _KLDUALINFERENCEMETHOD_H_ */
virtual void get_gradient_of_nlml_wrt_parameters(SGVector< float64_t > gradient)
virtual CDualVariationalGaussianLikelihood * get_dual_variational_likelihood() const
The Inference Method base class.
virtual const char * get_name() const
The class Labels models labels, i.e. class assignments of objects.
Definition: Labels.h:43
virtual EInferenceType get_inference_type() const
An abstract class of the mean function.
Definition: MeanFunction.h:49
virtual void check_dual_inference(CLikelihoodModel *mod) const
The dual KL approximation inference method class.
void set_model(CLikelihoodModel *mod)
virtual void get_gradient_of_dual_objective_wrt_parameters(SGVector< float64_t > gradient)
virtual SGVector< float64_t > get_alpha()
double float64_t
Definition: common.h:50
The KL approximation inference method class.
virtual float64_t get_derivative_related_cov(SGMatrix< float64_t > dK)
all of classes and functions are contained in the shogun namespace
Definition: class_list.h:18
The class Features is the base class of all feature objects.
Definition: Features.h:68
static CKLDualInferenceMethod * obtain_from_generic(CInferenceMethod *inference)
The Kernel base class.
Definition: Kernel.h:158
virtual float64_t get_dual_objective_wrt_parameters()
virtual float64_t get_negative_log_marginal_likelihood_helper()
virtual SGVector< float64_t > get_diagonal_vector()
Class that models dual variational likelihood.
The Likelihood model base class.

SHOGUN Machine Learning Toolbox - Documentation