PLearn 0.1
RBMLLParameters.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // RBMLLParameters.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 RBMLLParameters_INC
00041 #define RBMLLParameters_INC
00042 
00043 #include "RBMParameters.h"
00044 
00045 namespace PLearn {
00046 using namespace std;
00047 
00048 
00055 class RBMLLParameters: public RBMParameters
00056 {
00057     typedef RBMParameters inherited;
00058 
00059 public:
00060     //#####  Public Build Options  ############################################
00061 
00063     real momentum;
00064 
00065     //#####  Learned Options  #################################################
00066 
00068     Mat weights;
00069 
00071     Vec up_units_bias;
00072 
00074     Vec down_units_bias;
00075 
00076     //#####  Not Options  #####################################################
00077 
00079     Mat weights_pos_stats;
00080 
00082     Mat weights_neg_stats;
00083 
00085     Vec up_units_bias_pos_stats;
00087     Vec up_units_bias_neg_stats;
00089     Vec down_units_bias_pos_stats;
00091     Vec down_units_bias_neg_stats;
00092 
00094     Mat weights_inc;
00095     Vec down_units_bias_inc;
00096     Vec up_units_bias_inc;
00097 
00098 public:
00099     //#####  Public Member Functions  #########################################
00100 
00102     RBMLLParameters( real the_learning_rate=0 );
00103 
00105     RBMLLParameters( string down_types, string up_types,
00106                      real the_learning_rate=0 );
00107 
00108     // Your other public member functions go here
00109 
00111     virtual void accumulatePosStats( const Vec& down_values,
00112                                      const Vec& up_values );
00113 
00115     virtual void accumulateNegStats( const Vec& down_values,
00116                                      const Vec& up_values );
00117 
00119     virtual void update();
00120 
00123     virtual void update( const Vec& pos_down_values,
00124                          const Vec& pos_up_values,
00125                          const Vec& neg_down_values,
00126                          const Vec& neg_up_values );
00127 
00129     virtual void clearStats();
00130 
00134     virtual void computeUnitActivations( int start, int length,
00135                                          const Vec& activations ) const;
00136 
00147     // virtual void bpropUpdate(const Vec& input, const Vec& output,
00148     //                          const Vec& output_gradient);
00149 
00152     virtual void bpropUpdate(const Vec& input, const Vec& output,
00153                              Vec& input_gradient,
00154                              const Vec& output_gradient);
00155 
00159     virtual void forget();
00160 
00165     // virtual void finalize();
00166 
00168     virtual int nParameters(bool share_up_params, bool share_down_params) const;
00169 
00175     virtual Vec makeParametersPointHere(const Vec& global_parameters, bool share_up_params, bool share_down_params);
00176 
00177     //#####  PLearn::Object Protocol  #########################################
00178 
00179     // Declares other standard object methods.
00180     PLEARN_DECLARE_OBJECT(RBMLLParameters);
00181 
00182     // Simply calls inherited::build() then build_()
00183     virtual void build();
00184 
00186     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00187 
00188 protected:
00189 
00190 protected:
00191     //#####  Protected Member Functions  ######################################
00193     static void declareOptions(OptionList& ol);
00194 
00195 private:
00196     //#####  Private Member Functions  ########################################
00197 
00199     void build_();
00200 
00201 private:
00202     //#####  Private Data Members  ############################################
00203 
00204     // The rest of the private stuff goes here
00205 };
00206 
00207 // Declares a few other classes and functions related to this class
00208 DECLARE_OBJECT_PTR(RBMLLParameters);
00209 
00210 } // end of namespace PLearn
00211 
00212 #endif
00213 
00214 
00215 /*
00216   Local Variables:
00217   mode:c++
00218   c-basic-offset:4
00219   c-file-style:"stroustrup"
00220   c-file-offsets:((innamespace . 0)(inline-open . 0))
00221   indent-tabs-mode:nil
00222   fill-column:79
00223   End:
00224 */
00225 // 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