Index (Apache OpenNLP :: Core :: ML :: Perceptron 3.0.0-M4 API)

# Index

B C D E G H I N O P S T V W
All Classes and Interfaces|All Packages|Constant Field Values

## B

BinaryPerceptronModelReader - Class in opennlp.tools.ml.perceptron
  A `PerceptronModelReader` that reads models from a binary format.
BinaryPerceptronModelReader(DataInputStream) - Constructor for class opennlp.tools.ml.perceptron.BinaryPerceptronModelReader
  Instantiates `BinaryPerceptronModelReader` via a `DataInputStream` containing the model contents.
BinaryPerceptronModelReader(File) - Constructor for class opennlp.tools.ml.perceptron.BinaryPerceptronModelReader
  Instantiates `BinaryPerceptronModelReader` via a `File` and creates a reader for it.
BinaryPerceptronModelWriter - Class in opennlp.tools.ml.perceptron
  A `PerceptronModelWriter` that writes models in a binary format.
BinaryPerceptronModelWriter(AbstractModel, DataOutputStream) - Constructor for class opennlp.tools.ml.perceptron.BinaryPerceptronModelWriter
  Instantiates `BinaryPerceptronModelWriter` via an `perceptron model` and a `DataOutputStream`.
BinaryPerceptronModelWriter(AbstractModel, File) - Constructor for class opennlp.tools.ml.perceptron.BinaryPerceptronModelWriter
  Instantiates `BinaryPerceptronModelWriter` via an `perceptron model` and a `File`.

## C

checkModelType() - Method in class opennlp.tools.ml.perceptron.PerceptronModelReader
  Reads the mode type from the underlying reader and informs if it not a `Perceptron` model.
close() - Method in class opennlp.tools.ml.perceptron.BinaryPerceptronModelWriter
constructModel() - Method in class opennlp.tools.ml.perceptron.PerceptronModelReader
  Constructs a `model`.

## D

doTrain(DataIndexer<TrainingParameters>) - Method in class opennlp.tools.ml.perceptron.PerceptronTrainer
doTrain(SequenceStream<Event>) - Method in class opennlp.tools.ml.perceptron.SimplePerceptronSequenceTrainer

## E

equals(Object) - Method in class opennlp.tools.ml.perceptron.PerceptronModel
eval(int[], double[], EvalParameters) - Static method in class opennlp.tools.ml.perceptron.PerceptronModel
  Evaluates a `PerceptronModel`.
eval(String[]) - Method in class opennlp.tools.ml.perceptron.PerceptronModel
eval(String[], double[]) - Method in class opennlp.tools.ml.perceptron.PerceptronModel
eval(String[], float[]) - Method in class opennlp.tools.ml.perceptron.PerceptronModel
eval(String[], float[], double[]) - Method in class opennlp.tools.ml.perceptron.PerceptronModel

## G

getMessageIfSatisfied() - Method in class opennlp.tools.monitoring.IterDeltaAccuracyUnderTolerance

## H

hashCode() - Method in class opennlp.tools.ml.perceptron.PerceptronModel

## I

isSortAndMerge() - Method in class opennlp.tools.ml.perceptron.PerceptronTrainer
IterDeltaAccuracyUnderTolerance - Class in opennlp.tools.monitoring
  A `StopCriteria` implementation to identify whether the absolute difference between the training accuracy of current and previous iteration is under the defined tolerance.
IterDeltaAccuracyUnderTolerance(Parameters) - Constructor for class opennlp.tools.monitoring.IterDeltaAccuracyUnderTolerance

## N

nextIteration(int) - Method in class opennlp.tools.ml.perceptron.SimplePerceptronSequenceTrainer

## O

opennlp.tools.ml.perceptron - package opennlp.tools.ml.perceptron
opennlp.tools.monitoring - package opennlp.tools.monitoring

## P

PERCEPTRON_SEQUENCE_VALUE - Static variable in class opennlp.tools.ml.perceptron.SimplePerceptronSequenceTrainer
PERCEPTRON_VALUE - Static variable in class opennlp.tools.ml.perceptron.PerceptronTrainer
PerceptronModel - Class in opennlp.tools.ml.perceptron
  A `model` implementation based one the perceptron algorithm.
PerceptronModel(Context[], String[], String[]) - Constructor for class opennlp.tools.ml.perceptron.PerceptronModel
  Initializes a `PerceptronModel`.
PerceptronModelReader - Class in opennlp.tools.ml.perceptron
  The base class for readers of `models`.
PerceptronModelReader(File) - Constructor for class opennlp.tools.ml.perceptron.PerceptronModelReader
  Initializes a `PerceptronModelReader` via a `File`.
PerceptronModelReader(DataReader) - Constructor for class opennlp.tools.ml.perceptron.PerceptronModelReader
  Initializes a `PerceptronModelReader` via a `DataReader`.
PerceptronModelWriter - Class in opennlp.tools.ml.perceptron
  The base class for `PerceptronModel` writers.
PerceptronModelWriter(AbstractModel) - Constructor for class opennlp.tools.ml.perceptron.PerceptronModelWriter
  Initializes a `PerceptronModelWriter` for a `perceptron model`.
PerceptronTrainer - Class in opennlp.tools.ml.perceptron
  Trains `models` using the perceptron algorithm.
PerceptronTrainer() - Constructor for class opennlp.tools.ml.perceptron.PerceptronTrainer
  Instantiates a `PerceptronTrainer` with default training parameters.
PerceptronTrainer(TrainingParameters) - Constructor for class opennlp.tools.ml.perceptron.PerceptronTrainer
  Instantiates a `PerceptronTrainer` with specific `TrainingParameters`.
persist() - Method in class opennlp.tools.ml.perceptron.PerceptronModelWriter
  Writes the `perceptron model`, using the `AbstractModelWriter.writeUTF(String)`, `AbstractModelWriter.writeDouble(double)`, or `AbstractModelWriter.writeInt(int)`} methods implemented by extending classes.

## S

setSkippedAveraging(boolean) - Method in class opennlp.tools.ml.perceptron.PerceptronTrainer
  Enables skipped averaging, this flag changes the standard averaging to special averaging instead.
setStepSizeDecrease(double) - Method in class opennlp.tools.ml.perceptron.PerceptronTrainer
  Enables and sets step size decrease.
setTolerance(double) - Method in class opennlp.tools.ml.perceptron.PerceptronTrainer
  Specifies the tolerance.
SimplePerceptronSequenceTrainer - Class in opennlp.tools.ml.perceptron
  Trains `models` with sequences using the perceptron algorithm.
SimplePerceptronSequenceTrainer() - Constructor for class opennlp.tools.ml.perceptron.SimplePerceptronSequenceTrainer
  Instantiates a `SimplePerceptronSequenceTrainer` with a default configuration of training parameters.
STOP - Static variable in class opennlp.tools.monitoring.IterDeltaAccuracyUnderTolerance

## T

test(Double) - Method in class opennlp.tools.monitoring.IterDeltaAccuracyUnderTolerance
TOLERANCE_DEFAULT - Static variable in class opennlp.tools.ml.perceptron.PerceptronTrainer
trainModel(int, DataIndexer<TrainingParameters>, int) - Method in class opennlp.tools.ml.perceptron.PerceptronTrainer
  Trains a `PerceptronModel` with given parameters.
trainModel(int, DataIndexer<TrainingParameters>, int, boolean) - Method in class opennlp.tools.ml.perceptron.PerceptronTrainer
  Trains a `PerceptronModel` with given parameters.
trainModel(int, SequenceStream<Event>, int, boolean) - Method in class opennlp.tools.ml.perceptron.SimplePerceptronSequenceTrainer
  Trains a `PerceptronModel` with given parameters.

## V

validate() - Method in class opennlp.tools.ml.perceptron.PerceptronTrainer
validate() - Method in class opennlp.tools.ml.perceptron.SimplePerceptronSequenceTrainer

## W

writeDouble(double) - Method in class opennlp.tools.ml.perceptron.BinaryPerceptronModelWriter
writeInt(int) - Method in class opennlp.tools.ml.perceptron.BinaryPerceptronModelWriter
writeUTF(String) - Method in class opennlp.tools.ml.perceptron.BinaryPerceptronModelWriter

B C D E G H I N O P S T V W
All Classes and Interfaces|All Packages|Constant Field Values