org.deeplearning4j.text.documentiterator

Class BasicLabelAwareIterator

java.lang.Object

org.deeplearning4j.text.documentiterator.BasicLabelAwareIterator

All Implemented Interfaces:

Iterator<LabelledDocument>, LabelAwareIterator

public class BasicLabelAwareIterator
extends Object
implements LabelAwareIterator

This is simple class, for building Sentence-Label pairs for ParagraphVectors/Doc2Vec. Idea is simple - you provide SentenceIterator or DocumentIterator, and it builds nice structure for future model reuse

Author:

[email protected]

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BasicLabelAwareIterator.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected LabelAwareIterator	backendIterator
protected AtomicLong	documentPosition
protected LabelsSource	generator

Method Summary

Modifier and Type	Method and Description
LabelsSource	getLabelsSource() This method returns LabelsSource instance, containing all labels derived from this iterator
boolean	hasNext()
boolean	hasNextDocument() This method checks, if there's more LabelledDocuments
LabelledDocument	next()
LabelledDocument	nextDocument() This method returns next LabelledDocument
void	remove()
void	reset() This methods resets LabelAwareIterator
void	shutdown()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Detail

documentPosition

protected AtomicLong documentPosition

generator

protected LabelsSource generator

backendIterator

protected transient LabelAwareIterator backendIterator

Method Detail

hasNextDocument

public boolean hasNextDocument()

This method checks, if there's more LabelledDocuments

Specified by:

hasNextDocument in interface LabelAwareIterator

Returns:

nextDocument

public LabelledDocument nextDocument()

This method returns next LabelledDocument

Specified by:

nextDocument in interface LabelAwareIterator

Returns:

reset

public void reset()

This methods resets LabelAwareIterator

Specified by:

reset in interface LabelAwareIterator

getLabelsSource

public LabelsSource getLabelsSource()

This method returns LabelsSource instance, containing all labels derived from this iterator

Specified by:

getLabelsSource in interface LabelAwareIterator

Returns:

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<LabelledDocument>

next

public LabelledDocument next()

Specified by:

next in interface Iterator<LabelledDocument>

shutdown

public void shutdown()

Specified by:

shutdown in interface LabelAwareIterator

remove

public void remove()

Specified by:

remove in interface Iterator<LabelledDocument>