VwLearner.h

Go to the documentation of this file.

/*
 * Copyright (c) 2009 Yahoo! Inc.  All rights reserved.  The copyrights
 * embodied in the content of this file are licensed under the BSD
 * (revised) open source license.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * Written (W) 2011 Shashwat Lal Das
 * Adaptation of Vowpal Wabbit v5.1.
 * Copyright (C) 2011 Berlin Institute of Technology and Max-Planck-Society.
 */

#ifndef _VW_LEARNER_H__
#define _VW_LEARNER_H__

#include <shogun/base/SGObject.h>
#include <shogun/base/Parameter.h>
#include <shogun/classifier/vw/vw_common.h>
#include <shogun/classifier/vw/VwRegressor.h>

namespace shogun
{
class CVwLearner: public CSGObject
{
public:
    CVwLearner()
        : CSGObject(), reg(NULL), env(NULL)
    {
        register_learner_params();
    }

    CVwLearner(CVwRegressor* regressor, CVwEnvironment* vw_env)
        : CSGObject(), reg(regressor), env(vw_env)
    {
        SG_REF(reg);
        SG_REF(env);
        register_learner_params();
    }

    virtual ~CVwLearner()
    {
        if (reg)
            SG_UNREF(reg);
        if (env)
            SG_UNREF(env);
    }

    void register_learner_params()
    {
        SG_ADD((CSGObject**) &reg, "vw_regressor", "Regressor object",
               MS_NOT_AVAILABLE);
        SG_ADD((CSGObject**) &env, "vw_env", "Environment",
               MS_NOT_AVAILABLE);
    }

    virtual void train(VwExample* &ex, float32_t update) = 0;

    virtual const char* get_name() const { return "VwLearner"; }

protected:
    CVwRegressor *reg;
    CVwEnvironment *env;
};
}
#endif // _VW_LEARNER_H__