PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // NetworkModule.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 NetworkModule_INC 00041 #define NetworkModule_INC 00042 00043 #include <plearn_learners/online/OnlineLearningModule.h> 00044 #include <plearn_learners/online/NetworkConnection.h> 00045 00046 namespace PLearn { 00047 00048 class NetworkModule : public OnlineLearningModule 00049 { 00050 typedef OnlineLearningModule inherited; 00051 00052 public: 00053 //##### Public Build Options ############################################ 00054 00055 TVec< PP<OnlineLearningModule> > modules; 00056 TVec< PP<NetworkConnection> > connections; 00057 00058 TVec< pair<string, string > > ports; 00059 00060 bool save_states; 00061 00062 public: 00063 //##### Public Member Functions ######################################### 00064 00066 NetworkModule(); 00067 00069 virtual void fprop(const Vec& input, Vec& output) const; 00070 00073 virtual void fprop(const TVec<Mat*>& ports_value); 00074 00077 virtual void bpropAccUpdate(const TVec<Mat*>& ports_value, 00078 const TVec<Mat*>& ports_gradient); 00079 00081 virtual const TVec<string>& getPorts(); 00082 00084 virtual const TMat<int>& getPortSizes(); 00085 00089 virtual void forget(); 00090 00091 //##### PLearn::Object Protocol ######################################### 00092 00093 // Declares other standard object methods. 00094 // ### If your class is not instantiatable (it has pure virtual methods) 00095 // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT 00096 PLEARN_DECLARE_OBJECT(NetworkModule); 00097 00098 // Simply calls inherited::build() then build_() 00099 virtual void build(); 00100 00102 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00103 00104 00105 protected: 00106 00110 TVec< PP<OnlineLearningModule> > all_modules; 00111 00113 TVec< PP<NetworkConnection> > all_connections; 00114 00117 TVec<int> fprop_path; 00118 00121 TVec<int> bprop_path; 00122 00125 TVec< TVec<Mat*> > fprop_data; 00126 00129 TVec< TVec<int> > fprop_data_idx; 00130 00136 TVec< TVec<int> > fprop_toresize; 00137 00143 TVec< TMat<int> > fprop_toplug; 00144 00147 TVec< TVec<Mat*> > bprop_data; 00148 00151 TVec< TVec<int> > bprop_data_idx; 00152 00158 TVec< TVec<int> > bprop_toresize; 00159 00162 TVec<Mat> all_mats; 00163 00165 TVec<string> all_ports; 00166 00167 //##### Protected Member Functions ###################################### 00168 00170 static void declareOptions(OptionList& ol); 00171 00172 private: 00173 //##### Private Member Functions ######################################## 00174 00176 void build_(); 00177 00178 private: 00179 //##### Private Data Members ############################################ 00180 00181 // The rest of the private stuff goes here 00182 }; 00183 00184 // Declares a few other classes and functions related to this class 00185 DECLARE_OBJECT_PTR(NetworkModule); 00186 00187 } // end of namespace PLearn 00188 00189 #endif 00190 00191 00192 /* 00193 Local Variables: 00194 mode:c++ 00195 c-basic-offset:4 00196 c-file-style:"stroustrup" 00197 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00198 indent-tabs-mode:nil 00199 fill-column:79 00200 End: 00201 */ 00202 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :