EmbeddedSequentialLearner.h

Go to the documentation of this file.

// -*- C++ -*-

// EmbeddedSequentialLearner.h
//
// Copyright (C) 2003 Rejean Ducharme, Yoshua Bengio
// Copyright (C) 2003 Pascal Vincent
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//  1. Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
//
//  2. Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in the
//     documentation and/or other materials provided with the distribution.
//
//  3. The name of the authors may not be used to endorse or promote
//     products derived from this software without specific prior written
//     permission.
//
// THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
// NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
// TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// This file is part of the PLearn library. For more information on the PLearn
// library, go to the PLearn Web site at www.plearn.org



#ifndef EMBEDDED_SEQUENTIAL_LEARNER
#define EMBEDDED_SEQUENTIAL_LEARNER

#include "SequentialLearner.h"

namespace PLearn {
using namespace std;

class EmbeddedSequentialLearner: public SequentialLearner
{
  public:

    PP<PLearner> learner;  // the underlying Learner

  private:
    void build_();

  protected:
    static void declareOptions(OptionList& ol);

  public:

    EmbeddedSequentialLearner();

    virtual void build();
    
    virtual void train();
 
    virtual void test(VMat testset, PP<VecStatsCollector> test_stats,
        VMat testoutputs=0, VMat testcosts=0) const;

    virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);

    // PLearner methods to be passed to the underlying Learner

    virtual void forget();
 
    virtual void computeOutput(const Vec& input, Vec& output);
 
    virtual void computeCostsFromOutputs(const Vec& input, const Vec& output,
        const Vec& target, Vec& costs);
 
    virtual void computeOutputAndCosts(const Vec& input, const Vec& target,
        Vec& output, Vec& costs);
 
    virtual void computeCostsOnly(const Vec& input, const Vec& target, Vec& costs);
 
    virtual TVec<string> getTestCostNames() const;
 
    virtual TVec<string> getTrainCostNames() const;

    PLEARN_DECLARE_OBJECT(EmbeddedSequentialLearner);

};

DECLARE_OBJECT_PTR(EmbeddedSequentialLearner);

} // end of namespace PLearn

#endif

---