PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // UndirectedSoftmaxModule.h 00004 // 00005 // Copyright (C) 2005 Yoshua Bengio 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 /* ******************************************************* 00036 * $Id$ 00037 ******************************************************* */ 00038 00039 // Authors: Yoshua Bengio 00040 00044 #ifndef UndirectedSoftmaxModule_INC 00045 #define UndirectedSoftmaxModule_INC 00046 00047 #include <plearn/base/Object.h> 00048 #include <plearn/math/TMat_maths.h> 00049 #include "../OnlineLearningModule.h" 00050 00051 namespace PLearn { 00052 00059 class UndirectedSoftmaxModule : public OnlineLearningModule 00060 { 00061 typedef OnlineLearningModule inherited; 00062 00063 public: 00064 //##### Public Build Options ############################################ 00065 00067 real start_learning_rate; 00070 real decrease_constant; 00071 00072 Mat init_weights; 00073 Vec init_biases; 00074 00075 real init_weights_random_scale; 00076 00077 real L1_penalty_factor, L2_penalty_factor; 00078 00079 public: 00080 //##### Public Member Functions ######################################### 00081 00083 UndirectedSoftmaxModule(); 00084 00085 // Your other public member functions go here 00086 00087 virtual void fprop(const Vec& input, Vec& output) const; 00088 00089 virtual void bpropUpdate(const Vec& input, const Vec& output, 00090 const Vec& output_gradient); 00091 00092 virtual void bpropUpdate(const Vec& input, const Vec& output, 00093 Vec& input_gradient, const Vec& output_gradient); 00094 00095 virtual void bbpropUpdate(const Vec& input, const Vec& output, 00096 const Vec& output_gradient, 00097 const Vec& output_diag_hessian); 00098 00099 virtual void bbpropUpdate(const Vec& input, const Vec& output, 00100 Vec& input_gradient, 00101 const Vec& output_gradient, 00102 Vec& input_diag_hessian, 00103 const Vec& output_diag_hessian); 00104 00105 virtual void forget(); 00106 00107 //##### PLearn::Object Protocol ######################################### 00108 00109 // Declares other standard object methods. 00110 PLEARN_DECLARE_OBJECT(UndirectedSoftmaxModule); 00111 00112 // Simply calls inherited::build() then build_() 00113 virtual void build(); 00114 00116 // (PLEASE IMPLEMENT IN .cc) 00117 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00118 00119 public: 00120 //##### Protected Options ############################################### 00121 Mat weights; // one output neuron per line 00122 Vec biases; 00123 00124 protected: 00125 //##### Protected Member Functions ###################################### 00126 virtual void resetWeights(); 00127 00129 static void declareOptions(OptionList& ol); 00130 00131 private: 00132 //##### Private Member Functions ######################################## 00133 00135 void build_(); 00136 00137 private: 00138 //##### Private Data Members ############################################ 00139 00140 // The rest of the private stuff goes here 00141 real learning_rate; 00142 int step_number; 00143 00144 }; 00145 00146 // Declares a few other classes and functions related to this class 00147 DECLARE_OBJECT_PTR(UndirectedSoftmaxModule); 00148 00149 } // end of namespace PLearn 00150 00151 #endif 00152 00153 00154 /* 00155 Local Variables: 00156 mode:c++ 00157 c-basic-offset:4 00158 c-file-style:"stroustrup" 00159 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00160 indent-tabs-mode:nil 00161 fill-column:79 00162 End: 00163 */ 00164 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :