PLearn 0.1
ModulesLearner.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // ModulesLearner.h
00004 //
00005 // Copyright (C) 2006 Pascal Lamblin
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: Pascal Lamblin
00036 
00040 #ifndef ModulesLearner_INC
00041 #define ModulesLearner_INC
00042 
00043 #include <plearn_learners/generic/PLearner.h>
00044 #include "OnlineLearningModule.h"
00045 #include "CostModule.h"
00046 
00047 namespace PLearn {
00048 
00057 class ModulesLearner : public PLearner
00058 {
00059     typedef PLearner inherited;
00060 
00061 public:
00062     //#####  Public Build Options  ############################################
00063 
00065     PP<OnlineLearningModule> module;
00066 
00068     PP<CostModule> cost;
00069 
00074     string hessian_estimation;
00075 
00076 
00077 public:
00078     //#####  Public Member Functions  #########################################
00079 
00081     ModulesLearner();
00082 
00083 
00084     //#####  PLearner Member Functions  #######################################
00085 
00088     virtual int outputsize() const;
00089 
00093     virtual void forget();
00094 
00098     virtual void train();
00099 
00101     virtual void computeOutput(const Vec& input, Vec& output) const;
00102 
00104     virtual void computeCostsFromOutputs(const Vec& input, const Vec& output,
00105                                          const Vec& target, Vec& costs) const;
00106 
00109     virtual TVec<std::string> getTestCostNames() const;
00110 
00113     virtual TVec<std::string> getTrainCostNames() const;
00114 
00115 
00116     // *** SUBCLASS WRITING: ***
00117     // While in general not necessary, in case of particular needs
00118     // (efficiency concerns for ex) you may also want to overload
00119     // some of the following methods:
00120     // virtual void computeOutputAndCosts(const Vec& input, const Vec& target,
00121     //                                    Vec& output, Vec& costs) const;
00122     // virtual void computeCostsOnly(const Vec& input, const Vec& target,
00123     //                               Vec& costs) const;
00124     // virtual void test(VMat testset, PP<VecStatsCollector> test_stats,
00125     //                   VMat testoutputs=0, VMat testcosts=0) const;
00126     // virtual int nTestCosts() const;
00127     // virtual int nTrainCosts() const;
00128     // virtual void resetInternalState();
00129     // virtual bool isStatefulLearner() const;
00130 
00131 
00132     //#####  PLearn::Object Protocol  #########################################
00133 
00134     // Declares other standard object methods.
00135     // ### If your class is not instantiatable (it has pure virtual methods)
00136     // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS
00137     PLEARN_DECLARE_OBJECT(ModulesLearner);
00138 
00139     // Simply calls inherited::build() then build_()
00140     virtual void build();
00141 
00143     // (PLEASE IMPLEMENT IN .cc)
00144     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00145 
00146 protected:
00147     //#####  Protected Options  ###############################################
00148 
00149     // ### Declare protected option fields (such as learned parameters) here
00150 
00151     //####  Not Options  ######################################################
00152 
00154     mutable Vec output;
00155 
00157     mutable Vec d_output;
00158 
00160     mutable Vec d2_output;
00161 
00163     mutable Vec costs;
00164 
00165 protected:
00166     //#####  Protected Member Functions  ######################################
00167 
00169     static void declareOptions(OptionList& ol);
00170 
00171 private:
00172     //#####  Private Member Functions  ########################################
00173 
00175     void build_();
00176 
00177 private:
00178     //#####  Private Data Members  ############################################
00179 
00180     // The rest of the private stuff goes here
00181 };
00182 
00183 // Declares a few other classes and functions related to this class
00184 DECLARE_OBJECT_PTR(ModulesLearner);
00185 
00186 } // end of namespace PLearn
00187 
00188 #endif
00189 
00190 
00191 /*
00192   Local Variables:
00193   mode:c++
00194   c-basic-offset:4
00195   c-file-style:"stroustrup"
00196   c-file-offsets:((innamespace . 0)(inline-open . 0))
00197   indent-tabs-mode:nil
00198   fill-column:79
00199   End:
00200 */
00201 // 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