PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // LinearFilterModule.h 00004 // 00005 // Copyright (C) 2005 Jerome Louradour 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: LinearFilterModule.h,v 1.3 2006/01/08 00:14:53 lamblinp Exp $ 00037 ******************************************************* */ 00038 00039 // Authors: Jerome Louradour 00040 00044 #ifndef LinearFilterModule_INC 00045 #define LinearFilterModule_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 LinearFilterModule : 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 Vec 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 Vec weights; 00097 00099 Vec bias; 00100 00101 bool no_bias; 00102 bool between_0_and_1; 00103 00104 public: 00105 //##### Public Member Functions ######################################### 00106 00108 LinearFilterModule(); 00109 00110 // Your other public member functions go here 00111 00112 virtual void fprop(const Vec& input, Vec& output) const; 00113 00115 virtual void fprop(const Mat& inputs, Mat& outputs); 00116 00117 virtual void bpropUpdate(const Vec& input, const Vec& output, 00118 const Vec& output_gradient); 00119 00120 virtual void bpropUpdate(const Vec& input, const Vec& output, 00121 Vec& input_gradient, const Vec& output_gradient, 00122 bool accumulate=false); 00123 00124 virtual void bpropUpdate(const Mat& inputs, const Mat& outputs, 00125 Mat& input_gradients, 00126 const Mat& output_gradients, 00127 bool accumulate = false); 00128 00129 virtual void bbpropUpdate(const Vec& input, const Vec& output, 00130 const Vec& output_gradient, 00131 const Vec& output_diag_hessian); 00132 00133 /* Bad implementation. Let the parent call PLERROR. 00134 virtual void bbpropUpdate(const Vec& input, const Vec& output, 00135 Vec& input_gradient, 00136 const Vec& output_gradient, 00137 Vec& input_diag_hessian, 00138 const Vec& output_diag_hessian, 00139 bool accumulate=false); 00140 */ 00141 00142 virtual void forget(); 00143 00144 virtual void setLearningRate(real dynamic_learning_rate); 00145 00146 //##### PLearn::Object Protocol ######################################### 00147 00148 // Declares other standard object methods. 00149 PLEARN_DECLARE_OBJECT(LinearFilterModule); 00150 00151 // Simply calls inherited::build() then build_() 00152 virtual void build(); 00153 00155 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00156 00157 protected: 00158 00160 Vec ones; 00161 00162 //##### Protected Options ############################################### 00163 00164 protected: 00165 //##### Protected Member Functions ###################################### 00166 00168 static void declareOptions(OptionList& ol); 00169 00170 private: 00171 //##### Private Member Functions ######################################## 00172 00174 void build_(); 00175 00177 void resizeOnes(int n); 00178 00179 private: 00180 //##### Private Data Members ############################################ 00181 00182 // The rest of the private stuff goes here 00183 real learning_rate; 00184 int step_number; 00185 }; 00186 00187 // Declares a few other classes and functions related to this class 00188 DECLARE_OBJECT_PTR(LinearFilterModule); 00189 00190 } // end of namespace PLearn 00191 00192 #endif 00193 00194 00195 /* 00196 Local Variables: 00197 mode:c++ 00198 c-basic-offset:4 00199 c-file-style:"stroustrup" 00200 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00201 indent-tabs-mode:nil 00202 fill-column:79 00203 End: 00204 */ 00205 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :