PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // StackedModulesLearner.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 StackedModulesLearner_INC 00041 #define StackedModulesLearner_INC 00042 00043 #include <plearn_learners/generic/PLearner.h> 00044 00045 namespace PLearn { 00046 00047 class OnlineLearningModule; 00048 class PRandom; 00049 00063 class StackedModulesLearner : public PLearner 00064 { 00065 typedef PLearner inherited; 00066 00067 public: 00068 //##### Public Build Options ############################################ 00069 00071 TVec< PP<OnlineLearningModule> > modules; 00072 00077 TVec<string> cost_funcs; 00078 00083 string hessian_estimation; 00084 00085 00086 public: 00087 //##### Public Member Functions ######################################### 00088 00090 // ### Make sure the implementation in the .cc 00091 // ### initializes all fields to reasonable default values. 00092 StackedModulesLearner(); 00093 00094 00095 //##### PLearner Member Functions ####################################### 00096 00099 // (PLEASE IMPLEMENT IN .cc) 00100 virtual int outputsize() const; 00101 00105 // (PLEASE IMPLEMENT IN .cc) 00106 virtual void forget(); 00107 00111 // (PLEASE IMPLEMENT IN .cc) 00112 virtual void train(); 00113 00115 // (PLEASE IMPLEMENT IN .cc) 00116 virtual void computeOutput(const Vec& input, Vec& output) const; 00117 00119 // (PLEASE IMPLEMENT IN .cc) 00120 virtual void computeCostsFromOutputs(const Vec& input, const Vec& output, 00121 const Vec& target, Vec& costs) const; 00122 00125 // (PLEASE IMPLEMENT IN .cc) 00126 virtual TVec<std::string> getTestCostNames() const; 00127 00130 // (PLEASE IMPLEMENT IN .cc) 00131 virtual TVec<std::string> getTrainCostNames() const; 00132 00133 00134 // *** SUBCLASS WRITING: *** 00135 // While in general not necessary, in case of particular needs 00136 // (efficiency concerns for ex) you may also want to overload 00137 // some of the following methods: 00138 // virtual void computeOutputAndCosts(const Vec& input, const Vec& target, 00139 // Vec& output, Vec& costs) const; 00140 // virtual void computeCostsOnly(const Vec& input, const Vec& target, 00141 // Vec& costs) const; 00142 // virtual void test(VMat testset, PP<VecStatsCollector> test_stats, 00143 // VMat testoutputs=0, VMat testcosts=0) const; 00144 // virtual int nTestCosts() const; 00145 // virtual int nTrainCosts() const; 00146 // virtual void resetInternalState(); 00147 // virtual bool isStatefulLearner() const; 00148 00149 00150 //##### PLearn::Object Protocol ######################################### 00151 00152 // Declares other standard object methods. 00153 // ### If your class is not instantiatable (it has pure virtual methods) 00154 // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS 00155 PLEARN_DECLARE_OBJECT(StackedModulesLearner); 00156 00157 // Simply calls inherited::build() then build_() 00158 virtual void build(); 00159 00161 // (PLEASE IMPLEMENT IN .cc) 00162 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00163 00164 protected: 00165 //##### Protected Options ############################################### 00166 00167 // ### Declare protected option fields (such as learned parameters) here 00168 00170 int nmodules; 00171 00173 TVec< PP<OnlineLearningModule> > cost_modules; 00174 00176 int ncosts; 00177 00178 //#### Not Options ###################################################### 00179 00181 TVec<Vec> values; 00182 00184 TVec<Vec> gradients; 00185 00187 TVec<Vec> diag_hessians; 00188 00189 protected: 00190 //##### Protected Member Functions ###################################### 00191 00193 // (PLEASE IMPLEMENT IN .cc) 00194 static void declareOptions(OptionList& ol); 00195 00196 private: 00197 //##### Private Member Functions ######################################## 00198 00200 // (PLEASE IMPLEMENT IN .cc) 00201 void build_(); 00202 00203 void buildOptions(); 00204 void buildCostFunctions(); 00205 void buildLayers(); 00206 00207 private: 00208 //##### Private Data Members ############################################ 00209 00210 // The rest of the private stuff goes here 00211 }; 00212 00213 // Declares a few other classes and functions related to this class 00214 DECLARE_OBJECT_PTR(StackedModulesLearner); 00215 00216 } // end of namespace PLearn 00217 00218 #endif 00219 00220 00221 /* 00222 Local Variables: 00223 mode:c++ 00224 c-basic-offset:4 00225 c-file-style:"stroustrup" 00226 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00227 indent-tabs-mode:nil 00228 fill-column:79 00229 End: 00230 */ 00231 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :