PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // CompareLearner.h 00004 // 00005 // Copyright (C) 2004 Hugo Larochelle 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: CompareLearner.h 3994 2005-08-25 13:35:03Z chapados $ 00037 ******************************************************* */ 00038 00039 // Authors: Hugo Larochelle 00040 00044 #ifndef CompareLearner_INC 00045 #define CompareLearner_INC 00046 00047 #include <plearn_learners/generic/PLearner.h> 00048 00049 namespace PLearn { 00050 00051 class CompareLearner: public PLearner 00052 { 00053 00054 private: 00055 00056 typedef PLearner inherited; 00057 00058 protected: 00059 00060 // ********************* 00061 // * protected options * 00062 // ********************* 00063 00064 // ### declare protected option fields (such as learnt parameters) here 00065 // ... 00066 00068 int n_learners; 00070 int learners_outputsize; 00072 TMat<int> costs_indexes; 00073 00074 public: 00075 00076 // ************************ 00077 // * public build options * 00078 // ************************ 00079 00081 TVec< PP<PLearner> > learners; 00083 TVec<string> learner_names; 00085 TVec<string> common_costs; 00086 00087 // **************** 00088 // * Constructors * 00089 // **************** 00090 00092 CompareLearner(); 00093 00094 00095 // ******************** 00096 // * PLearner methods * 00097 // ******************** 00098 00099 private: 00100 00102 void build_(); 00103 00104 protected: 00105 00107 static void declareOptions(OptionList& ol); 00108 00109 public: 00110 00111 // ************************ 00112 // **** Object methods **** 00113 // ************************ 00114 00116 virtual void build(); 00117 00119 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00120 00121 // Declares other standard object methods. 00122 // If your class is not instantiatable (it has pure virtual methods) 00123 // you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT. 00124 PLEARN_DECLARE_OBJECT(CompareLearner); 00125 00126 00127 // ************************** 00128 // **** PLearner methods **** 00129 // ************************** 00130 00133 virtual int outputsize() const; 00134 00137 virtual void forget(); 00138 00139 00142 virtual void train(); 00143 00144 00146 virtual void computeOutput(const Vec& input, Vec& output) const; 00147 00149 virtual void computeCostsFromOutputs(const Vec& input, const Vec& output, 00150 const Vec& target, Vec& costs) const; 00151 00152 00154 virtual TVec<std::string> getTestCostNames() const; 00155 00158 virtual TVec<std::string> getTrainCostNames() const; 00159 00160 virtual void setTrainStatsCollector(PP<VecStatsCollector> statscol); 00161 00162 virtual void setTrainingSet(VMat training_set, bool call_forget=true); 00163 00164 virtual void setValidationSet(VMat validset); 00165 00166 virtual void setExperimentDirectory(const PPath& the_expdir); 00167 00168 }; 00169 00170 // Declares a few other classes and functions related to this class. 00171 DECLARE_OBJECT_PTR(CompareLearner); 00172 00173 } // end of namespace PLearn 00174 00175 #endif 00176 00177 00178 /* 00179 Local Variables: 00180 mode:c++ 00181 c-basic-offset:4 00182 c-file-style:"stroustrup" 00183 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00184 indent-tabs-mode:nil 00185 fill-column:79 00186 End: 00187 */ 00188 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :