Experiments (Stanford JavaNLP API)

java.lang.Object
- edu.stanford.nlp.maxent.Experiments

Direct Known Subclasses:

TaggerExperiments
```
public class Experiments
extends java.lang.Object
```
This class represents the training samples. It can return statistics of them, for example the frequency of each x or y. in the training data.

Version:

1.0

Author:

Kristina Toutanova

Field Summary

Fields
Modifier and Type	Field and Description
`protected int[]`	`maxY`
`protected int[]`	`px` px[x] holds the number of times the history x appeared in training data
`protected int[][]`	`pxy` pxy[x][y]=# times (x,y) occurred in training
`protected int[]`	`py` py[y] holds the number of times the outcome y appeared in training data
`double[][]`	`values` The value of classification y for x.
`protected int[][]`	`vArray` vArray has dimensions [numTrainingDatums][2] and holds the x and y (word and tag index) for each training sample.
`int`	`xSize`
`int`	`ySize`

Constructor Summary

Constructors
Constructor and Description
`Experiments()`
`Experiments(int[][] vArray)` If this constructor is used, the maximum possible class overall is found and all classes are assumed possible for all instances.
`Experiments(int[][] vArray, int ySize)`
`Experiments(int[][] vArray, int[] maxYs)` The number of possible classes for each instance is contained in the array maxYs then the possible classes for x are from 0 to maxYs[x]-1.
`Experiments(java.lang.String filename)` The filename has format: <data><xSize>xSize</xSize><ySize>ySize</ySize> x1 y1 x2 y2 ..

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Experiments m)`
`Index<IntPair>`	`createIndex()`
`int[]`	`get(int index)`
`int`	`getNumber()`
`int`	`numY(int x)`
`void`	`print()`
`void`	`print(PrintFile pf)`
`void`	`ptilde()`
`void`	`ptilde(int ySize)` When we want a pre-given number of classes.
`double`	`ptildeX(int x)`
`double`	`ptildeXY(int x, int y)`
`double`	`ptildeY(int y)`
`void`	`setMaxY(int[] maxY)`
`int`	`size()` Returns the number of training data items.

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

- Field Detail
  - vArray
```
protected int[][] vArray
```
    vArray has dimensions [numTrainingDatums][2] and holds the x and y (word and tag index) for each training sample. Its length is the number of data points.
  - px
```
protected int[] px
```
    px[x] holds the number of times the history x appeared in training data
  - py
```
protected int[] py
```
    py[y] holds the number of times the outcome y appeared in training data
  - maxY
```
protected int[] maxY
```
  - pxy
```
protected int[][] pxy
```
    pxy[x][y]=# times (x,y) occurred in training
  - xSize
```
public int xSize
```
  - ySize
```
public int ySize
```
  - values
```
public double[][] values
```
    The value of classification y for x. Used for ranking.
- Constructor Detail
  - Experiments
```
public Experiments()
```
  - Experiments
```
public Experiments(int[][] vArray)
```
    If this constructor is used, the maximum possible class overall is found and all classes are assumed possible for all instances.
  - Experiments
```
public Experiments(int[][] vArray,
                   int[] maxYs)
```
    The number of possible classes for each instance is contained in the array maxYs then the possible classes for x are from 0 to maxYs[x]-1.
  - Experiments
```
public Experiments(int[][] vArray,
                   int ySize)
```
  - Experiments
```
public Experiments(java.lang.String filename)
```
    The filename has format: <data><xSize>xSize</xSize><ySize>ySize</ySize> x1 y1 x2 y2 .. </data> ..
- Method Detail
  - createIndex
```
public Index<IntPair> createIndex()
```
  - add
```
public void add(Experiments m)
```
  - ptilde
```
public final void ptilde()
```
  - setMaxY
```
public void setMaxY(int[] maxY)
```
  - numY
```
public int numY(int x)
```
  - ptilde
```
public void ptilde(int ySize)
```
    When we want a pre-given number of classes.
  - ptildeX
```
public double ptildeX(int x)
```
  - ptildeY
```
public double ptildeY(int y)
```
  - ptildeXY
```
public double ptildeXY(int x,
                       int y)
```
  - get
```
public int[] get(int index)
```
  - size
```
public int size()
```
    Returns the number of training data items.
  - getNumber
```
public int getNumber()
```
  - print
```
public void print()
```
  - print
```
public void print(PrintFile pf)
```

Class Experiments

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

vArray

px

py

maxY

pxy

xSize

ySize

values

Constructor Detail

Experiments

Experiments

Experiments

Experiments

Experiments

Method Detail

createIndex

add

ptilde

setMaxY

numY

ptilde

ptildeX

ptildeY

ptildeXY

get

size

getNumber

print

print