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