---

trainer.h

Go to the documentation of this file.

#ifndef __INANNA_TRAINER_H__
#define __INANNA_TRAINER_H__

#include <magic/mparameter.h>
#include "inanna/annetwork.h"

// Local predeclarations
class Trainer;
class TrainingObserver;


//                     -----           o                                     //
//                       |        ___      _    ___                          //
//                       |   |/\  ___| | |/ \  /   ) |/\                     //
//                       |   |   (   | | |   | |---  |                       //
//                       |   |    \__| | |   |  \__  |                       //

class Trainer : public Object, public IParameterized {
  public:
                            Trainer         ();

    virtual void            init            (const StringMap& params);

    virtual double          train           (ANNetwork&        network,
                                             const PatternSet& trainset,
                                             int               cycles,
                                             const PatternSet* pValidationSet=NULL,
                                             int               validationInterval=0);
    
    void                    setTerminator   (const String& name) {mTerminatorName=name;}

    // Informative methods
    
    int                     cyclesTrained   () const {return mTrained;}

    int                     totalCycles     () const {return mTotalTrained;}

    double                  generalizLoss   () const {return mGeneralizationLoss;}

    void                    setGeneralizLoss(double gl) {mGeneralizationLoss = gl;}

    const Vector&           trainingRecord  () const {return mTrainingProfile;}
    
    const Vector&           validationRecord() const {return mValidationProfile;}

    void                    setObserver     (TrainingObserver* observer) {pTrainingObserver=observer;}
    
  protected:

    virtual void            initTrain       (ANNetwork& network) const;

    virtual double          trainOnce       (ANNetwork& network, const PatternSet& set) const {MUST_OVERLOAD; return 0.0;}

  protected:

    String  mTerminatorName;

    int     mTrained;

    int     mTotalTrained;

    double  mGeneralizationLoss;

    Vector  mTrainingProfile;
    
    Vector  mValidationProfile;

    TrainingObserver*   pTrainingObserver;
    
    friend class Terminator;
};



// -----           o       o              ___                                        //
//   |        ___      _       _         |   | |      ____  ___             ___      //
//   |   |/\  ___| | |/ \  | |/ \   ___  |   | |---  (     /   ) |/\ |   | /   ) |/\ //
//   |   |   (   | | |   | | |   | (   \ |   | |   )  \__  |---  |    \ /  |---  |   //
//   |   |    \__| | |   | | |   |  ---/ `___´ |__/  ____)  \__  |     V    \__  |   //
//                                  __/                                              //

class TrainingObserver : public Object {
  public:
                    TrainingObserver    () {mStop = false;}

    void            initTraining        () {mStop = false;}

    bool            wantsToStop         () const {return mStop;}

    virtual void    cycleTrained        (const Trainer& trainer, int totalCycles)=0;
    
  protected:
    void            stopTraining        () {mStop=true;}
    
  private:
    bool    mStop;
};

#endif

---