PLearn 0.1
RBMMatrixConnectionNatGrad.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // RBMMatrixConnectionNatGrad.h
00004 //
00005 // Copyright (C) 2006 Yoshua Bengio
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: Yoshua Bengio
00036 
00040 #ifndef RBMMatrixConnectionNatGrad_INC
00041 #define RBMMatrixConnectionNatGrad_INC
00042 
00043 #include "RBMMatrixConnection.h"
00044 #include <plearn_learners/generic/NatGradEstimator.h>
00045 
00046 namespace PLearn {
00047 using namespace std;
00048 
00049 
00054 class RBMMatrixConnectionNatGrad: public RBMMatrixConnection
00055 {
00056     typedef RBMMatrixConnection inherited;
00057 
00058 public:
00059     //#####  Public Build Options  ############################################
00060 
00063     PP<NatGradEstimator> natgrad_template;
00064 
00065     //#####  Learned Options  #################################################
00066     TVec<PP<NatGradEstimator> > cd_natgrad;
00067     TVec<PP<NatGradEstimator> > bp_natgrad;
00068 
00069     //#####  Not Options  #####################################################
00070 
00071     Mat weights_gradient;
00072     Vec natural_gradient;
00073 
00074 public:
00075     //#####  Public Member Functions  #########################################
00076 
00078     RBMMatrixConnectionNatGrad( real the_learning_rate=0 );
00079 
00080     // Your other public member functions go here
00081 
00082     virtual void update( const Mat& pos_down_values,
00083                          const Mat& pos_up_values,
00084                          const Mat& neg_down_values,
00085                          const Mat& neg_up_values);
00086 
00087     virtual void bpropUpdate(const Mat& inputs, const Mat& outputs,
00088                              Mat& input_gradients,
00089                              const Mat& output_gradients,
00090                              bool accumulate = false);
00091 
00092     //#####  PLearn::Object Protocol  #########################################
00093 
00094     // Declares other standard object methods.
00095     PLEARN_DECLARE_OBJECT(RBMMatrixConnectionNatGrad);
00096 
00097     // Simply calls inherited::build() then build_()
00098     virtual void build();
00099 
00101     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00102 
00103 protected:
00104     //#####  Protected Member Functions  ######################################
00106     static void declareOptions(OptionList& ol);
00107 
00108 private:
00109     //#####  Private Member Functions  ########################################
00110 
00112     void build_();
00113 
00114 private:
00115     //#####  Private Data Members  ############################################
00116 
00117     // The rest of the private stuff goes here
00118 };
00119 
00120 // Declares a few other classes and functions related to this class
00121 DECLARE_OBJECT_PTR(RBMMatrixConnectionNatGrad);
00122 
00123 } // end of namespace PLearn
00124 
00125 #endif
00126 
00127 
00128 /*
00129   Local Variables:
00130   mode:c++
00131   c-basic-offset:4
00132   c-file-style:"stroustrup"
00133   c-file-offsets:((innamespace . 0)(inline-open . 0))
00134   indent-tabs-mode:nil
00135   fill-column:79
00136   End:
00137 */
00138 // 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