PLearn 0.1
InferenceRBM.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // InferenceRBM.h
00004 //
00005 // Copyright (C) 2008 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 InferenceRBM_INC
00041 #define InferenceRBM_INC
00042 
00043 #include <plearn/base/Object.h>
00044 #include <plearn_learners/online/RBMLayer.h>
00045 #include <plearn_learners/online/RBMMultinomialLayer.h>
00046 #include <plearn_learners/online/RBMBinomialLayer.h>
00047 #include <plearn_learners/online/RBMMixedLayer.h>
00048 #include <plearn_learners/online/RBMMatrixConnection.h>
00049 #include <plearn_learners/online/RBMMixedConnection.h>
00050 
00051 namespace PLearn {
00052 
00060 class InferenceRBM : public Object
00061 {
00062     typedef Object inherited;
00063 
00064 public:
00065     //#####  Public Build Options  ############################################
00066 
00069     PP<RBMLayer> input_layer;
00070 
00072     PP<RBMMultinomialLayer> target_layer;
00073 
00075     PP<RBMBinomialLayer> hidden_layer;
00076 
00078     PP<RBMMatrixConnection> input_to_hidden;
00079 
00081     PP<RBMMatrixConnection> target_to_hidden;
00082 
00087     string exp_method;
00088 
00090     int n_gibbs_steps;
00091 
00093     PP<PRandom> random_gen;
00094 
00096     bool use_fast_approximations;
00097 
00098 
00099 
00100 public:
00101     //#####  Public Member Functions  #########################################
00102 
00104     // ### Make sure the implementation in the .cc
00105     // ### initializes all fields to reasonable default values.
00106     InferenceRBM();
00107 
00108     // Your other public member functions go here
00109 
00110     void hiddenExpGivenVisible(const Mat& visible);
00111     void hiddenExpGivenInputTarget(const Mat& input, const TVec<int>& target);
00112     void hiddenExpGivenInput(const Mat& input);
00113     void targetExpGivenInput(const Mat& input);
00114 
00115     Mat getHiddenExpGivenVisible(const Mat& visible);
00116     Mat getHiddenExpGivenInputTarget(const Mat& input, const TVec<int>& target);
00117     Mat getHiddenExpGivenInput(const Mat& input);
00118     Mat getTargetExpGivenInput(const Mat& input);
00119 
00120     void supCDStep(const Mat& visible);
00121     void unsupCDStep(const Mat& input);
00122 
00123     virtual void setLearningRate(real the_learning_rate);
00124 
00125     //#####  PLearn::Object Protocol  #########################################
00126 
00127     // Declares other standard object methods.
00128     PLEARN_DECLARE_OBJECT(InferenceRBM);
00129 
00130     // Simply calls inherited::build() then build_()
00131     virtual void build();
00132 
00134     // (PLEASE IMPLEMENT IN .cc)
00135     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00136 
00137 protected:
00138     //#####  Protected Options  ###############################################
00139 
00140     // ### Declare protected option fields (such as learned parameters) here
00142     PP<RBMMixedLayer> visible_layer;
00143 
00144     PP<RBMMixedConnection> visible_to_hidden;
00145 
00147     int input_size;
00148 
00150     int target_size;
00151 
00153     int visible_size;
00154 
00156     int hidden_size;
00157 
00158 protected:
00159     //#####  Protected Member Functions  ######################################
00160 
00162     static void declareOptions(OptionList& ol);
00163 
00165     static void declareMethods(RemoteMethodMap& rmm);
00166 
00167 private:
00168     //#####  Private Member Functions  ########################################
00169 
00171     void build_();
00172 
00173     void build_rbms();
00174 
00175 private:
00176     //#####  Private Data Members  ############################################
00177 
00178     // The rest of the private stuff goes here
00179     mutable Mat v0;
00180     mutable Mat h0;
00181 };
00182 
00183 // Declares a few other classes and functions related to this class
00184 DECLARE_OBJECT_PTR(InferenceRBM);
00185 
00186 } // end of namespace PLearn
00187 
00188 #endif
00189 
00190 
00191 /*
00192   Local Variables:
00193   mode:c++
00194   c-basic-offset:4
00195   c-file-style:"stroustrup"
00196   c-file-offsets:((innamespace . 0)(inline-open . 0))
00197   indent-tabs-mode:nil
00198   fill-column:79
00199   End:
00200 */
00201 // 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