PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // BaggingLearner.h 00004 // 00005 // Copyright (C) 2007 Xavier Saint-Mleux, ApSTAT Technologies inc. 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: Xavier Saint-Mleux 00036 00040 #ifndef BaggingLearner_INC 00041 #define BaggingLearner_INC 00042 00043 #include <plearn_learners/generic/PLearner.h> 00044 #include <plearn/vmat/Splitter.h> 00045 00046 namespace PLearn { 00047 00051 class BaggingLearner : public PLearner 00052 { 00053 typedef PLearner inherited; 00054 00055 public: 00056 //##### Public Build Options ############################################ 00057 00058 PP<Splitter> splitter; 00059 PP<PLearner> template_learner; 00060 00061 TVec<string> stats; 00064 int exclude_extremes; 00066 bool output_sub_outputs; 00067 00068 public: 00069 //##### Public Member Functions ######################################### 00070 00072 BaggingLearner(PP<Splitter> splitter_= 0, 00073 PP<PLearner> template_learner_= 0, 00074 TVec<string> stats_= TVec<string>(1,"E"), 00075 int exclude_extremes_= 0, 00076 bool output_sub_outputs_= false); 00077 00078 //##### PLearner Member Functions ####################################### 00079 virtual int outputsize() const; 00080 00081 virtual void forget(); 00082 00083 virtual void train(); 00084 00085 virtual void computeOutput(const Vec& input, Vec& output) const; 00086 00087 virtual void computeCostsFromOutputs(const Vec& input, const Vec& output, 00088 const Vec& target, Vec& costs) const; 00089 00090 virtual TVec<std::string> getTestCostNames() const; 00091 00092 virtual TVec<std::string> getTrainCostNames() const; 00093 00094 virtual int nTestCosts() const; 00095 virtual int nTrainCosts() const; 00096 virtual void resetInternalState(); 00097 virtual bool isStatefulLearner() const; 00098 00099 virtual void setTrainingSet(VMat training_set, bool call_forget=true); 00100 00101 virtual TVec<string> getOutputNames() const; 00102 00103 virtual void setTrainStatsCollector(PP<VecStatsCollector> statscol); 00104 00105 //##### PLearn::Object Protocol ######################################### 00106 PLEARN_DECLARE_OBJECT(BaggingLearner); 00107 00108 virtual void build(); 00109 00110 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00111 00112 virtual void setExperimentDirectory(const PPath& the_expdir); 00113 00114 protected: 00115 //##### Protected Options ############################################### 00116 00117 TVec<PP<PLearner> > learners; 00118 00119 protected: 00120 //##### Protected Member Functions ###################################### 00121 00122 static void declareOptions(OptionList& ol); 00123 00124 private: 00125 //##### Private Member Functions ######################################## 00126 00127 void build_(); 00128 00129 private: 00130 //##### Private Data Members ############################################ 00131 00132 protected: 00133 mutable VecStatsCollector stcol; 00134 mutable Mat learners_outputs; 00135 mutable Mat outputs; 00136 mutable Vec learner_costs; 00137 mutable Vec last_test_input; 00138 00139 00140 TVec<string> addStatNames(const TVec<string>& names) const 00141 { 00142 TVec<string> outputnames; 00143 for(TVec<string>::iterator it= names.begin(); it != names.end(); ++it) 00144 for(TVec<string>::const_iterator jt= stats.begin(); 00145 jt != stats.end(); ++jt) 00146 outputnames.push_back(*jt + '[' + *it + ']'); 00147 return outputnames; 00148 } 00149 00150 00151 }; 00152 00153 // Declares a few other classes and functions related to this class 00154 DECLARE_OBJECT_PTR(BaggingLearner); 00155 00156 } // end of namespace PLearn 00157 00158 #endif 00159 00160 00161 /* 00162 Local Variables: 00163 mode:c++ 00164 c-basic-offset:4 00165 c-file-style:"stroustrup" 00166 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00167 indent-tabs-mode:nil 00168 fill-column:79 00169 End: 00170 */ 00171 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :