PLearn 0.1
RBMRateLayer.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // RBMRateLayer.h
00004 //
00005 // Copyright (C) 2008 Hugo Larochelle
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: Hugo Larochelle
00036 
00040 #ifndef RBMRateLayer_INC
00041 #define RBMRateLayer_INC
00042 
00043 #include "RBMLayer.h"
00044 
00045 namespace PLearn {
00046 using namespace std;
00047 
00051 class RBMRateLayer: public RBMLayer
00052 {
00053     typedef RBMLayer inherited;
00054 
00055 public:
00056     //#####  Public Build Options  ############################################
00057 
00059     int n_spikes;
00060 
00061 public:
00062     //#####  Public Member Functions  #########################################
00063 
00065     RBMRateLayer( real the_learning_rate=0. );
00066 
00068     virtual void generateSample();
00069 
00071     virtual void generateSamples();
00072 
00074     virtual void computeExpectation();
00075 
00077     virtual void computeExpectations();
00078 
00080     virtual void fprop( const Vec& input, Vec& output ) const;
00081 
00083     virtual void bpropUpdate(const Vec& input, const Vec& output,
00084                              Vec& input_gradient, const Vec& output_gradient,
00085                              bool accumulate=false);
00086 
00088     virtual void bpropUpdate(const Mat& inputs, const Mat& outputs,
00089                              Mat& input_gradients,
00090                              const Mat& output_gradients,
00091                              bool accumulate=false);
00092 
00095     virtual real fpropNLL(const Vec& target);
00096 
00099     virtual void bpropNLL(const Vec& target, real nll, Vec& bias_gradient);
00100 
00101     // Compute -bias' unit_values
00102     virtual real energy(const Vec& unit_values) const;
00103 
00107     virtual real freeEnergyContribution(const Vec& unit_activations) const;
00108 
00113     virtual void freeEnergyContributionGradient(const Vec& unit_activations,
00114                                                 Vec& unit_activations_gradient,
00115                                                 real output_gradient = 1,
00116                                                 bool accumulate = false) 
00117         const;
00118 
00119 
00120     virtual int getConfigurationCount();
00121 
00122     virtual void getConfiguration(int conf_index, Vec& output);
00123 
00124     //#####  PLearn::Object Protocol  #########################################
00125 
00126     // Declares other standard object methods.
00127     PLEARN_DECLARE_OBJECT(RBMRateLayer);
00128 
00129     // Simply calls inherited::build() then build_()
00130     virtual void build();
00131 
00133     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00134 
00135 protected:
00136     //#####  Not Options  #####################################################
00137     mutable Vec tmp_softmax;
00138 
00139 protected:
00140     //#####  Protected Member Functions  ######################################
00141 
00143     static void declareOptions(OptionList& ol);
00144 
00145 private:
00146     //#####  Private Member Functions  ########################################
00147 
00149     void build_();
00150 
00151 private:
00152     //#####  Private Data Members  ############################################
00153 
00154     // The rest of the private stuff goes here
00155 };
00156 
00157 // Declares a few other classes and functions related to this class
00158 DECLARE_OBJECT_PTR(RBMRateLayer);
00159 
00160 } // end of namespace PLearn
00161 
00162 #endif
00163 
00164 
00165 /*
00166   Local Variables:
00167   mode:c++
00168   c-basic-offset:4
00169   c-file-style:"stroustrup"
00170   c-file-offsets:((innamespace . 0)(inline-open . 0))
00171   indent-tabs-mode:nil
00172   fill-column:79
00173   End:
00174 */
00175 // 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