PLearn 0.1
Train.cc
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // Train.cc
00004 //
00005 // Copyright (C) 2004 Martin Monperrus 
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: Train.cc 4047 2005-09-07 15:21:01Z plearner $ 
00037  ******************************************************* */
00038 
00039 // Authors: Martin Monperrus
00040 
00044 #include "Train.h"
00045 #include <plearn/db/getDataSet.h>
00046 #include <plearn/io/load_and_save.h>
00047 
00048 namespace PLearn {
00049 using namespace std;
00050 
00051 Train::Train() 
00052     /* ### Initialize all fields to their default value */
00053 {
00054     // ...
00055 
00056     // ### You may or may not want to call build_() to finish building the object
00057     // build_();
00058 }
00059 
00060 PLEARN_IMPLEMENT_OBJECT(Train, "An easy PTester", "Sometimes, we want to train a learner easily.\n"
00061                         "But plearn learner train does not permit to use macro variable.\n"
00062                         "Train is the equivalent of plearn learner train but macro variables are usable\n"
00063                         "Example: plearn myTrain.plearn knn=12");
00064 
00065 void Train::declareOptions(OptionList& ol)
00066 {
00067     // ### Declare all of this object's options here
00068     // ### For the "flags" of each option, you should typically specify  
00069     // ### one of OptionBase::buildoption, OptionBase::learntoption or 
00070     // ### OptionBase::tuningoption. Another possible flag to be combined with
00071     // ### is OptionBase::nosave
00072 
00073     // ### ex:
00074     // declareOption(ol, "myoption", &Train::myoption, OptionBase::buildoption,
00075     //               "Help text describing this option");
00076     // ...
00077     declareOption(ol, "dataset", &Train::trainset, OptionBase::buildoption,
00078                   "Any valid vmat");
00079 
00080     declareOption(ol, "psave", &Train::psave, OptionBase::buildoption,
00081                   "Name of the file .psave");
00082   
00083     declareOption(ol, "learner", &Train::learner, OptionBase::buildoption,
00084                   "Any valid learner");
00085 
00086     // Now call the parent class' declareOptions
00087     inherited::declareOptions(ol);
00088 }
00089 
00090 void Train::build_()
00091 {
00092     // ### This method should do the real building of the object,
00093     // ### according to set 'options', in *any* situation. 
00094     // ### Typical situations include:
00095     // ###  - Initial building of an object from a few user-specified options
00096     // ###  - Building of a "reloaded" object: i.e. from the complete set of all serialised options.
00097     // ###  - Updating or "re-building" of an object after a few "tuning" options have been modified.
00098     // ### You should assume that the parent class' build_() has already been called.
00099 }
00100 
00101 // ### Nothing to add here, simply calls build_
00102 void Train::build()
00103 {
00104     inherited::build();
00105     build_();
00106 }
00107 
00108 void Train::run()
00109 {
00110     PP<VecStatsCollector> train_stats = new VecStatsCollector();
00111     learner->setTrainStatsCollector(train_stats);
00112     learner->setTrainingSet(trainset);
00113     learner->train();
00114     cout<<"Saving learner in :"<<psave<<endl;
00115     PLearn::save(psave, learner);
00116 }
00117 
00118 void Train::makeDeepCopyFromShallowCopy(CopiesMap& copies)
00119 {
00120     inherited::makeDeepCopyFromShallowCopy(copies);
00121 
00122     // ### Call deepCopyField on all "pointer-like" fields 
00123     // ### that you wish to be deepCopied rather than 
00124     // ### shallow-copied.
00125     // ### ex:
00126     // deepCopyField(trainvec, copies);
00127 
00128     // ### Remove this line when you have fully implemented this method.
00129     PLERROR("Train::makeDeepCopyFromShallowCopy not fully (correctly) implemented yet!");
00130 }
00131 
00132 } // end of namespace PLearn
00133 
00134 
00135 /*
00136   Local Variables:
00137   mode:c++
00138   c-basic-offset:4
00139   c-file-style:"stroustrup"
00140   c-file-offsets:((innamespace . 0)(inline-open . 0))
00141   indent-tabs-mode:nil
00142   fill-column:79
00143   End:
00144 */
00145 // 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