PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // OnBagsModule.h 00004 // 00005 // Copyright (C) 2007 Jerome Louradour 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: Jerome Louradour 00036 00039 #ifndef OnBagsModule_INC 00040 #define OnBagsModule_INC 00041 00042 #include <plearn_learners/online/OnlineLearningModule.h> 00043 00044 #include <map> 00045 00046 namespace PLearn { 00047 00048 class OnBagsModule : public OnlineLearningModule 00049 { 00050 typedef OnlineLearningModule inherited; 00051 00052 public: 00053 //##### Public Build Options ############################################ 00054 00055 int bagtarget_size; 00056 00057 //##### Public Learnt Options ########################################### 00058 00059 00060 public: 00061 //##### Public Member Functions ######################################### 00062 00064 OnBagsModule(); 00065 00067 00069 virtual void fpropAcc(const Vec& input); 00070 virtual void fpropInit(const Vec& input); 00071 virtual void fpropOutput(Vec& output); 00072 00074 virtual void bprop( const Mat& baginputs, 00075 const Vec& bagoutput_gradient, 00076 Mat& baginputs_gradients); 00077 00079 00081 virtual void fprop(const TVec<Mat*>& ports_value); 00082 virtual void fprop(const Mat& inputs, const Mat& targets, Mat& outputs); 00083 virtual void fprop(const Vec& input, const Vec& target, Vec& output); 00084 00086 virtual void bpropUpdate(const Mat& inputs, const Mat& targets, 00087 Mat& input_gradients, const Mat& output_gradients, 00088 bool accumulate=false); 00089 virtual void bpropAccUpdate(const TVec<Mat*>& ports_value, 00090 const TVec<Mat*>& ports_gradient); 00091 00093 virtual const TVec<string>& getPorts(); 00094 00096 virtual const TMat<int>& getPortSizes(); 00097 00101 virtual int getPortIndex(const string& port); 00102 00104 virtual void setLearningRate(real dynamic_learning_rate) {} 00105 00107 virtual TVec<string> name(); 00108 00109 //##### PLearn::Object Protocol ######################################### 00110 00111 // Declares other standard object methods. 00112 // ### If your class is not instantiatable (it has pure virtual methods) 00113 // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT 00114 PLEARN_DECLARE_OBJECT(OnBagsModule); 00115 00116 // Simply calls inherited::build() then build_() 00117 virtual void build(); 00118 00120 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00121 00122 virtual void forget(); 00123 00124 protected: 00125 00126 bool wait_new_bag; 00127 00129 map<string, int> portname_to_index; 00130 00132 TVec<string> ports; 00133 00134 //##### Protected Member Functions ###################################### 00135 00137 void addPortName(const string& name); 00138 00140 static void declareOptions(OptionList& ol); 00141 00142 private: 00143 //##### Private Member Functions ######################################## 00144 00146 void build_(); 00147 00148 private: 00149 //##### Private Data Members ############################################ 00150 00151 // The rest of the private stuff goes here 00152 }; 00153 00154 // Declares a few other classes and functions related to this class 00155 DECLARE_OBJECT_PTR(OnBagsModule); 00156 00157 } // end of namespace PLearn 00158 00159 #endif 00160 00161 00162 /* 00163 Local Variables: 00164 mode:c++ 00165 c-basic-offset:4 00166 c-file-style:"stroustrup" 00167 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00168 indent-tabs-mode:nil 00169 fill-column:79 00170 End: 00171 */ 00172 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :