PLearn 0.1
RBMDiagonalMatrixConnection.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // RBMDiagonalMatrixConnection.h
00004 //
00005 // Copyright (C) 2006 Hugo Larochelle
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: Hugo Larochelle
00036 
00040 #ifndef RBMDiagonalMatrixConnection_INC
00041 #define RBMDiagonalMatrixConnection_INC
00042 
00043 #include "RBMConnection.h"
00044 
00045 namespace PLearn {
00046 using namespace std;
00047 
00048 
00053 class RBMDiagonalMatrixConnection: public RBMConnection
00054 {
00055     typedef RBMConnection inherited;
00056 
00057 public:
00058     //#####  Public Build Options  ############################################
00059 
00061     Vec weights_diag;
00062 
00064     real L1_penalty_factor;
00065 
00067     real L2_penalty_factor;
00068 
00069     real L2_decrease_constant;
00070     real L2_shift;
00071     string L2_decrease_type;
00072     int L2_n_updates;
00073 
00074   //#####  Not Options  #####################################################
00075 
00076 
00078     Vec weights_pos_stats;
00079 
00081     Vec weights_neg_stats;
00082 
00084     Vec weights_inc;
00085 
00086 public:
00087     //#####  Public Member Functions  #########################################
00088 
00090     RBMDiagonalMatrixConnection( real the_learning_rate=0 );
00091 
00092     // Your other public member functions go here
00093 
00095     virtual void accumulatePosStats( const Vec& down_values,
00096                                      const Vec& up_values );
00097 
00098     virtual void accumulatePosStats( const Mat& down_values,
00099                                      const Mat& up_values );
00100 
00102     virtual void accumulateNegStats( const Vec& down_values,
00103                                      const Vec& up_values );
00104 
00105     virtual void accumulateNegStats( const Mat& down_values,
00106                                      const Mat& up_values );
00107 
00109     virtual void update();
00110 
00113     virtual void update( const Vec& pos_down_values,
00114                          const Vec& pos_up_values,
00115                          const Vec& neg_down_values,
00116                          const Vec& neg_up_values );
00117 
00119     virtual void update( const Mat& pos_down_values,
00120                          const Mat& pos_up_values,
00121                          const Mat& neg_down_values,
00122                          const Mat& neg_up_values);
00123 
00125     virtual void clearStats();
00126 
00130     virtual void computeProduct( int start, int length,
00131                                  const Vec& activations,
00132                                  bool accumulate=false ) const;
00133 
00135     virtual void computeProducts(int start, int length,
00136                                  Mat& activations,
00137                                  bool accumulate=false ) const;
00138 
00149     // virtual void bpropUpdate(const Vec& input, const Vec& output,
00150     //                          const Vec& output_gradient);
00151 
00154     virtual void bpropUpdate(const Vec& input, const Vec& output,
00155                              Vec& input_gradient,
00156                              const Vec& output_gradient,
00157                              bool accumulate=false);
00158 
00159     virtual void bpropUpdate(const Mat& inputs, const Mat& outputs,
00160                              Mat& input_gradients,
00161                              const Mat& output_gradients,
00162                              bool accumulate = false);
00163 
00165     virtual void applyWeightPenalty();
00166 
00168     virtual void addWeightPenalty(Vec weights_diag, Vec weights_diag_gradients);
00169 
00173     virtual void forget();
00174 
00179     // virtual void finalize();
00180 
00182     virtual int nParameters() const;
00183 
00189     virtual Vec makeParametersPointHere(const Vec& global_parameters);
00190 
00191     //#####  PLearn::Object Protocol  #########################################
00192 
00193     // Declares other standard object methods.
00194     PLEARN_DECLARE_OBJECT(RBMDiagonalMatrixConnection);
00195 
00196     // Simply calls inherited::build() then build_()
00197     virtual void build();
00198 
00200     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00201 
00202 protected:
00203     //#####  Protected Member Functions  ######################################
00205     static void declareOptions(OptionList& ol);
00206 
00207 private:
00208     //#####  Private Member Functions  ########################################
00209 
00211     void build_();
00212 
00213 private:
00214     //#####  Private Data Members  ############################################
00215 
00216     // The rest of the private stuff goes here
00217 };
00218 
00219 // Declares a few other classes and functions related to this class
00220 DECLARE_OBJECT_PTR(RBMDiagonalMatrixConnection);
00221 
00222 } // end of namespace PLearn
00223 
00224 #endif
00225 
00226 
00227 /*
00228   Local Variables:
00229   mode:c++
00230   c-basic-offset:4
00231   c-file-style:"stroustrup"
00232   c-file-offsets:((innamespace . 0)(inline-open . 0))
00233   indent-tabs-mode:nil
00234   fill-column:79
00235   End:
00236 */
00237 // 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