PLearn 0.1
StackedLearner.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // StackedLearner.h
00004 //
00005 // Copyright (C) 2003 Yoshua Bengio 
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 /* *******************************************************      
00036  * $Id: StackedLearner.h 3994 2005-08-25 13:35:03Z chapados $
00037  ******************************************************* */
00038 
00039 // Authors: Yoshua Bengio
00040 
00043 #ifndef StackedLearner_INC
00044 #define StackedLearner_INC
00045 
00046 #include "PLearner.h"
00047 #include <plearn/vmat/Splitter.h>
00048 
00049 namespace PLearn {
00050 using namespace std;
00051 
00052 class StackedLearner: public PLearner
00053 {
00054     typedef PLearner inherited;
00055   
00056 protected:
00060     TVec< Vec > base_learners_outputs;
00061 
00063     mutable Vec all_base_learners_outputs;
00064 
00065 
00066 public:
00067 
00068     // ************************
00069     // * public build options *
00070     // ************************
00071 
00074     TVec<PP<PLearner> > base_learners;
00075 
00079     PP<PLearner> combiner;
00080 
00084     string default_operation;
00085 
00088     PP<Splitter> splitter;
00089 
00093     PP<Splitter> base_train_splitter;
00094 
00097     bool train_base_learners;
00098 
00101     bool normalize_base_learners_output;
00102 
00105     bool precompute_base_learners_output;
00106   
00108     bool put_raw_input;
00109 
00112     bool share_learner;
00113 
00115     int nsep;
00116 
00119     bool put_costs;
00120 
00121     // ****************
00122     // * Constructors *
00123     // ****************
00124 
00126     StackedLearner();
00127 
00128 
00129     // ******************
00130     // * PLearner methods *
00131     // ******************
00132 
00133 private: 
00134 
00136     void build_();
00137 
00139     void resizeBaseLearnersOutputs();
00140 
00141 protected: 
00142 
00144     static void declareOptions(OptionList& ol);
00145 
00146 public:
00147 
00148     // ************************
00149     // **** Object methods ****
00150     // ************************
00151 
00153     void setTrainStatsCollector(PP<VecStatsCollector> statscol);
00154 
00156     virtual void setExperimentDirectory(const PPath& the_expdir);
00157 
00159     virtual void build();
00160 
00162     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00163 
00164     // Declares other standard object methods
00165     PLEARN_DECLARE_OBJECT(StackedLearner);
00166 
00167 
00168     // **************************
00169     // **** PLearner methods ****
00170     // **************************
00171 
00174     virtual int outputsize() const;
00175 
00178     virtual void forget();
00179 
00180     
00183     virtual void train();
00184 
00185 
00187     virtual void computeOutput(const Vec& input, Vec& output) const;
00188 
00190     virtual void computeCostsFromOutputs(const Vec& input, const Vec& output, 
00191                                          const Vec& target, Vec& costs) const;
00192                                 
00193 
00195     virtual
00196     bool computeConfidenceFromOutput(const Vec& input, const Vec& output,
00197                                      real probability,
00198                                      TVec< pair<real,real> >& intervals) const;
00199   
00201     virtual TVec<string> getTestCostNames() const;
00202 
00205     virtual TVec<string> getTrainCostNames() const;
00206 
00207 
00210     virtual void setTrainingSet(VMat training_set, bool call_forget=true);
00211 
00212 protected:
00214     void setBaseLearnersTrainingSet(VMat base_trainset, bool call_forget);
00215 
00217     void setCombinerTrainingSet(VMat comb_trainset, bool call_forget);
00218 };
00219 
00220 // Declares a few other classes and functions related to this class
00221 DECLARE_OBJECT_PTR(StackedLearner);
00222   
00223 } // end of namespace PLearn
00224 
00225 #endif
00226 
00227 
00228 /*
00229   Local Variables:
00230   mode:c++
00231   c-basic-offset:4
00232   c-file-style:"stroustrup"
00233   c-file-offsets:((innamespace . 0)(inline-open . 0))
00234   indent-tabs-mode:nil
00235   fill-column:79
00236   End:
00237 */
00238 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines