PLearn 0.1
VPLPreprocessedLearner2.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // VPLPreprocessedLearner2.h
00004 //
00005 // Copyright (C) 2005, 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 /* *******************************************************      
00036  * $Id: VPLPreprocessedLearner2.h 5480 2006-05-03 18:57:39Z plearner $ 
00037  ******************************************************* */
00038 
00039 // Authors: Pascal Vincent
00040 
00044 #ifndef VPLPreprocessedLearner2_INC
00045 #define VPLPreprocessedLearner2_INC
00046 
00047 #include <plearn_learners/generic/PLearner.h>
00048 #include <plearn/vmat/VMatLanguage.h>
00049 
00050 namespace PLearn {
00051 
00052 class VPLPreprocessedLearner2: public PLearner
00053 {
00054 
00055 private:
00056 
00057     typedef PLearner inherited;
00058   
00059 protected:
00060 
00061     VMatLanguage input_prg_;
00062     VMatLanguage target_prg_;
00063     VMatLanguage weight_prg_;
00064     VMatLanguage extra_prg_;
00065     VMatLanguage output_prg_;
00066     VMatLanguage costs_prg_;
00067 
00068     TVec<string> input_prg_fieldnames; 
00069     TVec<string> target_prg_fieldnames;
00070     TVec<string> weight_prg_fieldnames;
00071     TVec<string> extra_prg_fieldnames;
00072     TVec<string> output_prg_fieldnames;
00073     TVec<string> costs_prg_fieldnames;
00074 
00075     mutable Vec row;
00076     mutable Vec processed_input, processed_target, processed_weight, processed_extra;
00077     mutable Vec pre_output;
00078     mutable Vec pre_costs;
00079 
00080     // *********************
00081     // * protected options *
00082     // *********************
00083 
00084     TVec<string> orig_fieldnames; // fieldnames of training set
00085     int orig_inputsize; // inputsize of training set
00086     int orig_targetsize; // targetsize of training set
00087 
00088     bool use_filtering_prg_for_repeat;
00089     string repeat_id_field_name; // 0, 1, ..., n-1; "" means no field is added
00090     string repeat_count_field_name; // n; "" means no field is added
00091     bool ignore_test_costs;
00092     
00093 public:
00094 
00095     // ************************
00096     // * public build options *
00097     // ************************
00098 
00100     PP<PLearner> learner_;
00101 
00102     string filtering_prg;
00103 
00104     string input_prg;
00105     string target_prg;
00106     string weight_prg;
00107     string extra_prg;
00108 
00109     string output_prg;
00110     string costs_prg;
00111   
00112     // ****************
00113     // * Constructors *
00114     // ****************
00115 
00117     // (Make sure the implementation in the .cc
00118     // initializes all fields to reasonable default values)
00119     VPLPreprocessedLearner2();
00120 
00121 
00122     // ********************
00123     // * PLearner methods *
00124     // ********************
00125 
00126 private: 
00127 
00129     void build_();
00130 
00131     void initializeInputPrograms();
00132 
00133     void initializeOutputPrograms();
00134 
00135 
00136 protected: 
00137   
00139     // (Please implement in .cc)
00140     static void declareOptions(OptionList& ol);
00141 
00142 public:
00143 
00144     // ************************
00145     // **** Object methods ****
00146     // ************************
00147 
00149     virtual void build();
00150 
00152     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00153 
00154     // Declares other standard object methods.
00155     // If your class is not instantiatable (it has pure virtual methods)
00156     // you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT.
00157     PLEARN_DECLARE_OBJECT(VPLPreprocessedLearner2);
00158 
00159 
00160     // **************************
00161     // **** PLearner methods ****
00162     // **************************
00163 
00164     virtual int outputsize() const;
00165 
00166     
00168     virtual void setValidationSet(VMat validset);
00169 
00171     virtual void setTrainStatsCollector(PP<VecStatsCollector> statscol);
00172 
00174     virtual void setExperimentDirectory(const PPath& the_expdir);
00175  
00177     virtual void forget();
00178 
00179     virtual void setTrainingSet(VMat training_set, bool call_forget=true);
00180 
00181     virtual void train();
00182 
00183     //virtual void test(VMat testset, PP<VecStatsCollector> test_stats, VMat testoutputs, VMat testcosts) const;
00184 
00185     virtual void computeOutput(const Vec& input, Vec& output) const;
00186 
00187     virtual void computeOutputAndCosts(const Vec& input, const Vec& target, 
00188                                        Vec& output, Vec& costs) const;
00189 
00190     virtual void computeCostsFromOutputs(const Vec& input, const Vec& output, 
00191                                          const Vec& target, Vec& costs) const;
00192 
00193     virtual
00194     bool computeConfidenceFromOutput(const Vec& input, const Vec& output,
00195                                      real probability,
00196                                      TVec< pair<real,real> >& intervals) const;
00197 
00200     virtual TVec<string> getOutputNames() const;
00201 
00202     virtual TVec<std::string> getTestCostNames() const;
00203 
00205     virtual TVec<string> getTrainCostNames() const;
00206 
00208     virtual void resetInternalState();
00209 
00211     virtual bool isStatefulLearner() const;
00212 };
00213 
00214 // Declares a few other classes and functions related to this class.
00215 DECLARE_OBJECT_PTR(VPLPreprocessedLearner2);
00216   
00217 } // end of namespace PLearn
00218 
00219 #endif
00220 
00221 
00222 /*
00223   Local Variables:
00224   mode:c++
00225   c-basic-offset:4
00226   c-file-style:"stroustrup"
00227   c-file-offsets:((innamespace . 0)(inline-open . 0))
00228   indent-tabs-mode:nil
00229   fill-column:79
00230   End:
00231 */
00232 // 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