PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // SoftmaxNLLCostModule.h 00004 // 00005 // Copyright (C) 2008 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 SoftmaxNLLCostModule_INC 00041 #define SoftmaxNLLCostModule_INC 00042 00043 #include <plearn_learners/online/CostModule.h> 00044 00045 namespace PLearn { 00046 00053 class SoftmaxNLLCostModule : public CostModule 00054 { 00055 typedef CostModule inherited; 00056 00057 public: 00058 //##### Public Build Options ############################################ 00059 00060 00061 public: 00062 //##### Public Member Functions ######################################### 00063 00065 SoftmaxNLLCostModule(); 00066 00067 // Your other public member functions go here 00068 00070 virtual void fprop(const Vec& input, const Vec& target, Vec& cost) const; 00071 00073 virtual void fprop(const Mat& inputs, const Mat& targets, Mat& costs) 00074 const; 00075 00077 virtual void fprop(const TVec<Mat*>& ports_value); 00078 00081 virtual void bpropUpdate(const Vec& input, const Vec& target, real cost, 00082 Vec& input_gradient, bool accumulate=false); 00083 00085 virtual void bpropUpdate(const Mat& inputs, const Mat& targets, 00086 const Vec& costs, Mat& input_gradients, bool accumulate = false); 00087 00089 virtual void bpropUpdate(const Vec& input, const Vec& target, real cost) 00090 {} 00091 00093 virtual void bpropAccUpdate(const TVec<Mat*>& ports_value, 00094 const TVec<Mat*>& ports_gradient); 00095 00098 virtual void bbpropUpdate(const Vec& input, const Vec& target, real cost, 00099 Vec& input_gradient, Vec& input_diag_hessian, 00100 bool accumulate=false); 00101 00103 virtual void bbpropUpdate(const Vec& input, const Vec& target, real cost) 00104 {} 00105 00107 virtual void setLearningRate(real dynamic_learning_rate) {} 00108 00110 virtual TVec<string> costNames(); 00111 00112 //##### PLearn::Object Protocol ######################################### 00113 00114 // Declares other standard object methods. 00115 // ### If your class is not instantiatable (it has pure virtual methods) 00116 // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT 00117 PLEARN_DECLARE_OBJECT(SoftmaxNLLCostModule); 00118 00119 // Simply calls inherited::build() then build_() 00120 virtual void build(); 00121 00123 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00124 00125 00126 protected: 00127 //##### Protected Member Functions ###################################### 00128 00130 static void declareOptions(OptionList& ol); 00131 00132 private: 00133 //##### Private Member Functions ######################################## 00134 00136 void build_(); 00137 00138 private: 00139 //##### Private Data Members ############################################ 00140 00141 // The rest of the private stuff goes here 00142 mutable Vec tmp_vec; 00143 mutable Mat tmp_mat; 00144 }; 00145 00146 // Declares a few other classes and functions related to this class 00147 DECLARE_OBJECT_PTR(SoftmaxNLLCostModule); 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 :