xapian-letor/ranker.h

   1 /* ranker.h: The abstract ranker file.
   2  *
   3  * Copyright (C) 2012 Parth Gupta
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License as
   7  * published by the Free Software Foundation; either version 2 of the
   8  * License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
  18  * USA
  19  */
  20
  21 #ifndef RANKER_H
  22 #define RANKER_H
  23
  24
  25 #include <xapian.h>
  26 #include <xapian/intrusive_ptr.h>
  27 #include <xapian/types.h>
  28 #include <xapian/visibility.h>
  29
  30 #include <ranklist.h>
  31 #include <evalmetric.h>
  32
  33 #include <list>
  34 #include <map>
  35
  36
  37 using namespace std;
  38
  39
  40 namespace Xapian {
  41
  42 class XAPIAN_VISIBILITY_DEFAULT Ranker {
  43
  44
  45     std::list<Xapian::RankList> traindata;
  46     std::list<Xapian::RankList> validata;
  47     std::list<Xapian::RankList> testdata;
  48
  49     Xapian::EvalMetric trainMetric;
  50     Xapian::EvalMetric testMetric;
  51   public:
  52     Ranker();
  53
  54     /* Override all the four methods below in the ranker sub-classes files
  55      * wiz svmranker.cc , listnet.cc, listmle.cc and so on
  56      */
  57     std::list<double> rank(const Xapian::RankList & rl);
  58
  59     void learn_model();
  60
  61     void load_model(const std::string & model_file);
  62
  63     void save_model();
  64
  65     /* This method should read the letor format data and transform into the list of
  66      * Xapian::RankList format
  67      */
  68     std::list<Xapian::RankList> load_data(const std::string & data_file);
  69
  70 };
  71
  72 }
  73 #endif /* RANKER_H */