PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // ChainedLearners.h 00004 // 00005 // Copyright (C) 2006 Pascal Vincent 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 Vincent 00036 00040 #ifndef ChainedLearners_INC 00041 #define ChainedLearners_INC 00042 00043 #include <plearn_learners/generic/PLearner.h> 00044 00045 namespace PLearn { 00046 00057 class ChainedLearners : public PLearner 00058 { 00059 typedef PLearner inherited; 00060 00061 public: 00062 //##### Public Build Options ############################################ 00063 00066 00067 TVec< PP<PLearner> > learners; 00068 00069 public: 00070 //##### Public Member Functions ######################################### 00071 00073 // ### Make sure the implementation in the .cc 00074 // ### initializes all fields to reasonable default values. 00075 ChainedLearners(); 00076 00077 00078 //##### PLearner Member Functions ####################################### 00079 00082 // (PLEASE IMPLEMENT IN .cc) 00083 virtual int outputsize() const; 00084 00088 // (PLEASE IMPLEMENT IN .cc) 00089 virtual void forget(); 00090 00091 00092 virtual void setTrainingSet(VMat training_set, bool call_forget=true); 00093 00094 00098 // (PLEASE IMPLEMENT IN .cc) 00099 virtual void train(); 00100 00102 // (PLEASE IMPLEMENT IN .cc) 00103 virtual void computeOutput(const Vec& input, Vec& output) const; 00104 00106 // (PLEASE IMPLEMENT IN .cc) 00107 virtual void computeCostsFromOutputs(const Vec& input, const Vec& output, 00108 const Vec& target, Vec& costs) const; 00109 00112 // (PLEASE IMPLEMENT IN .cc) 00113 virtual TVec<std::string> getTestCostNames() const; 00114 00117 // (PLEASE IMPLEMENT IN .cc) 00118 virtual TVec<std::string> getTrainCostNames() const; 00119 00120 00121 virtual TVec<string> getOutputNames() const; 00122 00123 virtual void setExperimentDirectory(const PPath& the_expdir); 00124 00125 00126 // *** SUBCLASS WRITING: *** 00127 // While in general not necessary, in case of particular needs 00128 // (efficiency concerns for ex) you may also want to overload 00129 // some of the following methods: 00130 // virtual void computeOutputAndCosts(const Vec& input, const Vec& target, 00131 // Vec& output, Vec& costs) const; 00132 // virtual void computeCostsOnly(const Vec& input, const Vec& target, 00133 // Vec& costs) const; 00134 // virtual void test(VMat testset, PP<VecStatsCollector> test_stats, 00135 // VMat testoutputs=0, VMat testcosts=0) const; 00136 // virtual int nTestCosts() const; 00137 // virtual int nTrainCosts() const; 00138 // virtual void resetInternalState(); 00139 // virtual bool isStatefulLearner() const; 00140 00141 00142 //##### PLearn::Object Protocol ######################################### 00143 00144 // Declares other standard object methods. 00145 // ### If your class is not instantiatable (it has pure virtual methods) 00146 // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS 00147 PLEARN_DECLARE_OBJECT(ChainedLearners); 00148 00149 // Simply calls inherited::build() then build_() 00150 virtual void build(); 00151 00153 // (PLEASE IMPLEMENT IN .cc) 00154 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00155 00156 protected: 00157 //##### Protected Options ############################################### 00158 00159 // ### Declare protected option fields (such as learned parameters) here 00160 // ... 00161 00162 protected: 00163 //##### Protected Member Functions ###################################### 00164 00165 mutable Vec tmp_input; 00166 mutable Vec tmp_output; 00167 00169 // (PLEASE IMPLEMENT IN .cc) 00170 static void declareOptions(OptionList& ol); 00171 00172 private: 00173 //##### Private Member Functions ######################################## 00174 00176 // (PLEASE IMPLEMENT IN .cc) 00177 void build_(); 00178 00179 private: 00180 //##### Private Data Members ############################################ 00181 00182 // The rest of the private stuff goes here 00183 }; 00184 00185 // Declares a few other classes and functions related to this class 00186 DECLARE_OBJECT_PTR(ChainedLearners); 00187 00188 } // end of namespace PLearn 00189 00190 #endif 00191 00192 00193 /* 00194 Local Variables: 00195 mode:c++ 00196 c-basic-offset:4 00197 c-file-style:"stroustrup" 00198 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00199 indent-tabs-mode:nil 00200 fill-column:79 00201 End: 00202 */ 00203 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :