PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // StackedModulesModule.h 00004 // 00005 // Copyright (C) 2006 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 StackedModulesModule_INC 00041 #define StackedModulesModule_INC 00042 00043 #include <plearn_learners/online/OnlineLearningModule.h> 00044 00045 namespace PLearn { 00046 00055 class StackedModulesModule : public OnlineLearningModule 00056 { 00057 typedef OnlineLearningModule inherited; 00058 00059 public: 00060 //##### Public Build Options ############################################ 00061 00064 00066 TVec< PP<OnlineLearningModule> > modules; 00067 00071 bool last_layer_is_cost; 00072 00074 int target_size; 00075 00076 public: 00077 //##### Public Member Functions ######################################### 00078 00080 // ### Make sure the implementation in the .cc 00081 // ### initializes all fields to reasonable default values. 00082 StackedModulesModule(); 00083 00084 // Your other public member functions go here 00085 00087 virtual void fprop(const Vec& input, Vec& output) const; 00088 00099 // virtual void bpropUpdate(const Vec& input, const Vec& output, 00100 // const Vec& output_gradient); 00101 00103 virtual void bpropUpdate(const Vec& input, const Vec& output, 00104 Vec& input_gradient, 00105 const Vec& output_gradient); 00106 00116 // virtual void bbpropUpdate(const Vec& input, const Vec& output, 00117 // const Vec& output_gradient, 00118 // const Vec& output_diag_hessian); 00119 00121 virtual void bbpropUpdate(const Vec& input, const Vec& output, 00122 Vec& input_gradient, 00123 const Vec& output_gradient, 00124 Vec& input_diag_hessian, 00125 const Vec& output_diag_hessian); 00126 00130 virtual void forget(); 00131 00132 00137 // virtual void finalize(); 00138 00141 // virtual bool bpropDoesNothing(); 00142 00143 //##### PLearn::Object Protocol ######################################### 00144 00145 // Declares other standard object methods. 00146 // ### If your class is not instantiatable (it has pure virtual methods) 00147 // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT 00148 PLEARN_DECLARE_OBJECT(StackedModulesModule); 00149 00150 // Simply calls inherited::build() then build_() 00151 virtual void build(); 00152 00154 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00155 00156 protected: 00157 //##### Protected Options ############################################### 00158 00160 int nmodules; 00161 00162 //#### Not Options ###################################################### 00163 00164 public: // hack 00166 TVec<Vec> values; 00167 00169 Vec cost_layer_input; 00170 00172 TVec<Vec> gradients; 00173 00175 TVec<Vec> diag_hessians; 00176 00177 protected: 00178 //##### Protected Member Functions ###################################### 00179 00181 static void declareOptions(OptionList& ol); 00182 00183 private: 00184 //##### Private Member Functions ######################################## 00185 00187 void build_(); 00188 00189 void buildOptions(); 00190 void buildLayers(); 00191 00192 private: 00193 //##### Private Data Members ############################################ 00194 00195 // The rest of the private stuff goes here 00196 }; 00197 00198 // Declares a few other classes and functions related to this class 00199 DECLARE_OBJECT_PTR(StackedModulesModule); 00200 00201 } // end of namespace PLearn 00202 00203 #endif 00204 00205 00206 /* 00207 Local Variables: 00208 mode:c++ 00209 c-basic-offset:4 00210 c-file-style:"stroustrup" 00211 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00212 indent-tabs-mode:nil 00213 fill-column:79 00214 End: 00215 */ 00216 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :