PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // RBMQLParameters.h 00004 // 00005 // Copyright (C) 2006 Dan Popovici 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: Dan Popovici 00036 00040 #ifndef RBMQLParameters_INC 00041 #define RBMQLParameters_INC 00042 00043 #include "RBMParameters.h" 00044 00045 namespace PLearn { 00046 using namespace std; 00047 00048 00056 class RBMQLParameters: public RBMParameters 00057 { 00058 typedef RBMParameters inherited; 00059 00060 public: 00061 //##### Public Build Options ############################################ 00062 00063 //##### Learned Options ################################################# 00064 00066 Mat weights; 00067 00069 Vec up_units_bias; 00070 00072 //quadratic term of unit i 00073 TVec<Vec> down_units_params; 00074 00075 //##### Not Options ##################################################### 00076 00078 Mat weights_pos_stats; 00079 00081 Mat weights_neg_stats; 00082 00084 Vec up_units_bias_pos_stats; 00086 Vec up_units_bias_neg_stats; 00088 TVec<Vec> down_units_params_pos_stats; 00090 TVec<Vec> down_units_params_neg_stats; 00091 00092 public: 00093 //##### Public Member Functions ######################################### 00094 00096 RBMQLParameters( real the_learning_rate=0 ); 00097 00099 RBMQLParameters( string down_types, string up_types, 00100 real the_learning_rate=0 ); 00101 00102 // Your other public member functions go here 00103 00105 virtual void accumulatePosStats( const Vec& down_values, 00106 const Vec& up_values ); 00107 00109 virtual void accumulateNegStats( const Vec& down_values, 00110 const Vec& up_values ); 00111 00113 virtual void update(); 00114 00116 virtual void clearStats(); 00117 00121 virtual void computeUnitActivations( int start, int length, 00122 const Vec& activations ) const; 00123 00134 // virtual void bpropUpdate(const Vec& input, const Vec& output, 00135 // const Vec& output_gradient); 00136 00139 virtual void bpropUpdate(const Vec& input, const Vec& output, 00140 Vec& input_gradient, 00141 const Vec& output_gradient); 00142 00146 virtual void forget(); 00147 00152 // virtual void finalize(); 00153 00155 virtual int nParameters(bool share_up_params, bool share_down_params) const; 00156 00162 virtual Vec makeParametersPointHere(const Vec& global_parameters, bool share_up_params, bool share_down_params); 00163 00164 //##### PLearn::Object Protocol ######################################### 00165 00166 // Declares other standard object methods. 00167 PLEARN_DECLARE_OBJECT(RBMQLParameters); 00168 00169 // Simply calls inherited::build() then build_() 00170 virtual void build(); 00171 00173 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00174 00175 protected: 00176 00177 protected: 00178 //##### Protected Member Functions ###################################### 00180 static void declareOptions(OptionList& ol); 00181 00182 private: 00183 //##### Private Member Functions ######################################## 00184 00186 void build_(); 00187 00188 private: 00189 //##### Private Data Members ############################################ 00190 00191 // The rest of the private stuff goes here 00192 }; 00193 00194 // Declares a few other classes and functions related to this class 00195 DECLARE_OBJECT_PTR(RBMQLParameters); 00196 00197 } // end of namespace PLearn 00198 00199 #endif 00200 00201 00202 /* 00203 Local Variables: 00204 mode:c++ 00205 c-basic-offset:4 00206 c-file-style:"stroustrup" 00207 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00208 indent-tabs-mode:nil 00209 fill-column:79 00210 End: 00211 */ 00212 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :