Package ciir.umass.edu.learning

Class Ranker

java.lang.Object

ciir.umass.edu.learning.Ranker

Direct Known Subclasses:

AdaRank, CoorAscent, LambdaMART, LinearRegRank, RankBoost, RankNet, RFRanker

public abstract class Ranker
extends java.lang.Object

Author:

vdang This class implements the generic Ranker interface. Each ranking algorithm implemented has to extend this class.

Field Summary

Fields

Modifier and Type	Field	Description
protected double	bestScoreOnValidationData
protected int[]	features
protected java.util.List<RankList>	samples
protected double	scoreOnTrainingData
protected MetricScorer	scorer
protected java.util.List<RankList>	validationSamples
static boolean	verbose

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Ranker()
protected	Ranker(java.util.List<RankList> samples, int[] features, MetricScorer scorer)

Method Summary

Modifier and Type	Method	Description
protected void	copy(double[] source, double[] target)
abstract Ranker	createNew()
double	eval(DataPoint p)
int[]	getFeatures()
double	getScoreOnTrainingData()
double	getScoreOnValidationData()
abstract void	init()	HAVE TO BE OVER-RIDDEN IN SUB-CLASSES
abstract void	learn()
abstract void	loadFromString(java.lang.String fullText)
abstract java.lang.String	model()
abstract java.lang.String	name()
protected void	PRINT(int[] len, java.lang.String[] msgs)
protected void	PRINT(java.lang.String msg)
protected void	PRINT_MEMORY_USAGE()
protected void	PRINTLN(int[] len, java.lang.String[] msgs)
protected void	PRINTLN(java.lang.String msg)
abstract void	printParameters()
protected void	PRINTTIME()
RankList	rank(RankList rl)
java.util.List<RankList>	rank(java.util.List<RankList> l)
void	save(java.lang.String modelFile)
void	setFeatures(int[] features)
void	setMetricScorer(MetricScorer scorer)
void	setTrainingSet(java.util.List<RankList> samples)
void	setValidationSet(java.util.List<RankList> samples)
abstract java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

verbose

public static boolean verbose

samples

protected java.util.List<RankList> samples

features

protected int[] features

scorer

protected MetricScorer scorer

scoreOnTrainingData

protected double scoreOnTrainingData

bestScoreOnValidationData

protected double bestScoreOnValidationData

validationSamples

protected java.util.List<RankList> validationSamples

Constructor Detail

Ranker

protected Ranker()

Ranker

protected Ranker(java.util.List<RankList> samples,
                 int[] features,
                 MetricScorer scorer)

Method Detail

setTrainingSet

public void setTrainingSet(java.util.List<RankList> samples)

setFeatures

public void setFeatures(int[] features)

setValidationSet

public void setValidationSet(java.util.List<RankList> samples)

setMetricScorer

public void setMetricScorer(MetricScorer scorer)

getScoreOnTrainingData

public double getScoreOnTrainingData()

getScoreOnValidationData

public double getScoreOnValidationData()

getFeatures

public int[] getFeatures()

rank

public RankList rank(RankList rl)

rank

public java.util.List<RankList> rank(java.util.List<RankList> l)

save

public void save(java.lang.String modelFile)

PRINT

protected void PRINT(java.lang.String msg)

PRINTLN

protected void PRINTLN(java.lang.String msg)

PRINT

protected void PRINT(int[] len,
                     java.lang.String[] msgs)

PRINTLN

protected void PRINTLN(int[] len,
                       java.lang.String[] msgs)

PRINTTIME

protected void PRINTTIME()

PRINT_MEMORY_USAGE

protected void PRINT_MEMORY_USAGE()

copy

protected void copy(double[] source,
                    double[] target)

init

public abstract void init()

HAVE TO BE OVER-RIDDEN IN SUB-CLASSES

learn

public abstract void learn()

eval

public double eval(DataPoint p)

createNew

public abstract Ranker createNew()

toString

public abstract java.lang.String toString()

Overrides:

toString in class java.lang.Object

model

public abstract java.lang.String model()

loadFromString

public abstract void loadFromString(java.lang.String fullText)

name

public abstract java.lang.String name()

printParameters

public abstract void printParameters()