Class CrossValidationPartitioner<E>

java.lang.Object
opennlp.tools.util.eval.CrossValidationPartitioner<E>

public class CrossValidationPartitioner<E> extends Object
Provides access to training and test partitions for n-fold cross validation.

Cross validation is used to evaluate the performance of a classifier when only training data is available. The training set is split into n parts and the training / evaluation is performed n times on these parts. The training partition always consists of n - 1 parts and one part is used for testing.

To use the CrossValidationPartitioner a client iterates over the n stream. Each CrossValidationPartitioner.TrainingSampleStream represents one partition and is used first for training and afterwards for testing. The CrossValidationPartitioner.TestSampleStream can be obtained via the CrossValidationPartitioner.TrainingSampleStream.getTestSampleStream() method.

  • Field Details

    • sampleStream

      private final ObjectStream<E> sampleStream
      An stream over the whole set of data samples which are used for the cross validation.
    • numberOfPartitions

      private final int numberOfPartitions
      The number of parts the data is divided into.
    • testIndex

      private int testIndex
      The index of test part.
    • lastTrainingSampleStream

      private CrossValidationPartitioner.TrainingSampleStream<E> lastTrainingSampleStream
      The last handed out CrossValidationPartitioner.TrainingSampleStream. The reference is needed to poison the instance to fail fast if it is used despite the fact that it is forbidden!.
  • Constructor Details

    • CrossValidationPartitioner

      public CrossValidationPartitioner(ObjectStream<E> inElements, int numberOfPartitions)
      Initializes CrossValidationPartitioner instance.
      Parameters:
      inElements - The ObjectStream<E> that provides the elements.
      numberOfPartitions - The number of partitions. Must be greater than 0.
    • CrossValidationPartitioner

      public CrossValidationPartitioner(Collection<E> elements, int numberOfPartitions)
      Initializes CrossValidationPartitioner instance.
      Parameters:
      elements - A Collection<E> that provides the elements.
      numberOfPartitions - The number of partitions. Must be greater than 0.
  • Method Details