PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // ModuleStackModule.h 00004 // 00005 // Copyright (C) 2007 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 // Authors: Pascal Lamblin 00036 00040 #ifndef ModuleStackModule_INC 00041 #define ModuleStackModule_INC 00042 00043 #include <plearn_learners/online/OnlineLearningModule.h> 00044 00045 namespace PLearn { 00046 00055 class ModuleStackModule : public OnlineLearningModule 00056 { 00057 typedef OnlineLearningModule inherited; 00058 00059 public: 00060 //##### Public Build Options ############################################ 00061 00063 TVec< PP<OnlineLearningModule> > modules; 00064 00066 int n_modules; 00067 00068 public: 00069 //##### Public Member Functions ######################################### 00070 00072 ModuleStackModule(); 00073 00074 // Your other public member functions go here 00075 00077 virtual void fprop(const Vec& input, Vec& output) const; 00078 00080 virtual void fprop(const Mat& inputs, Mat& outputs); 00081 00089 virtual void bpropUpdate(const Vec& input, const Vec& output, 00090 Vec& input_gradient, 00091 const Vec& output_gradient, 00092 bool accumulate=false); 00093 00094 virtual void bpropUpdate(const Mat& inputs, const Mat& outputs, 00095 Mat& input_gradients, 00096 const Mat& output_gradients, 00097 bool accumulate = false); 00098 00100 virtual void bpropUpdate(const Vec& input, const Vec& output, 00101 const Vec& output_gradient); 00102 00107 virtual void bbpropUpdate(const Vec& input, const Vec& output, 00108 Vec& input_gradient, 00109 const Vec& output_gradient, 00110 Vec& input_diag_hessian, 00111 const Vec& output_diag_hessian, 00112 bool accumulate=false); 00113 00115 virtual void bbpropUpdate(const Vec& input, const Vec& output, 00116 const Vec& output_gradient, 00117 const Vec& output_diag_hessian); 00118 00119 00123 virtual void forget(); 00124 00125 00129 virtual void finalize(); 00130 00132 virtual bool bpropDoesNothing(); 00133 00135 virtual void setLearningRate(real dynamic_learning_rate); 00136 00137 //##### PLearn::Object Protocol ######################################### 00138 00139 // Declares other standard object methods. 00140 // ### If your class is not instantiatable (it has pure virtual methods) 00141 // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT 00142 PLEARN_DECLARE_OBJECT(ModuleStackModule); 00143 00144 // Simply calls inherited::build() then build_() 00145 virtual void build(); 00146 00148 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00149 00150 00151 protected: 00152 //##### Protected Member Functions ###################################### 00153 00155 static void declareOptions(OptionList& ol); 00156 00157 private: 00158 //##### Private Member Functions ######################################## 00159 00161 void build_(); 00162 00163 private: 00164 //##### Private Data Members ############################################ 00165 00166 // The rest of the private stuff goes here 00167 00172 mutable TVec<Vec> values; 00173 mutable TVec<Vec> gradients; 00174 mutable TVec<Vec> diag_hessians; 00175 00177 TVec<Mat> values_m; 00178 TVec<Mat> gradients_m; 00179 }; 00180 00181 // Declares a few other classes and functions related to this class 00182 DECLARE_OBJECT_PTR(ModuleStackModule); 00183 00184 } // end of namespace PLearn 00185 00186 #endif 00187 00188 00189 /* 00190 Local Variables: 00191 mode:c++ 00192 c-basic-offset:4 00193 c-file-style:"stroustrup" 00194 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00195 indent-tabs-mode:nil 00196 fill-column:79 00197 End: 00198 */ 00199 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :