org.deeplearning4j.text.documentiterator

Class FileLabelAwareIterator

java.lang.Object

org.deeplearning4j.text.documentiterator.FileLabelAwareIterator

All Implemented Interfaces:

java.util.Iterator<LabelledDocument>, LabelAwareIterator

public class FileLabelAwareIterator
extends java.lang.Object
implements LabelAwareIterator

This is simple filesystem-based LabelAware iterator. It assumes that you have one or more folders organized in the following way: 1st level subfolder: label name 2nd level: bunch of documents for that label You can have as many label folders as you want, as well.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileLabelAwareIterator.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.io.File>	files
protected LabelsSource	labelsSource
protected java.util.concurrent.atomic.AtomicInteger	position

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileLabelAwareIterator()
protected	FileLabelAwareIterator(java.util.List<java.io.File> files, LabelsSource source)

Method Summary

Modifier and Type	Method and Description
LabelsSource	getLabelsSource()
boolean	hasNext()
boolean	hasNextDocument()
LabelledDocument	next()
LabelledDocument	nextDocument()
void	remove()
void	reset()
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

files

protected java.util.List<java.io.File> files

position

protected java.util.concurrent.atomic.AtomicInteger position

labelsSource

protected LabelsSource labelsSource

Constructor Detail

FileLabelAwareIterator

protected FileLabelAwareIterator()

FileLabelAwareIterator

protected FileLabelAwareIterator(@NonNull
                                 java.util.List<java.io.File> files,
                                 @NonNull
                                 LabelsSource source)

Method Detail

hasNextDocument

public boolean hasNextDocument()

Specified by:

hasNextDocument in interface LabelAwareIterator

nextDocument

public LabelledDocument nextDocument()

Specified by:

nextDocument in interface LabelAwareIterator

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<LabelledDocument>

next

public LabelledDocument next()

Specified by:

next in interface java.util.Iterator<LabelledDocument>

remove

public void remove()

Specified by:

remove in interface java.util.Iterator<LabelledDocument>

shutdown

public void shutdown()

Specified by:

shutdown in interface LabelAwareIterator

reset

public void reset()

Specified by:

reset in interface LabelAwareIterator

getLabelsSource

public LabelsSource getLabelsSource()

Specified by:

getLabelsSource in interface LabelAwareIterator