PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // LinearCombinationModule.h 00004 // 00005 // Copyright (C) 2007 Yoshua Bengio 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 // Authors: Yoshua Bengio 00036 00040 #ifndef LinearCombinationModule_INC 00041 #define LinearCombinationModule_INC 00042 00043 #include <plearn_learners/online/OnlineLearningModule.h> 00044 00045 namespace PLearn { 00046 00052 class LinearCombinationModule : public OnlineLearningModule 00053 { 00054 typedef OnlineLearningModule inherited; 00055 00056 public: 00057 //##### Public Build Options ############################################ 00058 00060 00062 Vec weights; 00064 bool adaptive; 00066 real learning_rate; 00067 00069 TVec<string> port_names; 00070 00071 public: 00072 //##### Public Member Functions ######################################### 00073 00075 // ### Make sure the implementation in the .cc 00076 // ### initializes all fields to reasonable default values. 00077 LinearCombinationModule(); 00078 00079 // Your other public member functions go here 00080 00093 void fprop(const TVec<Mat*>& ports_value); 00094 00116 virtual void bpropAccUpdate(const TVec<Mat*>& ports_value, 00117 const TVec<Mat*>& ports_gradient); 00118 00119 /* Optional 00120 00123 virtual void fprop(const Vec& input, Vec& output) const; 00124 00127 virtual void fprop(const Mat& inputs, Mat& outputs); 00128 */ 00129 00130 /* Optional 00141 virtual void bpropUpdate(const Vec& input, const Vec& output, 00142 Vec& input_gradient, 00143 const Vec& output_gradient, 00144 bool accumulate=false); 00145 00149 virtual void bpropUpdate(const Mat& inputs, const Mat& outputs, 00150 Mat& input_gradients, 00151 const Mat& output_gradients, 00152 bool accumulate=false); 00153 */ 00154 00155 /* Optional 00158 A DEFAULT IMPLEMENTATION IS PROVIDED IN THE SUPER-CLASS, WHICH 00159 JUST CALLS 00160 bpropUpdate(input, output, input_gradient, output_gradient) 00161 AND IGNORES INPUT GRADIENT. 00163 virtual void bpropUpdate(const Vec& input, const Vec& output, 00164 const Vec& output_gradient); 00165 00169 virtual void bpropUpdate(const Mat& inputs, const Mat& outputs, 00170 const Mat& output_gradients); 00171 */ 00172 00173 /* Optional 00174 N.B. A DEFAULT IMPLEMENTATION IS PROVIDED IN THE SUPER-CLASS, WHICH 00175 RAISES A PLERROR. 00180 virtual void bbpropUpdate(const Vec& input, const Vec& output, 00181 Vec& input_gradient, 00182 const Vec& output_gradient, 00183 Vec& input_diag_hessian, 00184 const Vec& output_diag_hessian, 00185 bool accumulate=false); 00186 */ 00187 00188 /* Optional 00189 N.B. A DEFAULT IMPLEMENTATION IS PROVIDED IN THE SUPER-CLASS, 00190 WHICH JUST CALLS 00191 bbpropUpdate(input, output, input_gradient, output_gradient, 00192 out_hess, in_hess) 00193 AND IGNORES INPUT HESSIAN AND INPUT GRADIENT. 00195 virtual void bbpropUpdate(const Vec& input, const Vec& output, 00196 const Vec& output_gradient, 00197 const Vec& output_diag_hessian); 00198 */ 00199 00200 00204 virtual void forget(); 00205 00206 00207 /* Optional 00208 THE DEFAULT IMPLEMENTATION PROVIDED IN THE SUPER-CLASS DOES NOT 00209 DO ANYTHING. 00213 virtual void finalize(); 00214 */ 00215 00216 /* Optional 00217 THE DEFAULT IMPLEMENTATION PROVIDED IN THE SUPER-CLASS RETURNS false 00219 virtual bool bpropDoesNothing(); 00220 */ 00221 00222 /* Optional 00223 Default implementation prints a warning and does nothing 00226 virtual void setLearningRate(real dynamic_learning_rate); 00227 */ 00228 00230 virtual const TVec<string>& getPorts(); 00231 00232 /* Optional 00243 virtual const TMat<int>& getPortSizes(); 00244 */ 00245 00246 //##### PLearn::Object Protocol ######################################### 00247 00248 // Declares other standard object methods. 00249 // ### If your class is not instantiatable (it has pure virtual methods) 00250 // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT 00251 PLEARN_DECLARE_OBJECT(LinearCombinationModule); 00252 00253 // Simply calls inherited::build() then build_() 00254 virtual void build(); 00255 00257 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00258 00259 00260 protected: 00261 //##### Protected Member Functions ###################################### 00262 00264 static void declareOptions(OptionList& ol); 00265 00266 private: 00267 //##### Private Member Functions ######################################## 00268 00270 void build_(); 00271 00272 private: 00273 //##### Private Data Members ############################################ 00274 00275 // The rest of the private stuff goes here 00276 }; 00277 00278 // Declares a few other classes and functions related to this class 00279 DECLARE_OBJECT_PTR(LinearCombinationModule); 00280 00281 } // end of namespace PLearn 00282 00283 #endif 00284 00285 00286 /* 00287 Local Variables: 00288 mode:c++ 00289 c-basic-offset:4 00290 c-file-style:"stroustrup" 00291 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00292 indent-tabs-mode:nil 00293 fill-column:79 00294 End: 00295 */ 00296 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :