# Uses of Class
opennlp.tools.doccat.DocumentSample

Packages that use DocumentSample
Package
Description
opennlp.tools.cmdline.doccat
opennlp.tools.doccat
Package for classifying a document into a category.
opennlp.tools.formats
Experimental package related to converting various corpora to OpenNLP Format.

- ## Uses of DocumentSample in opennlp.tools.cmdline.doccat

  Methods in opennlp.tools.cmdline.doccat with parameters of type DocumentSample
  Modifier and Type
  Method
  Description
  `void`
  DoccatFineGrainedReportListener.`correctlyClassified(DocumentSample reference, DocumentSample prediction)`
  `void`
  DoccatEvaluationErrorListener.`misclassified(DocumentSample reference, DocumentSample prediction)`
  `void`
  DoccatFineGrainedReportListener.`misclassified(DocumentSample reference, DocumentSample prediction)`

- ## Uses of DocumentSample in opennlp.tools.doccat

  Methods in opennlp.tools.doccat that return DocumentSample
  Modifier and Type
  Method
  Description
  `DocumentSample`
  DocumentCategorizerEvaluator.`processSample(DocumentSample sample)`
  Evaluates the given reference `sample`.
  `DocumentSample`
  DocumentSampleStream.`read()`
  Methods in opennlp.tools.doccat with parameters of type DocumentSample
  Modifier and Type
  Method
  Description
  `protected Iterator<Event>`
  DocumentCategorizerEventStream.`createEvents(DocumentSample sample)`
  `DocumentSample`
  DocumentCategorizerEvaluator.`processSample(DocumentSample sample)`
  Evaluates the given reference `sample`.
  Method parameters in opennlp.tools.doccat with type arguments of type DocumentSample
  Modifier and Type
  Method
  Description
  `void`
  DoccatCrossValidator.`evaluate(ObjectStream<DocumentSample> samples, int nFolds)`
  Starts the evaluation.
  `static DoccatModel`
  DocumentCategorizerME.`train(String lang, ObjectStream<DocumentSample> samples, TrainingParameters mlParams, DoccatFactory factory)`
  Starts a training of a `DoccatModel` with the given parameters.
  Constructor parameters in opennlp.tools.doccat with type arguments of type DocumentSample
  Modifier
  Constructor
  Description
  ``
  `DocumentCategorizerEventStream(ObjectStream<DocumentSample> samples)`
  Initializes a `DocumentCategorizerEventStream` via samples.
  ``
  `DocumentCategorizerEventStream(ObjectStream<DocumentSample> samples, FeatureGenerator... featureGenerators)`
  Initializes a `DocumentCategorizerEventStream` via samples and `feature generators`.

- ## Uses of DocumentSample in opennlp.tools.formats

  Methods in opennlp.tools.formats that return DocumentSample
  Modifier and Type
  Method
  Description
  `DocumentSample`
  TwentyNewsgroupSampleStream.`read()`
  Methods in opennlp.tools.formats that return types with arguments of type DocumentSample
  Modifier and Type
  Method
  Description
  `ObjectStream<DocumentSample>`
  DocumentSampleStreamFactory.`create(String[] args)`
  `ObjectStream<DocumentSample>`
  TwentyNewsgroupSampleStreamFactory.`create(String[] args)`