PLearn 0.1
BestAveragingPLearner.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // BestAveragingPLearner.h
00004 //
00005 // Copyright (C) 2006 Nicolas Chapados
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: Nicolas Chapados
00036 
00040 #ifndef BestAveragingPLearner_INC
00041 #define BestAveragingPLearner_INC
00042 
00043 #include <plearn/vmat/Splitter.h>
00044 #include <plearn_learners/generic/PLearner.h>
00045 
00046 namespace PLearn {
00047 
00064 class BestAveragingPLearner : public PLearner
00065 {
00066     typedef PLearner inherited;
00067 
00068 public:
00069     //#####  Public Build Options  ############################################
00070 
00076     TVec< PP<PLearner> > m_learner_set;
00077 
00092     PP<PLearner> m_learner_template;
00093 
00101     int32_t m_initial_seed;
00102 
00113     string m_seed_option;
00114     
00119     int m_total_learner_num;
00120 
00125     int m_best_learner_num;
00126 
00133     string m_comparison_statspec;
00134 
00142     PP<Splitter> m_splitter;
00143     
00144 public:
00145     //#####  Public Member Functions  #########################################
00146 
00148     BestAveragingPLearner();
00149 
00150 
00151     //#####  PLearner Member Functions  #######################################
00152 
00154     virtual void setTrainingSet(VMat training_set, bool call_forget=true);
00155 
00157     virtual void setTrainStatsCollector(PP<VecStatsCollector> statscol);
00158 
00160     virtual void setExperimentDirectory(const PPath& the_expdir);
00161 
00164     virtual int outputsize() const;
00165 
00169     virtual void forget();
00170 
00174     virtual void train();
00175 
00177     virtual void computeOutput(const Vec& input, Vec& output) const;
00178 
00180     virtual void computeCostsFromOutputs(const Vec& input, const Vec& output,
00181                                          const Vec& target, Vec& costs) const;
00182 
00185     virtual TVec<std::string> getTestCostNames() const;
00186 
00189     virtual TVec<std::string> getTrainCostNames() const;
00190 
00191 
00192     //#####  PLearn::Object Protocol  #########################################
00193 
00194     // Declares other standard object methods.
00195     PLEARN_DECLARE_OBJECT(BestAveragingPLearner);
00196 
00197     // Simply calls inherited::build() then build_()
00198     virtual void build();
00199 
00201     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00202 
00203 protected:
00204     //#####  Learned Options  #################################################
00205 
00207     mutable int m_cached_outputsize;
00208 
00210     Vec m_learner_train_costs;
00211     
00213     TVec< PP<PLearner> > m_best_learners;
00214 
00216     mutable Vec m_output_buffer;
00217     
00218 protected:
00220     static void declareOptions(OptionList& ol);
00221 
00222 private:
00224     void build_();
00225 };
00226 
00227 // Declares a few other classes and functions related to this class
00228 DECLARE_OBJECT_PTR(BestAveragingPLearner);
00229 
00230 } // end of namespace PLearn
00231 
00232 #endif
00233 
00234 
00235 /*
00236   Local Variables:
00237   mode:c++
00238   c-basic-offset:4
00239   c-file-style:"stroustrup"
00240   c-file-offsets:((innamespace . 0)(inline-open . 0))
00241   indent-tabs-mode:nil
00242   fill-column:79
00243   End:
00244 */
00245 // 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