org.deeplearning4j.iterator

Interface LabeledSentenceProvider

All Known Implementing Classes:

CollectionLabeledSentenceProvider, FileLabeledSentenceProvider, LabelAwareConverter

public interface LabeledSentenceProvider

LabeledSentenceProvider: a simple iterator interface over sentences/documents that have a label.
This is intended for use with CnnSentenceDataSetIterator

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	allLabels() Return the list of labels - this also defines the class/integer label assignment order
boolean	hasNext() Are there more sentences/documents available?
Pair<java.lang.String,java.lang.String>	nextSentence()
int	numLabelClasses() Equivalent to allLabels().size()
void	reset() Reset the iterator - including shuffling the order, if necessary/appropriate
int	totalNumSentences() Return the total number of sentences, or -1 if not available

Method Detail

hasNext

boolean hasNext()

Are there more sentences/documents available?

nextSentence

Pair<java.lang.String,java.lang.String> nextSentence()

Returns:

Pair: sentence/document text and label

reset

void reset()

Reset the iterator - including shuffling the order, if necessary/appropriate

totalNumSentences

int totalNumSentences()

Return the total number of sentences, or -1 if not available

allLabels

java.util.List<java.lang.String> allLabels()

Return the list of labels - this also defines the class/integer label assignment order

numLabelClasses

int numLabelClasses()

Equivalent to allLabels().size()