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

Subclasses with type arguments of type DocumentSample in opennlp.tools.cmdline.doccat

Modifier and Type	Class	Description
class	DoccatConverterTool	Tool to convert multiple data formats into native OpenNLP doccat training format.
final class	DoccatCrossValidatorTool
class	DoccatEvaluationErrorListener	A default implementation of EvaluationMonitor that prints to an output stream.
final class	DoccatEvaluatorTool	A default DocumentSample-centric implementation of AbstractEvaluatorTool that prints to an output stream.
class	DoccatTrainerTool

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

Subclasses with type arguments of type DocumentSample in opennlp.tools.doccat

Modifier and Type	Class	Description
class	DocumentCategorizerEvaluator	The DocumentCategorizerEvaluator measures the performance of the given DocumentCategorizer with the provided reference samples.
class	DocumentCategorizerEventStream	Iterator-like class for modeling document classification events.
class	DocumentSampleStream	Reads in string encoded training samples, parses them and outputs DocumentSample objects.

Subinterfaces with type arguments of type DocumentSample in opennlp.tools.doccat

Modifier and Type	Interface	Description
interface	DoccatEvaluationMonitor	A marker interface for evaluating 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

Subclasses with type arguments of type DocumentSample in opennlp.tools.formats

Modifier and Type	Class	Description
class	DocumentSampleStreamFactory	Factory producing OpenNLP DocumentSampleStreams.
class	TwentyNewsgroupSampleStreamFactory	Note: Do not use this class, internal use only!

Classes in opennlp.tools.formats that implement interfaces with type arguments of type DocumentSample

Modifier and Type	Class	Description
class	TwentyNewsgroupSampleStream	An ObjectStream implementation for the Twenty Newsgroups text corpus.

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)