PLearn 0.1
ModuleLearner.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // ModuleLearner.h
00004 //
00005 // Copyright (C) 2007 Olivier Delalleau
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: Olivier Delalleau
00036 
00040 #ifndef ModuleLearner_INC
00041 #define ModuleLearner_INC
00042 
00043 #include <plearn_learners/generic/PLearner.h>
00044 #include <plearn_learners/online/OnlineLearningModule.h>
00045 #include <plearn_learners/online/MatrixModule.h>
00046 #include <plearn_learners/online/NetworkConnection.h>
00047 #include <plearn_learners/online/NetworkModule.h>
00048 
00049 namespace PLearn {
00050 
00051 class ModuleLearner : public PLearner
00052 {
00053     typedef PLearner inherited;
00054 
00055 public:
00056     //#####  Public Build Options  ############################################
00057 
00058     PP<OnlineLearningModule> module;
00059 
00060     int batch_size;
00061     TVec<string> cost_ports;
00062     TVec<string> input_ports;
00063     TVec<string> target_ports;
00064     TVec<string> weight_ports;
00065     string output_port;
00066 
00067     bool operate_on_bags;
00068 
00069     int reset_seed_upon_train;
00070 
00071 public:
00072     //#####  Public Member Functions  #########################################
00073 
00075     ModuleLearner();
00076 
00077     //#####  PLearner Member Functions  #######################################
00078 
00081     virtual int outputsize() const;
00082 
00086     virtual void forget();
00087 
00091     virtual void train();
00092 
00094     virtual void computeOutput(const Vec& input, Vec& output) const;
00095 
00097     virtual void computeCostsFromOutputs(const Vec& input, const Vec& output,
00098                                          const Vec& target, Vec& costs) const;
00099 
00102     virtual TVec<std::string> getTestCostNames() const;
00103 
00106     virtual TVec<std::string> getTrainCostNames() const;
00107 
00108 
00109     // *** SUBCLASS WRITING: ***
00110     // While in general not necessary, in case of particular needs
00111     // (efficiency concerns for ex) you may also want to overload
00112     // some of the following methods:
00113     virtual void computeOutputAndCosts(const Vec& input, const Vec& target,
00114                                        Vec& output, Vec& costs) const;
00115 
00117     virtual void computeOutputsAndCosts(const Mat& input, const Mat& target,
00118                                         Mat& output, Mat& costs) const;
00119 
00120 
00121     // virtual void computeCostsOnly(const Vec& input, const Vec& target,
00122     //                               Vec& costs) const;
00123     // virtual void test(VMat testset, PP<VecStatsCollector> test_stats,
00124     //                   VMat testoutputs=0, VMat testcosts=0) const;
00125     // virtual int nTestCosts() const;
00126     // virtual int nTrainCosts() const;
00127     // virtual void resetInternalState();
00128     // virtual bool isStatefulLearner() const;
00129 
00130 
00131     //#####  PLearn::Object Protocol  #########################################
00132 
00133     // Declares other standard object methods.
00134     // ### If your class is not instantiatable (it has pure virtual methods)
00135     // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS
00136     PLEARN_DECLARE_OBJECT(ModuleLearner);
00137 
00138     // Simply calls inherited::build() then build_()
00139     virtual void build();
00140 
00142     // (PLEASE IMPLEMENT IN .cc)
00143     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00144 
00145 protected:
00146 
00148 
00150     PP<MatrixModule> store_inputs;
00151 
00153     PP<MatrixModule> store_targets;
00154 
00156     PP<MatrixModule> store_weights;
00157 
00160     PP<MatrixModule> store_outputs;
00161 
00164     TVec< PP<MatrixModule> > store_costs;
00165 
00168     PP<NetworkModule> network;
00169 
00172     TVec<Mat*> null_pointers;
00173 
00174     //#####  Protected Options  ###############################################
00175 
00176     int mbatch_size;
00177 
00178 protected:
00179     //#####  Protected Member Functions  ######################################
00180 
00182     static void declareOptions(OptionList& ol);
00183 
00186     void trainingStep(const Mat& inputs, const Mat& targets,
00187                       const Vec& weights);
00188 
00189 private:
00190 
00192     mutable Mat all_ones;
00193 
00196     mutable Mat tmp_costs;
00197 
00198     //#####  Private Member Functions  ########################################
00199 
00201     void build_();
00202 
00203 private:
00204     //#####  Private Data Members  ############################################
00205 
00206     // The rest of the private stuff goes here
00207 };
00208 
00209 // Declares a few other classes and functions related to this class
00210 DECLARE_OBJECT_PTR(ModuleLearner);
00211 
00212 } // end of namespace PLearn
00213 
00214 #endif
00215 
00216 
00217 /*
00218   Local Variables:
00219   mode:c++
00220   c-basic-offset:4
00221   c-file-style:"stroustrup"
00222   c-file-offsets:((innamespace . 0)(inline-open . 0))
00223   indent-tabs-mode:nil
00224   fill-column:79
00225   End:
00226 */
00227 // 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