org.deeplearning4j.text.sentenceiterator.labelaware

Class LabelAwareListSentenceIterator

java.lang.Object

org.deeplearning4j.text.sentenceiterator.labelaware.LabelAwareListSentenceIterator

All Implemented Interfaces:

LabelAwareSentenceIterator, SentenceIterator

public class LabelAwareListSentenceIterator
extends java.lang.Object
implements LabelAwareSentenceIterator

Iterates over an input stream with the textual format: label delimiter text

Constructor Summary

Constructors

Constructor and Description
LabelAwareListSentenceIterator(java.io.InputStream is) Same as calling (is,\t,0,1)
LabelAwareListSentenceIterator(java.io.InputStream is, java.lang.String sep) Same as calling (is,\t,0,1)
LabelAwareListSentenceIterator(java.io.InputStream is, java.lang.String delimiter, int labelPosition, int textPosition) Initializes the sentence iterator with the given args, note that this will close the input stream for you

Method Summary

Modifier and Type	Method and Description
java.lang.String	currentLabel() Returns the current label for nextSentence()
java.util.List<java.lang.String>	currentLabels() For multi label problems
void	finish() Allows for any finishing (closing of input streams or the like)
SentencePreProcessor	getPreProcessor()
boolean	hasNext() Same idea as Iterator
java.lang.String	nextSentence() Gets the next sentence or null if there's nothing left (Do yourself a favor and check hasNext() )
void	reset() Resets the iterator to the beginning
void	setPreProcessor(SentencePreProcessor preProcessor)

Methods inherited from class java.lang.Object

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

Constructor Detail

LabelAwareListSentenceIterator

public LabelAwareListSentenceIterator(java.io.InputStream is,
                                      java.lang.String delimiter,
                                      int labelPosition,
                                      int textPosition)
                               throws java.io.IOException

Initializes the sentence iterator with the given args, note that this will close the input stream for you

Parameters:

is - the input stream (this will be closed)

delimiter - the delimiter (tab comma,...)

labelPosition - the position of the label on each line

textPosition - the position of the text on each line

Throws:

java.io.IOException

LabelAwareListSentenceIterator

public LabelAwareListSentenceIterator(java.io.InputStream is)
                               throws java.io.IOException

Same as calling (is,\t,0,1)

Parameters:

is - the input stream to read lines from

Throws:

java.io.IOException

LabelAwareListSentenceIterator

public LabelAwareListSentenceIterator(java.io.InputStream is,
                                      java.lang.String sep)
                               throws java.io.IOException

Same as calling (is,\t,0,1)

Parameters:

is - the input stream to read lines from

sep - the separator for the file

Throws:

java.io.IOException

Method Detail

currentLabel

public java.lang.String currentLabel()

Returns the current label for nextSentence()

Specified by:

currentLabel in interface LabelAwareSentenceIterator

Returns:

the label for nextSentence()

currentLabels

public java.util.List<java.lang.String> currentLabels()

Description copied from interface: LabelAwareSentenceIterator

For multi label problems

Specified by:

currentLabels in interface LabelAwareSentenceIterator

Returns:

nextSentence

public java.lang.String nextSentence()

Gets the next sentence or null if there's nothing left (Do yourself a favor and check hasNext() )

Specified by:

nextSentence in interface SentenceIterator

Returns:

the next sentence in the iterator

hasNext

public boolean hasNext()

Same idea as Iterator

Specified by:

hasNext in interface SentenceIterator

Returns:

whether there's anymore sentences left

reset

public void reset()

Resets the iterator to the beginning

Specified by:

reset in interface SentenceIterator

finish

public void finish()

Allows for any finishing (closing of input streams or the like)

Specified by:

finish in interface SentenceIterator

getPreProcessor

public SentencePreProcessor getPreProcessor()

Specified by:

getPreProcessor in interface SentenceIterator

setPreProcessor

public void setPreProcessor(SentencePreProcessor preProcessor)

Specified by:

setPreProcessor in interface SentenceIterator