org.deeplearning4j.text.sentenceiterator.labelaware

Class LabelAwareUimaSentenceIterator

java.lang.Object

org.deeplearning4j.text.sentenceiterator.BaseSentenceIterator

org.deeplearning4j.text.sentenceiterator.UimaSentenceIterator

org.deeplearning4j.text.sentenceiterator.labelaware.LabelAwareUimaSentenceIterator

All Implemented Interfaces:

LabelAwareSentenceIterator, SentenceIterator

public class LabelAwareUimaSentenceIterator
extends UimaSentenceIterator
implements LabelAwareSentenceIterator

Uima sentence iterator that is aware of the current file

Author:

Adam Gibson

Field Summary

Fields inherited from class org.deeplearning4j.text.sentenceiterator.UimaSentenceIterator

path, reader, sentences

Fields inherited from class org.deeplearning4j.text.sentenceiterator.BaseSentenceIterator

preProcessor

Constructor Summary

Constructors

Constructor and Description
LabelAwareUimaSentenceIterator(SentencePreProcessor preProcessor, String path, UimaResource resource)
LabelAwareUimaSentenceIterator(String path, org.apache.uima.analysis_engine.AnalysisEngine engine)

Method Summary

Modifier and Type	Method and Description
static LabelAwareSentenceIterator	createWithPath(String path) Creates a uima sentence iterator with the given path
String	currentLabel() Returns the current label for nextSentence()
List<String>	currentLabels() For multi label problems

Methods inherited from class org.deeplearning4j.text.sentenceiterator.UimaSentenceIterator

getResource, hasNext, nextSentence, reset, segmenter

Methods inherited from class org.deeplearning4j.text.sentenceiterator.BaseSentenceIterator

finish, getPreProcessor, setPreProcessor

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.deeplearning4j.text.sentenceiterator.SentenceIterator

finish, getPreProcessor, hasNext, nextSentence, reset, setPreProcessor

Constructor Detail

LabelAwareUimaSentenceIterator

public LabelAwareUimaSentenceIterator(SentencePreProcessor preProcessor,
                                      String path,
                                      UimaResource resource)

LabelAwareUimaSentenceIterator

public LabelAwareUimaSentenceIterator(String path,
                                      org.apache.uima.analysis_engine.AnalysisEngine engine)
                               throws org.apache.uima.resource.ResourceInitializationException

Throws:

org.apache.uima.resource.ResourceInitializationException

Method Detail

currentLabel

public String currentLabel()

Returns the current label for nextSentence()

Specified by:

currentLabel in interface LabelAwareSentenceIterator

Returns:

the label for nextSentence()

createWithPath

public static LabelAwareSentenceIterator createWithPath(String path)
                                                 throws Exception

Creates a uima sentence iterator with the given path

Parameters:

path - the path to the root directory or file to read from

Returns:

the uima sentence iterator for the given root dir or file

Throws:

Exception

currentLabels

public List<String> currentLabels()

Description copied from interface: LabelAwareSentenceIterator

For multi label problems

Specified by:

currentLabels in interface LabelAwareSentenceIterator

Returns: