PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // CombiningCostsModule.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 CombiningCostsModule_INC 00041 #define CombiningCostsModule_INC 00042 00043 #include <plearn_learners/online/CostModule.h> 00044 00045 namespace PLearn { 00046 00054 class CombiningCostsModule : public CostModule 00055 { 00056 typedef CostModule inherited; 00057 00058 public: 00059 //##### Public Build Options ############################################ 00060 00062 TVec< PP<CostModule> > sub_costs; 00063 00065 Vec cost_weights; 00066 00068 int n_sub_costs; 00069 00070 public: 00071 //##### Public Member Functions ######################################### 00072 00074 CombiningCostsModule(); 00075 00076 // Your other public member functions go here 00077 00079 virtual void bpropAccUpdate(const TVec<Mat*>& ports_value, 00080 const TVec<Mat*>& ports_gradient); 00081 00083 virtual void fprop(const Vec& input, const Vec& target, Vec& cost) const; 00084 00086 virtual void fprop(const Mat& inputs, const Mat& targets, Mat& costs) 00087 const; 00088 00091 virtual void bpropUpdate(const Vec& input, const Vec& target, real cost, 00092 Vec& input_gradient, bool accumulate=false); 00093 00095 virtual void bpropUpdate(const Mat& inputs, const Mat& targets, 00096 const Vec& costs, Mat& input_gradients, bool accumulate = false); 00097 00099 virtual void bpropUpdate(const Vec& input, const Vec& target, real cost); 00100 00103 virtual void bbpropUpdate(const Vec& input, const Vec& target, real cost, 00104 Vec& input_gradient, Vec& input_diag_hessian, 00105 bool accumulate=false); 00106 00108 virtual void bbpropUpdate(const Vec& input, const Vec& target, real cost); 00109 00113 virtual void forget(); 00114 00116 virtual void setLearningRate(real dynamic_learning_rate); 00117 00121 virtual void finalize(); 00122 00124 virtual bool bpropDoesNothing(); 00125 00127 virtual TVec<string> costNames(); 00128 00129 //##### PLearn::Object Protocol ######################################### 00130 00131 // Declares other standard object methods. 00132 PLEARN_DECLARE_OBJECT(CombiningCostsModule); 00133 00134 // Simply calls inherited::build() then build_() 00135 virtual void build(); 00136 00138 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00139 00140 protected: 00141 //##### Protected Member Functions ###################################### 00142 00144 static void declareOptions(OptionList& ol); 00145 00146 private: 00147 //##### Private Member Functions ######################################## 00148 00150 void build_(); 00151 00152 private: 00153 //##### Private Data Members ############################################ 00154 00155 // The rest of the private stuff goes here 00156 00158 mutable Vec sub_costs_values; 00159 00161 mutable Mat sub_costs_mbatch_values; 00162 00164 mutable Vec partial_gradient; 00165 00168 Mat partial_gradients; 00169 00171 mutable Vec partial_diag_hessian; 00172 }; 00173 00174 // Declares a few other classes and functions related to this class 00175 DECLARE_OBJECT_PTR(CombiningCostsModule); 00176 00177 } // end of namespace PLearn 00178 00179 #endif 00180 00181 00182 /* 00183 Local Variables: 00184 mode:c++ 00185 c-basic-offset:4 00186 c-file-style:"stroustrup" 00187 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00188 indent-tabs-mode:nil 00189 fill-column:79 00190 End: 00191 */ 00192 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :