PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // RBMBinomialLayer.h 00004 // 00005 // Copyright (C) 2006 Dan Popovici & 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: Dan Popovici & Pascal Lamblin 00036 00040 #ifndef RBMBinomialLayer_INC 00041 #define RBMBinomialLayer_INC 00042 00043 #include "RBMLayer.h" 00044 00045 namespace PLearn { 00046 using namespace std; 00047 00052 class RBMBinomialLayer: public RBMLayer 00053 { 00054 typedef RBMLayer inherited; 00055 00056 public: 00057 //##### Public Build Options ############################################ 00058 00059 // Indication that samples should be in {-1,1}, not {0,1} 00060 bool use_signed_samples; 00061 00062 public: 00063 //##### Public Member Functions ######################################### 00064 00066 RBMBinomialLayer( real the_learning_rate=0. ); 00067 00069 RBMBinomialLayer( int the_size, real the_learning_rate=0.); 00070 00072 virtual void generateSample() ; 00073 00075 virtual void generateSamples(); 00076 00078 virtual void computeExpectation() ; 00079 00081 virtual void computeExpectations(); 00082 00084 virtual void fprop( const Vec& input, Vec& output ) const; 00085 00087 virtual void fprop( const Mat& inputs, Mat& outputs ); 00088 00090 virtual void fprop( const Vec& input, const Vec& rbm_bias, 00091 Vec& output ) const; 00092 00094 virtual void bpropUpdate(const Vec& input, const Vec& output, 00095 Vec& input_gradient, const Vec& output_gradient, 00096 bool accumulate=false); 00097 00099 virtual void bpropUpdate(const Vec& input, const Vec& rbm_bias, 00100 const Vec& output, 00101 Vec& input_gradient, Vec& rbm_bias_gradient, 00102 const Vec& output_gradient) ; 00103 00105 virtual void bpropUpdate(const Mat& inputs, const Mat& outputs, 00106 Mat& input_gradients, 00107 const Mat& output_gradients, 00108 bool accumulate = false); 00109 00112 virtual real fpropNLL(const Vec& target); 00113 virtual void fpropNLL(const Mat& targets, const Mat& costs_column); 00116 virtual real fpropNLL(const Vec& target, const Vec& weights); 00117 00118 00121 virtual void bpropNLL(const Vec& target, real nll, Vec& bias_gradient); 00122 virtual void bpropNLL(const Mat& targets, const Mat& costs_column, 00123 Mat& bias_gradients); 00124 00126 virtual real energy(const Vec& unit_values) const; 00127 00131 virtual real freeEnergyContribution(const Vec& unit_activations) const; 00132 00137 virtual void freeEnergyContributionGradient(const Vec& unit_activations, 00138 Vec& unit_activations_gradient, 00139 real output_gradient = 1, 00140 bool accumulate = false) const; 00141 00142 virtual int getConfigurationCount(); 00143 00144 virtual void getConfiguration(int conf_index, Vec& output); 00145 00146 //##### PLearn::Object Protocol ######################################### 00147 00148 // Declares other standard object methods. 00149 PLEARN_DECLARE_OBJECT(RBMBinomialLayer); 00150 00151 // Simply calls inherited::build() then build_() 00152 virtual void build(); 00153 00155 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00156 00157 protected: 00158 //##### Not Options ##################################################### 00159 00160 protected: 00161 //##### Protected Member Functions ###################################### 00162 00164 static void declareOptions(OptionList& ol); 00165 00166 private: 00167 //##### Private Member Functions ######################################## 00168 00170 void build_(); 00171 00172 private: 00173 //##### Private Data Members ############################################ 00174 00175 // The rest of the private stuff goes here 00176 }; 00177 00178 // Declares a few other classes and functions related to this class 00179 DECLARE_OBJECT_PTR(RBMBinomialLayer); 00180 00181 } // end of namespace PLearn 00182 00183 #endif 00184 00185 00186 /* 00187 Local Variables: 00188 mode:c++ 00189 c-basic-offset:4 00190 c-file-style:"stroustrup" 00191 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00192 indent-tabs-mode:nil 00193 fill-column:79 00194 End: 00195 */ 00196 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :