PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // GradNNetLayerModule.h 00004 // 00005 // Copyright (C) 2005 Pascal Lamblin 00006 // 00007 // Redistribution and use in source and binary forms, with or without 00008 // modification, are permitted provided that the following conditions are met: 00009 // 00010 // 1. Redistributions of source code must retain the above copyright 00011 // notice, this list of conditions and the following disclaimer. 00012 // 00013 // 2. Redistributions in binary form must reproduce the above copyright 00014 // notice, this list of conditions and the following disclaimer in the 00015 // documentation and/or other materials provided with the distribution. 00016 // 00017 // 3. The name of the authors may not be used to endorse or promote 00018 // products derived from this software without specific prior written 00019 // permission. 00020 // 00021 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR 00022 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 00023 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN 00024 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 00025 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 00026 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 00027 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 00028 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 00029 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 00030 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00031 // 00032 // This file is part of the PLearn library. For more information on the PLearn 00033 // library, go to the PLearn Web site at www.plearn.org 00034 00035 /* ******************************************************* 00036 * $Id: GradNNetLayerModule.h,v 1.3 2006/01/08 00:14:53 lamblinp Exp $ 00037 ******************************************************* */ 00038 00039 // Authors: Pascal Lamblin 00040 00044 #ifndef GradNNetLayerModule_INC 00045 #define GradNNetLayerModule_INC 00046 00047 #include <plearn/base/Object.h> 00048 #include <plearn/math/TMat_maths.h> 00049 #include "OnlineLearningModule.h" 00050 00051 namespace PLearn { 00052 00065 class GradNNetLayerModule : public OnlineLearningModule 00066 { 00067 typedef OnlineLearningModule inherited; 00068 00069 public: 00070 //##### Public Build Options ############################################ 00071 00073 real start_learning_rate; 00074 00077 real decrease_constant; 00078 00080 Mat init_weights; 00081 00083 Vec init_bias; 00084 00087 real init_weights_random_scale; 00088 00090 real L1_penalty_factor; 00091 00093 real L2_penalty_factor; 00094 00096 Mat weights; 00097 00099 Vec bias; 00100 00101 public: 00102 //##### Public Member Functions ######################################### 00103 00105 GradNNetLayerModule(); 00106 00107 // Your other public member functions go here 00108 00109 virtual void fprop(const Vec& input, Vec& output) const; 00110 00112 virtual void fprop(const Mat& inputs, Mat& outputs); 00113 00114 virtual void bpropUpdate(const Vec& input, const Vec& output, 00115 const Vec& output_gradient); 00116 00117 virtual void bpropUpdate(const Vec& input, const Vec& output, 00118 Vec& input_gradient, const Vec& output_gradient, 00119 bool accumulate=false); 00120 00121 virtual void bpropUpdate(const Mat& inputs, const Mat& outputs, 00122 Mat& input_gradients, 00123 const Mat& output_gradients, 00124 bool accumulate = false); 00125 00126 virtual void bbpropUpdate(const Vec& input, const Vec& output, 00127 const Vec& output_gradient, 00128 const Vec& output_diag_hessian); 00129 00130 /* Bad implementation. Let the parent call PLERROR. 00131 virtual void bbpropUpdate(const Vec& input, const Vec& output, 00132 Vec& input_gradient, 00133 const Vec& output_gradient, 00134 Vec& input_diag_hessian, 00135 const Vec& output_diag_hessian, 00136 bool accumulate=false); 00137 */ 00138 00139 virtual void forget(); 00140 00141 virtual void setLearningRate(real dynamic_learning_rate); 00142 00143 //##### PLearn::Object Protocol ######################################### 00144 00145 // Declares other standard object methods. 00146 PLEARN_DECLARE_OBJECT(GradNNetLayerModule); 00147 00148 // Simply calls inherited::build() then build_() 00149 virtual void build(); 00150 00152 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00153 00154 protected: 00155 00157 Vec ones; 00158 00159 //##### Protected Options ############################################### 00160 00161 protected: 00162 //##### Protected Member Functions ###################################### 00163 00165 static void declareOptions(OptionList& ol); 00166 00167 private: 00168 //##### Private Member Functions ######################################## 00169 00171 void build_(); 00172 00174 void resizeOnes(int n); 00175 00176 private: 00177 //##### Private Data Members ############################################ 00178 00179 // The rest of the private stuff goes here 00180 real learning_rate; 00181 int step_number; 00182 }; 00183 00184 // Declares a few other classes and functions related to this class 00185 DECLARE_OBJECT_PTR(GradNNetLayerModule); 00186 00187 } // end of namespace PLearn 00188 00189 #endif 00190 00191 00192 /* 00193 Local Variables: 00194 mode:c++ 00195 c-basic-offset:4 00196 c-file-style:"stroustrup" 00197 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00198 indent-tabs-mode:nil 00199 fill-column:79 00200 End: 00201 */ 00202 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :