SHOGUN  4.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
SVRGMinimizer.cpp
Go to the documentation of this file.
1  /*
2  * Copyright (c) The Shogun Machine Learning Toolbox
3  * Written (w) 2015 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  */
35 using namespace shogun;
36 
39 {
40  init();
41 }
42 
44 {
45 }
46 
49 {
50  init();
51 }
52 
53 void SVRGMinimizer::init()
54 {
59 }
60 
62 {
64  REQUIRE(m_num_sgd_passes>=0, "sgd_passes must set\n");
65  REQUIRE(m_svrg_interval>0, "svrg_interval must set\n");
67  REQUIRE(fun,"the cost function must be a stochastic average gradient cost function\n");
68  if (m_num_sgd_passes>0)
69  {
70  SGDMinimizer sgd(fun);
76  sgd.minimize();
78  }
79 }
80 
82 {
84 
87  REQUIRE(fun,"the cost function must be a stochastic average gradient cost function\n");
89  {
91  {
93  m_previous_variable=SGVector<float64_t>(variable_reference.vlen);
94 
95  std::copy(variable_reference.vector, variable_reference.vector+variable_reference.vlen, m_previous_variable.vector);
97  }
98  fun->begin_sample();
99  while(fun->next_sample())
100  {
101  m_iter_counter++;
102  float64_t learning_rate=1.0;
103  if(m_learning_rate)
105 
107  SGVector<float64_t> var(variable_reference.vlen);
108  std::copy(variable_reference.vector, variable_reference.vector+variable_reference.vlen, var.vector);
109 
112 
113  std::copy(var.vector, var.vector+var.vlen, variable_reference.vector);
114  for(index_t idx=0; idx<grad_new.vlen; idx++)
115  grad_new[idx]+=(m_average_gradient[idx]-grad_old[idx]);
116 
117  update_gradient(grad_new,variable_reference);
118  m_gradient_updater->update_variable(variable_reference,grad_new,learning_rate);
119 
120  do_proximal_operation(variable_reference);
121  }
122  }
123  float64_t cost=m_fun->get_cost();
124  return cost+get_penalty(variable_reference);
125 }
virtual SGVector< float64_t > get_gradient()=0
The class is about a stochastic cost function for stochastic average minimizers.
virtual void set_number_passes(int32_t num_passes)
virtual float64_t minimize()
virtual void set_gradient_updater(DescendUpdater *gradient_updater)
virtual void set_learning_rate(LearningRate *learning_rate)
virtual void update_gradient(SGVector< float64_t > gradient, SGVector< float64_t > var)
int32_t index_t
Definition: common.h:62
virtual void set_penalty_weight(float64_t penalty_weight)
FirstOrderCostFunction * m_fun
#define REQUIRE(x,...)
Definition: SGIO.h:206
virtual void update_variable(SGVector< float64_t > variable_reference, SGVector< float64_t > negative_descend_direction, float64_t learning_rate)=0
virtual float64_t minimize()
The base class for stochastic first-order gradient-based minimizers.
virtual void init_minimization()
index_t vlen
Definition: SGVector.h:494
SGVector< float64_t > m_previous_variable
double float64_t
Definition: common.h:50
SGVector< float64_t > m_average_gradient
virtual float64_t get_penalty(SGVector< float64_t > var)
virtual float64_t get_cost()=0
virtual SGVector< float64_t > get_average_gradient()=0
all of classes and functions are contained in the shogun namespace
Definition: class_list.h:18
virtual float64_t get_learning_rate(int32_t iter_counter)=0
virtual void set_penalty_type(Penalty *penalty_type)
virtual SGVector< float64_t > obtain_variable_reference()=0
virtual void do_proximal_operation(SGVector< float64_t >variable_reference)
The class implements the stochastic gradient descend (SGD) minimizer.
Definition: SGDMinimizer.h:45

SHOGUN Machine Learning Toolbox - Documentation