SHOGUN  6.1.3
RmsPropUpdater.h
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  */
31 
32 #ifndef RMSPROPUPDATER_H
33 #define RMSPROPUPDATER_H
35 namespace shogun
36 {
56 {
57 public:
58  /* Constructor */
60 
67  RmsPropUpdater(float64_t learning_rate,float64_t epsilon,float64_t decay_factor);
68 
69  /* Destructor */
70  virtual ~RmsPropUpdater();
71 
76  virtual const char* get_name() const { return "RmsPropUpdater"; }
77 
78 
83  virtual void set_learning_rate(float64_t learning_rate);
84 
89  virtual void set_epsilon(float64_t epsilon);
90 
95  virtual void set_decay_factor(float64_t decay_factor);
96 
97 
107  virtual void update_variable(SGVector<float64_t> variable_reference,
108  SGVector<float64_t> raw_negative_descend_direction, float64_t learning_rate);
109 protected:
122  float64_t gradient, index_t idx, float64_t learning_rate);
123 
126 
129 
132 
135 private:
137  void init();
138 };
139 
140 }
141 #endif
SGVector< float64_t > m_gradient_accuracy
int32_t index_t
Definition: common.h:72
virtual void set_decay_factor(float64_t decay_factor)
virtual float64_t get_negative_descend_direction(float64_t variable, float64_t gradient, index_t idx, float64_t learning_rate)
float64_t m_build_in_learning_rate
double float64_t
Definition: common.h:60
virtual void set_learning_rate(float64_t learning_rate)
virtual void update_variable(SGVector< float64_t > variable_reference, SGVector< float64_t > raw_negative_descend_direction, float64_t learning_rate)
virtual const char * get_name() const
virtual void set_epsilon(float64_t epsilon)
all of classes and functions are contained in the shogun namespace
Definition: class_list.h:18
This is a base class for descend update with descend based correction.
The class implements the RmsProp method.

SHOGUN Machine Learning Toolbox - Documentation