PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // ShuntingNNetLayerModule.h 00004 // 00005 // Copyright (C) 2008 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: ShuntingNNetLayerModule.h,v 1.3 2006/01/08 00:14:53 lamblinp Exp $ 00037 ******************************************************* */ 00038 00039 // Authors: Jerome Louradour 00040 00044 #ifndef ShuntingNNetLayerModule_INC 00045 #define ShuntingNNetLayerModule_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 ShuntingNNetLayerModule : 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 00081 real init_weights_random_scale; 00082 real init_quad_weights_random_scale; 00083 00085 int n_filters; 00086 int n_filters_inhib; 00087 00089 TVec<Mat> excit_quad_weights; 00090 TVec<Mat> inhib_quad_weights; 00091 Mat excit_weights; 00092 00094 Vec bias; 00095 00098 Vec excit_num_coeff; 00099 Vec inhib_num_coeff; 00100 00101 00102 public: 00103 //##### Public Member Functions ######################################### 00104 00106 ShuntingNNetLayerModule(); 00107 00108 // Your other public member functions go here 00109 00110 virtual void fprop(const Vec& input, Vec& output) const; 00111 00113 virtual void fprop(const Mat& inputs, Mat& outputs); 00114 00115 virtual void bpropUpdate(const Vec& input, const Vec& output, 00116 const Vec& output_gradient); 00117 00118 virtual void bpropUpdate(const Mat& inputs, const Mat& outputs, 00119 Mat& input_gradients, 00120 const Mat& output_gradients, 00121 bool accumulate = false); 00122 00123 virtual void forget(); 00124 00125 virtual void setLearningRate(real dynamic_learning_rate); 00126 00127 //##### PLearn::Object Protocol ######################################### 00128 00129 // Declares other standard object methods. 00130 PLEARN_DECLARE_OBJECT(ShuntingNNetLayerModule); 00131 00132 // Simply calls inherited::build() then build_() 00133 virtual void build(); 00134 00136 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00137 00138 protected: 00139 00141 mutable Vec ones; 00142 00143 mutable Mat batch_excitations; 00144 mutable Mat batch_inhibitions; 00145 00146 //##### Protected Options ############################################### 00147 00148 protected: 00149 //##### Protected Member Functions ###################################### 00150 00152 static void declareOptions(OptionList& ol); 00153 00154 private: 00155 //##### Private Member Functions ######################################## 00156 00158 void build_(); 00159 00161 void resizeOnes(int n) const; 00162 00163 private: 00164 //##### Private Data Members ############################################ 00165 00166 // The rest of the private stuff goes here 00167 real learning_rate; 00168 int step_number; 00169 }; 00170 00171 // Declares a few other classes and functions related to this class 00172 DECLARE_OBJECT_PTR(ShuntingNNetLayerModule); 00173 00174 } // end of namespace PLearn 00175 00176 #endif 00177 00178 00179 /* 00180 Local Variables: 00181 mode:c++ 00182 c-basic-offset:4 00183 c-file-style:"stroustrup" 00184 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00185 indent-tabs-mode:nil 00186 fill-column:79 00187 End: 00188 */ 00189 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :