SHOGUN  4.2.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
VwLearner.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2009 Yahoo! Inc. All rights reserved. The copyrights
3  * embodied in the content of this file are licensed under the BSD
4  * (revised) open source license.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * Written (W) 2011 Shashwat Lal Das
12  * Adaptation of Vowpal Wabbit v5.1.
13  * Copyright (C) 2011 Berlin Institute of Technology and Max-Planck-Society.
14  */
15 
16 #ifndef _VW_LEARNER_H__
17 #define _VW_LEARNER_H__
18 
19 #include <shogun/lib/config.h>
20 
21 #include <shogun/base/SGObject.h>
22 #include <shogun/base/Parameter.h>
25 
26 namespace shogun
27 {
35 class CVwLearner: public CSGObject
36 {
37 public:
42  : CSGObject(), reg(NULL), env(NULL)
43  {
45  }
46 
53  CVwLearner(CVwRegressor* regressor, CVwEnvironment* vw_env)
54  : CSGObject(), reg(regressor), env(vw_env)
55  {
56  SG_REF(reg);
57  SG_REF(env);
59  }
60 
64  virtual ~CVwLearner()
65  {
66  if (reg)
67  SG_UNREF(reg);
68  if (env)
69  SG_UNREF(env);
70  }
71 
76  {
77  SG_ADD((CSGObject**) &reg, "vw_regressor", "Regressor object",
79  SG_ADD((CSGObject**) &env, "vw_env", "Environment",
81  }
82 
89  virtual void train(VwExample* &ex, float32_t update) = 0;
90 
96  virtual const char* get_name() const { return "VwLearner"; }
97 
98 protected:
103 };
104 }
105 #endif // _VW_LEARNER_H__
Class CVwEnvironment is the environment used by VW.
Definition: VwEnvironment.h:41
void(* update)(float *foo, float bar)
Definition: JLCoverTree.h:529
CVwRegressor * reg
Regressor object that will be used for getting updates.
Definition: VwLearner.h:100
virtual ~CVwLearner()
Definition: VwLearner.h:64
#define SG_REF(x)
Definition: SGObject.h:54
Class SGObject is the base class of all shogun objects.
Definition: SGObject.h:115
virtual const char * get_name() const
Definition: VwLearner.h:96
Base class for all VW learners.
Definition: VwLearner.h:35
Regressor used by VW.
Definition: VwRegressor.h:37
virtual void train(VwExample *&ex, float32_t update)=0
Example class for VW.
Definition: vw_example.h:58
void register_learner_params()
Definition: VwLearner.h:75
float float32_t
Definition: common.h:49
#define SG_UNREF(x)
Definition: SGObject.h:55
all of classes and functions are contained in the shogun namespace
Definition: class_list.h:18
CVwEnvironment * env
Environment.
Definition: VwLearner.h:102
#define SG_ADD(...)
Definition: SGObject.h:84
CVwLearner(CVwRegressor *regressor, CVwEnvironment *vw_env)
Definition: VwLearner.h:53

SHOGUN Machine Learning Toolbox - Documentation