PLearn 0.1
RBMMultinomialLayer.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // RBMMultinomialLayer.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 RBMMultinomialLayer_INC
00041 #define RBMMultinomialLayer_INC
00042 
00043 #include "RBMLayer.h"
00044 
00045 namespace PLearn {
00046 using namespace std;
00047 
00053 class RBMMultinomialLayer: public RBMLayer
00054 {
00055     typedef RBMLayer inherited;
00056 
00057 public:
00058     //#####  Public Build Options  ############################################
00059 
00060 
00061 
00062 public:
00063     //#####  Public Member Functions  #########################################
00064 
00066     RBMMultinomialLayer( real the_learning_rate=0. );
00067 
00069     RBMMultinomialLayer( int the_size, real the_learning_rate=0. );
00070 
00071 
00073     virtual void generateSample();
00074 
00076     virtual void generateSamples();
00077 
00079     virtual void computeExpectation();
00080 
00082     virtual void computeExpectations();
00083 
00085     virtual void fprop( const Vec& input, Vec& output ) const;
00086 
00088     virtual void fprop( const Vec& input, const Vec& rbm_bias,
00089                         Vec& output ) const;
00090 
00092     virtual void bpropUpdate(const Vec& input, const Vec& output,
00093                              Vec& input_gradient, const Vec& output_gradient,
00094                              bool accumulate=false);
00095 
00097     virtual void bpropUpdate(const Mat& inputs, const Mat& outputs,
00098                              Mat& input_gradients,
00099                              const Mat& output_gradients,
00100                              bool accumulate = false);
00101 
00103     virtual void bpropUpdate(const Vec& input, const Vec& rbm_bias,
00104                              const Vec& output,
00105                              Vec& input_gradient, Vec& rbm_bias_gradient,
00106                              const Vec& output_gradient) ;
00107 
00110     virtual real fpropNLL(const Vec& target);
00111     virtual void fpropNLL(const Mat& targets, const Mat& costs_column);
00112 
00115     virtual void bpropNLL(const Vec& target, real nll, Vec& bias_gradient);
00116     virtual void bpropNLL(const Mat& targets, const Mat& costs_column,
00117                           Mat& bias_gradients);
00118 
00119     // Compute -bias' unit_values
00120     virtual real energy(const Vec& unit_values) const;
00121 
00125     virtual real freeEnergyContribution(const Vec& unit_activations) const;
00126 
00131     virtual void freeEnergyContributionGradient(const Vec& unit_activations,
00132                                                 Vec& unit_activations_gradient,
00133                                                 real output_gradient = 1,
00134                                                 bool accumulate = false) 
00135         const;
00136 
00137 
00138     virtual int getConfigurationCount();
00139 
00140     virtual void getConfiguration(int conf_index, Vec& output);
00141 
00142     //#####  PLearn::Object Protocol  #########################################
00143 
00144     // Declares other standard object methods.
00145     PLEARN_DECLARE_OBJECT(RBMMultinomialLayer);
00146 
00147     // Simply calls inherited::build() then build_()
00148     virtual void build();
00149 
00151     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00152 
00153 protected:
00154     //#####  Not Options  #####################################################
00155     mutable Vec tmp_softmax;
00156 
00157 protected:
00158     //#####  Protected Member Functions  ######################################
00159 
00161     static void declareOptions(OptionList& ol);
00162 
00163 private:
00164     //#####  Private Member Functions  ########################################
00165 
00167     void build_();
00168 
00169 private:
00170     //#####  Private Data Members  ############################################
00171 
00172     // The rest of the private stuff goes here
00173 };
00174 
00175 // Declares a few other classes and functions related to this class
00176 DECLARE_OBJECT_PTR(RBMMultinomialLayer);
00177 
00178 } // end of namespace PLearn
00179 
00180 #endif
00181 
00182 
00183 /*
00184   Local Variables:
00185   mode:c++
00186   c-basic-offset:4
00187   c-file-style:"stroustrup"
00188   c-file-offsets:((innamespace . 0)(inline-open . 0))
00189   indent-tabs-mode:nil
00190   fill-column:79
00191   End:
00192 */
00193 // 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