SHOGUN
4.1.0
Main Page
Related Pages
Modules
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Modules
Pages
src
shogun
optimization
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
34
#include <
shogun/optimization/DescendUpdaterWithCorrection.h
>
35
#include <
shogun/optimization/LearningRate.h
>
36
namespace
shogun
37
{
56
class
RmsPropUpdater
:
public
DescendUpdaterWithCorrection
57
{
58
public
:
59
/* Constructor */
60
RmsPropUpdater
();
61
68
RmsPropUpdater
(
float64_t
learning_rate,
float64_t
epsilon
,
float64_t
decay_factor);
69
70
/* Destructor */
71
virtual
~RmsPropUpdater
();
72
77
virtual
void
set_learning_rate
(
float64_t
learning_rate);
78
83
virtual
void
set_epsilon
(
float64_t
epsilon);
84
89
virtual
void
set_decay_factor
(
float64_t
decay_factor);
90
98
virtual
void
update_context
(
CMinimizerContext
* context);
99
108
virtual
void
load_from_context
(
CMinimizerContext
* context);
109
119
virtual
void
update_variable
(
SGVector<float64_t>
variable_reference,
120
SGVector<float64_t>
raw_negative_descend_direction,
float64_t
learning_rate);
121
protected
:
133
virtual
float64_t
get_negative_descend_direction
(
float64_t
variable,
134
float64_t
gradient,
index_t
idx,
float64_t
learning_rate);
135
137
float64_t
m_build_in_learning_rate
;
138
140
float64_t
m_epsilon
;
141
143
float64_t
m_decay_factor
;
144
146
SGVector<float64_t>
m_gradient_accuracy
;
147
private
:
149
void
init();
150
};
151
152
}
153
#endif
shogun::RmsPropUpdater::load_from_context
virtual void load_from_context(CMinimizerContext *context)
Definition:
RmsPropUpdater.cpp:96
shogun::RmsPropUpdater::m_gradient_accuracy
SGVector< float64_t > m_gradient_accuracy
Definition:
RmsPropUpdater.h:146
index_t
int32_t index_t
Definition:
common.h:62
shogun::CMinimizerContext
The class is used to serialize and deserialize variables for the optimization framework.
Definition:
MinimizerContext.h:45
DescendUpdaterWithCorrection.h
shogun::RmsPropUpdater::set_decay_factor
virtual void set_decay_factor(float64_t decay_factor)
Definition:
RmsPropUpdater.cpp:65
shogun::epsilon
static const float64_t epsilon
Definition:
libbmrm.cpp:25
shogun::RmsPropUpdater::get_negative_descend_direction
virtual float64_t get_negative_descend_direction(float64_t variable, float64_t gradient, index_t idx, float64_t learning_rate)
Definition:
RmsPropUpdater.cpp:107
shogun::RmsPropUpdater::m_build_in_learning_rate
float64_t m_build_in_learning_rate
Definition:
RmsPropUpdater.h:137
shogun::SGVector< float64_t >
float64_t
double float64_t
Definition:
common.h:50
shogun::RmsPropUpdater::set_learning_rate
virtual void set_learning_rate(float64_t learning_rate)
Definition:
RmsPropUpdater.cpp:51
shogun::RmsPropUpdater::update_variable
virtual void update_variable(SGVector< float64_t > variable_reference, SGVector< float64_t > raw_negative_descend_direction, float64_t learning_rate)
Definition:
RmsPropUpdater.cpp:119
shogun::RmsPropUpdater::set_epsilon
virtual void set_epsilon(float64_t epsilon)
Definition:
RmsPropUpdater.cpp:58
shogun::RmsPropUpdater::update_context
virtual void update_context(CMinimizerContext *context)
Definition:
RmsPropUpdater.cpp:84
shogun::RmsPropUpdater::~RmsPropUpdater
virtual ~RmsPropUpdater()
Definition:
RmsPropUpdater.cpp:73
shogun::RmsPropUpdater::m_decay_factor
float64_t m_decay_factor
Definition:
RmsPropUpdater.h:143
shogun::RmsPropUpdater::RmsPropUpdater
RmsPropUpdater()
Definition:
RmsPropUpdater.cpp:36
shogun
all of classes and functions are contained in the shogun namespace
Definition:
class_list.h:18
LearningRate.h
shogun::DescendUpdaterWithCorrection
This is a base class for descend update with descend based correction.
Definition:
DescendUpdaterWithCorrection.h:52
shogun::RmsPropUpdater
The class implements the RmsProp method.
Definition:
RmsPropUpdater.h:56
shogun::RmsPropUpdater::m_epsilon
float64_t m_epsilon
Definition:
RmsPropUpdater.h:140
SHOGUN
Machine Learning Toolbox - Documentation