PLearn 0.1
RBMClassificationModule.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // RBMClassificationModule.h
00004 //
00005 // Copyright (C) 2006 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 RBMClassificationModule_INC
00041 #define RBMClassificationModule_INC
00042 
00043 #include <plearn_learners/online/OnlineLearningModule.h>
00044 #include "RBMConnection.h"
00045 #include "RBMMatrixConnection.h"
00046 #include "RBMMixedConnection.h"
00047 #include "RBMLayer.h"
00048 #include "RBMBinomialLayer.h"
00049 #include "RBMMultinomialLayer.h"
00050 
00051 namespace PLearn {
00052 
00059 class RBMClassificationModule : public OnlineLearningModule
00060 {
00061     typedef OnlineLearningModule inherited;
00062 
00063 public:
00064     //#####  Public Build Options  ############################################
00066     PP<RBMConnection> previous_to_last;
00067 
00069     PP<RBMBinomialLayer> last_layer;
00070 
00072     PP<RBMMatrixConnection> last_to_target;
00073 
00076     PP<RBMMultinomialLayer> target_layer;
00077 
00078     //#####  Public Learnt Options  ###########################################
00080     PP<RBMMixedConnection> joint_connection;
00081 
00083     int last_size;
00084 
00085 public:
00086     //#####  Public Member Functions  #########################################
00087 
00089     // ### Make sure the implementation in the .cc
00090     // ### initializes all fields to reasonable default values.
00091     RBMClassificationModule();
00092 
00093     // Your other public member functions go here
00094 
00096     virtual void fprop(const Vec& input, Vec& output) const;
00097     virtual void fprop(const Mat& inputs, Mat& outputs);
00098 
00109     // virtual void bpropUpdate(const Vec& input, const Vec& output,
00110     //                          const Vec& output_gradient);
00111 
00113     virtual void bpropUpdate(const Vec& input, const Vec& output,
00114                              Vec& input_gradient,
00115                              const Vec& output_gradient,
00116                              bool accumulate=false);
00117 
00127     // virtual void bbpropUpdate(const Vec& input, const Vec& output,
00128     //                           const Vec& output_gradient,
00129     //                           const Vec& output_diag_hessian);
00130 
00134     // virtual void bbpropUpdate(const Vec& input, const Vec& output,
00135     //                           Vec& input_gradient,
00136     //                           const Vec& output_gradient,
00137     //                           Vec& input_diag_hessian,
00138     //                           const Vec& output_diag_hessian
00139     //                           bool accumulate=false);
00140 
00144     virtual void forget();
00145 
00146     //#####  PLearn::Object Protocol  #########################################
00147 
00148     // Declares other standard object methods.
00149     // ### If your class is not instantiatable (it has pure virtual methods)
00150     // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT
00151     PLEARN_DECLARE_OBJECT(RBMClassificationModule);
00152 
00153     // Simply calls inherited::build() then build_()
00154     virtual void build();
00155 
00157     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00158 
00159 protected:
00160     //#####  Not Options  #####################################################
00162     mutable Vec out_act;
00163 
00164 protected:
00165     //#####  Protected Member Functions  ######################################
00166 
00168     static void declareOptions(OptionList& ol);
00169 
00170 private:
00171     //#####  Private Member Functions  ########################################
00172 
00174     void build_();
00175 
00176 private:
00177     //#####  Private Data Members  ############################################
00178 
00179     // The rest of the private stuff goes here
00181     mutable Vec d_target_act;
00182 
00184     mutable Vec d_last_act;
00185 
00187 };
00188 
00189 // Declares a few other classes and functions related to this class
00190 DECLARE_OBJECT_PTR(RBMClassificationModule);
00191 
00192 } // end of namespace PLearn
00193 
00194 #endif
00195 
00196 
00197 /*
00198   Local Variables:
00199   mode:c++
00200   c-basic-offset:4
00201   c-file-style:"stroustrup"
00202   c-file-offsets:((innamespace . 0)(inline-open . 0))
00203   indent-tabs-mode:nil
00204   fill-column:79
00205   End:
00206 */
00207 // 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