PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // SemiSupervisedDBN.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 SemiSupervisedDBN_INC 00041 #define SemiSupervisedDBN_INC 00042 00043 #include <plearn_learners/generic/PLearner.h> 00044 00045 namespace PLearn { 00046 00055 class SemiSupervisedDBN : public PLearner 00056 { 00057 typedef PLearner inherited; 00058 00059 public: 00060 //##### Public Build Options ############################################ 00061 00064 00065 public: 00066 //##### Public Member Functions ######################################### 00067 00069 // ### Make sure the implementation in the .cc 00070 // ### initializes all fields to reasonable default values. 00071 SemiSupervisedDBN(); 00072 00073 00074 //##### PLearner Member Functions ####################################### 00075 00078 // (PLEASE IMPLEMENT IN .cc) 00079 virtual int outputsize() const; 00080 00084 // (PLEASE IMPLEMENT IN .cc) 00085 virtual void forget(); 00086 00090 // (PLEASE IMPLEMENT IN .cc) 00091 virtual void train(); 00092 00094 // (PLEASE IMPLEMENT IN .cc) 00095 virtual void computeOutput(const Vec& input, Vec& output) const; 00096 00098 // (PLEASE IMPLEMENT IN .cc) 00099 virtual void computeCostsFromOutputs(const Vec& input, const Vec& output, 00100 const Vec& target, Vec& costs) const; 00101 00104 // (PLEASE IMPLEMENT IN .cc) 00105 virtual TVec<std::string> getTestCostNames() const; 00106 00109 // (PLEASE IMPLEMENT IN .cc) 00110 virtual TVec<std::string> getTrainCostNames() const; 00111 00112 00113 // *** SUBCLASS WRITING: *** 00114 // While in general not necessary, in case of particular needs 00115 // (efficiency concerns for ex) you may also want to overload 00116 // some of the following methods: 00117 // virtual void computeOutputAndCosts(const Vec& input, const Vec& target, 00118 // Vec& output, Vec& costs) const; 00119 // virtual void computeCostsOnly(const Vec& input, const Vec& target, 00120 // Vec& costs) const; 00121 // virtual void test(VMat testset, PP<VecStatsCollector> test_stats, 00122 // VMat testoutputs=0, VMat testcosts=0) const; 00123 // virtual int nTestCosts() const; 00124 // virtual int nTrainCosts() const; 00125 // virtual void resetInternalState(); 00126 // virtual bool isStatefulLearner() const; 00127 00128 00129 //##### PLearn::Object Protocol ######################################### 00130 00131 // Declares other standard object methods. 00132 // ### If your class is not instantiatable (it has pure virtual methods) 00133 // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT_METHODS 00134 PLEARN_DECLARE_OBJECT(SemiSupervisedDBN); 00135 00136 // Simply calls inherited::build() then build_() 00137 virtual void build(); 00138 00140 // (PLEASE IMPLEMENT IN .cc) 00141 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00142 00143 protected: 00144 //##### Protected Options ############################################### 00145 00146 // ### Declare protected option fields (such as learned parameters) here 00147 // ... 00148 00149 protected: 00150 //##### Protected Member Functions ###################################### 00151 00153 // (PLEASE IMPLEMENT IN .cc) 00154 static void declareOptions(OptionList& ol); 00155 00156 private: 00157 //##### Private Member Functions ######################################## 00158 00160 // (PLEASE IMPLEMENT IN .cc) 00161 void build_(); 00162 00163 private: 00164 //##### Private Data Members ############################################ 00165 00166 // The rest of the private stuff goes here 00167 }; 00168 00169 // Declares a few other classes and functions related to this class 00170 DECLARE_OBJECT_PTR(SemiSupervisedDBN); 00171 00172 } // end of namespace PLearn 00173 00174 #endif 00175 00176 00177 /* 00178 Local Variables: 00179 mode:c++ 00180 c-basic-offset:4 00181 c-file-style:"stroustrup" 00182 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00183 indent-tabs-mode:nil 00184 fill-column:79 00185 End: 00186 */ 00187 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :