PLearn 0.1
PythonProcessedLearner.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // PythonProcessedLearner.h
00004 //
00005 // Copyright (C) 2006 Nicolas Chapados
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: Nicolas Chapados
00036 
00040 #ifndef PythonProcessedLearner_INC
00041 #define PythonProcessedLearner_INC
00042 
00043 // Python includes must come first! (as per Python doc)
00044 #include <plearn/python/PythonCodeSnippet.h>
00045 
00046 #include <plearn_learners/generic/PLearner.h>
00047 
00048 namespace PLearn {
00049 
00101 class PythonProcessedLearner : public PLearner
00102 {
00103     typedef PLearner inherited;
00104 
00105 public:
00106     //#####  Public Build Options  ############################################
00107 
00114     string m_code;
00115 
00121     map<string,string> m_params;
00122 
00123 public:
00124     //#####  Public Member Functions  #########################################
00125 
00127     PythonProcessedLearner();
00128 
00129 
00130     //#####  PLearner Member Functions  #######################################
00131 
00133     virtual void setTrainingSet(VMat training_set, bool call_forget=true);
00134 
00137     virtual int outputsize() const;
00138 
00140     virtual void forget();
00141 
00143     virtual void train();
00144 
00146     virtual void computeOutput(const Vec& input, Vec& output) const;
00147 
00149     virtual void computeCostsFromOutputs(const Vec& input, const Vec& output,
00150                                          const Vec& target, Vec& costs) const;
00151 
00153     virtual TVec<std::string> getTestCostNames() const;
00154 
00156     virtual TVec<std::string> getTrainCostNames() const;
00157 
00159     virtual TVec<string> getOutputNames() const;
00160 
00161 
00162     //#####  PLearn::Object Protocol  #########################################
00163 
00164     // Declares other standard object methods.
00165     PLEARN_DECLARE_OBJECT(PythonProcessedLearner);
00166 
00167     // Simply calls inherited::build() then build_()
00168     virtual void build();
00169 
00171     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00172 
00173 protected:
00175     static void declareOptions(OptionList& ol);
00176 
00178     PythonObjectWrapper getParams(const TVec<PythonObjectWrapper>& args) const;
00179 
00182     PythonObjectWrapper getParam(const TVec<PythonObjectWrapper>& args) const;
00183 
00186     PythonObjectWrapper setParam(const TVec<PythonObjectWrapper>& args);
00187     
00190     void compileAndInject();
00191 
00193     void setOutputNamesFromParams();
00194     
00195 protected:
00197     TVec<string> m_outputnames;
00198 
00200     PP<PythonCodeSnippet> python;
00201 
00202 private:
00204     void build_();
00205 };
00206 
00207 // Declares a few other classes and functions related to this class
00208 DECLARE_OBJECT_PTR(PythonProcessedLearner);
00209 
00210 } // end of namespace PLearn
00211 
00212 #endif
00213 
00214 
00215 /*
00216   Local Variables:
00217   mode:c++
00218   c-basic-offset:4
00219   c-file-style:"stroustrup"
00220   c-file-offsets:((innamespace . 0)(inline-open . 0))
00221   indent-tabs-mode:nil
00222   fill-column:79
00223   End:
00224 */
00225 // 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