PLearn 0.1
PExperiment.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // PTester.h
00004 // 
00005 // Copyright (C) 2002 Pascal Vincent, Frederic Morin
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: PExperiment.h 3994 2005-08-25 13:35:03Z chapados $ 
00037  ******************************************************* */
00038 
00040 #ifndef PExperiment_INC
00041 #define PExperiment_INC
00042 
00043 #include <plearn/base/Object.h>
00044 #include <plearn_learners/generic/PLearner.h>
00045 #include <plearn/vmat/VMat.h>
00046 #include <plearn/vmat/Splitter.h>
00047 #include <plearn/io/PPath.h>
00048 
00049 namespace PLearn {
00050 using namespace std;
00051 
00053 class PTester: public Object
00054 {    
00055 public:
00056     bool save_initial_experiment;
00057     typedef Object inherited;
00058 
00059     // ************************
00060     // * public build options *
00061     // ************************
00062   
00063     // See declareOptions method in .cc for the role of these options.
00064 
00066     PPath expdir;  
00067     PP<PLearner> learner;
00068     PP<Splitter> splitter;
00069     TVec<string> statnames;
00070     bool report_stats;
00071 
00072     bool save_stat_collectors;
00073     bool save_learners;
00074     bool save_initial_learners;
00075     bool save_data_sets;
00076     bool save_test_outputs;
00077     bool save_test_costs;
00078     bool provide_learner_expdir;
00079 
00080     // ****************
00081     // * Constructors *
00082     // ****************
00083 
00084     // Default constructor
00085     PTester();
00086 
00087 
00088     // ******************
00089     // * Object methods *
00090     // ******************
00091 
00092 private: 
00094     // (Please implement in .cc)
00095     void build_();
00096 
00097 protected: 
00099     // (Please implement in .cc)
00100     static void declareOptions(OptionList& ol);
00101 
00102 public:
00103     // simply calls inherited::build() then build_() 
00104     virtual void build();
00105 
00107     PLEARN_DECLARE_OBJECT(PTester);
00108 
00113     void setExperimentDirectory(const PPath& the_expdir);
00114   
00116     PPath getExperimentDirectory() const { return expdir; }
00117   
00118 
00119 
00121     virtual void run();
00122 
00128     Vec perform(bool dont_set_training_set=false);
00129 
00130 };
00131 
00132 // Declares a few other classes and functions related to this class
00133 DECLARE_OBJECT_PTR(PTester);
00134   
00135 } // end of namespace PLearn
00136 
00137 #endif
00138 
00139 
00140 /*
00141   Local Variables:
00142   mode:c++
00143   c-basic-offset:4
00144   c-file-style:"stroustrup"
00145   c-file-offsets:((innamespace . 0)(inline-open . 0))
00146   indent-tabs-mode:nil
00147   fill-column:79
00148   End:
00149 */
00150 // 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