Softmax.h

Go to the documentation of this file.

#ifndef GRT_SOFTMAX_HEADER
#define GRT_SOFTMAX_HEADER

#include "../../CoreModules/Classifier.h"
#include "SoftmaxModel.h"

GRT_BEGIN_NAMESPACE

class GRT_API Softmax : public Classifier
{
    public:
    Softmax(const bool useScaling=false,const Float learningRate = 0.1,const Float minChange = 1.0e-10,const UINT maxNumEpochs = 1000,const UINT batchSize = 50);
    
    Softmax(const Softmax &rhs);
    
    virtual ~Softmax(void);
    
    Softmax &operator=(const Softmax &rhs);
    
    virtual bool deepCopyFrom(const Classifier *classifier);
    
    virtual bool train_(ClassificationData &trainingData);
    
    virtual bool predict_(VectorFloat &inputVector);
    
    virtual bool clear();
    
    virtual bool save( std::fstream &file ) const;
    
    virtual bool load( std::fstream &file );
    
    Vector< SoftmaxModel > getModels() const;


    static std::string getId();
    
    //Tell the compiler we are using the base class train method to stop hidden virtual function warnings
    using MLBase::save;
    using MLBase::load;
    
protected:
    bool trainSoftmaxModel(UINT classLabel,SoftmaxModel &model,ClassificationData &data);
    bool loadLegacyModelFromFile( std::fstream &file );
    
    UINT batchSize;
    Vector< SoftmaxModel > models;

private:
    static const std::string id;
    static RegisterClassifierModule< Softmax > registerModule;
};

GRT_END_NAMESPACE

#endif //GRT_SOFTMAX_HEADER