ListNet (Learning to Rank 2.11 API)

java.lang.Object
- ciir.umass.edu.learning.Ranker
- - ciir.umass.edu.learning.neuralnet.RankNet
  - - ciir.umass.edu.learning.neuralnet.ListNet

```
public class ListNet
extends RankNet
```

Field Summary

Fields
Modifier and Type Field Description

static double learningRate

static int nHiddenLayer

static int nIteration
- Fields inherited from class ciir.umass.edu.learning.neuralnet.RankNet
  bestModelOnValidation, error, inputLayer, lastError, layers, misorderedPairs, nHiddenNodePerLayer, outputLayer, straightLoss, totalPairs
- Fields inherited from class ciir.umass.edu.learning.Ranker
  bestScoreOnValidationData, features, samples, scoreOnTrainingData, scorer, validationSamples, verbose

Constructor Summary

Constructors
Constructor Description

ListNet()

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`backPropagate(float[] labels)`
`Ranker`	`createNew()`
`protected void`	`estimateLoss()`
`double`	`eval(DataPoint p)`
`protected float[]`	`feedForward(RankList rl)`
`void`	`init()`	Main public functions
`void`	`learn()`
`void`	`loadFromString(java.lang.String fullText)`
`java.lang.String`	`model()`
`java.lang.String`	`name()`
`void`	`printParameters()`
`java.lang.String`	`toString()`

Methods inherited from class ciir.umass.edu.learning.neuralnet.RankNet
addHiddenLayer, addInput, batchBackPropagate, batchFeedForward, clearNeuronOutputs, computePairWeight, connect, crossEntropy, internalReorder, printNetworkConfig, printWeightVector, propagate, restoreBestModelOnValidation, saveBestModelOnValidation, setInputOutput, setInputOutput, wire

Methods inherited from class ciir.umass.edu.learning.Ranker
copy, getFeatures, getScoreOnTrainingData, getScoreOnValidationData, PRINT, PRINT, PRINT_MEMORY_USAGE, PRINTLN, PRINTLN, PRINTTIME, rank, rank, save, setFeatures, setMetricScorer, setTrainingSet, setValidationSet

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

nIteration
```
public static int nIteration
```

learningRate
```
public static double learningRate
```

nHiddenLayer
```
public static int nHiddenLayer
```

Constructor Detail

ListNet
```
public ListNet()
```

ListNet

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

Method Detail
- feedForward
```
protected float[] feedForward(RankList rl)
```
- backPropagate
```
protected void backPropagate(float[] labels)
```
- estimateLoss
```
protected void estimateLoss()
```
  Overrides:
  
  estimateLoss in class RankNet
- init
```
public void init()
```
  Description copied from class: RankNet
  
  Main public functions
  
  Overrides:
  
  init in class RankNet
- learn
```
public void learn()
```
  Overrides:
  
  learn in class RankNet
- eval
```
public double eval(DataPoint p)
```
  Overrides:
  
  eval in class RankNet
- createNew
```
public Ranker createNew()
```
  Overrides:
  
  createNew in class RankNet
- toString
```
public java.lang.String toString()
```
  Overrides:
  
  toString in class RankNet
- model
```
public java.lang.String model()
```
  Overrides:
  
  model in class RankNet
- loadFromString
```
public void loadFromString(java.lang.String fullText)
```
  Overrides:
  
  loadFromString in class RankNet
- printParameters
```
public void printParameters()
```
  Overrides:
  
  printParameters in class RankNet
- name
```
public java.lang.String name()
```
  Overrides:
  
  name in class RankNet