PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // RBMParameters.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 RBMParameters_INC 00041 #define RBMParameters_INC 00042 00043 #include <plearn/base/Object.h> 00044 #include "../OnlineLearningModule.h" 00045 00046 namespace PLearn { 00047 using namespace std; 00048 00049 // forward declaration 00050 class RBMLayer; 00051 00058 class RBMParameters: public OnlineLearningModule 00059 { 00060 typedef OnlineLearningModule inherited; 00061 00062 public: 00063 //##### Public Build Options ############################################ 00064 00069 string up_units_types; 00070 00072 string down_units_types; 00073 00075 real learning_rate; 00076 00082 string initialization_method; 00083 00084 //##### Not Options ##################################################### 00085 00087 int up_layer_size; 00088 00090 int down_layer_size; 00091 00092 public: 00093 //##### Public Member Functions ######################################### 00094 00096 RBMParameters( real the_learning_rate=0. ); 00097 00099 RBMParameters( string down_types, string up_types, 00100 real the_learning_rate=0. ); 00101 00102 // Your other public member functions go here 00103 00105 virtual void setAsUpInput( const Vec& input ) const; 00106 00108 virtual void setAsDownInput( const Vec& input ) const; 00109 00111 virtual void accumulatePosStats( const Vec& down_values, 00112 const Vec& up_values ) = 0; 00113 00115 virtual void accumulateNegStats( const Vec& down_values, 00116 const Vec& up_values ) = 0; 00117 00118 00120 virtual void update() = 0; 00121 00124 virtual void update( const Vec& pos_down_values, 00125 const Vec& pos_up_values, 00126 const Vec& neg_down_values, 00127 const Vec& neg_up_values); 00128 00130 virtual void clearStats() = 0; 00131 00135 virtual void computeUnitActivations( int start, int length, 00136 const Vec& activations ) const = 0; 00137 00139 virtual void fprop(const Vec& input, Vec& output) const; 00140 00141 00143 virtual int nParameters(bool share_up_params, bool share_down_params) const = 0; 00144 00150 virtual Vec makeParametersPointHere(const Vec& global_parameters, bool share_up_params, bool share_down_params) = 0; 00151 00152 //##### PLearn::Object Protocol ######################################### 00153 00154 // Declares other standard object methods. 00155 PLEARN_DECLARE_ABSTRACT_OBJECT(RBMParameters); 00156 00157 // Simply calls inherited::build() then build_() 00158 virtual void build(); 00159 00161 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00162 00163 protected: 00164 //##### Not Options ##################################################### 00165 00167 mutable Vec input_vec; 00168 00170 mutable bool going_up; 00171 00173 int pos_count; 00175 int neg_count; 00176 00177 protected: 00178 //##### Protected Member Functions ###################################### 00179 00181 static void declareOptions(OptionList& ol); 00182 00183 private: 00184 //##### Private Member Functions ######################################## 00185 00187 void build_(); 00188 00189 private: 00190 //##### Private Data Members ############################################ 00191 00192 // The rest of the private stuff goes here 00193 }; 00194 00195 // Declares a few other classes and functions related to this class 00196 DECLARE_OBJECT_PTR(RBMParameters); 00197 00198 } // end of namespace PLearn 00199 00200 #endif 00201 00202 00203 /* 00204 Local Variables: 00205 mode:c++ 00206 c-basic-offset:4 00207 c-file-style:"stroustrup" 00208 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00209 indent-tabs-mode:nil 00210 fill-column:79 00211 End: 00212 */ 00213 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :