org.deeplearning4j.datasets.iterator

Class ExistingDataSetIterator

java.lang.Object

org.deeplearning4j.datasets.iterator.ExistingDataSetIterator

All Implemented Interfaces:

Serializable, Iterator<DataSet>, DataSetIterator

public class ExistingDataSetIterator
extends Object
implements DataSetIterator

This wrapper provides DataSetIterator interface to existing java Iterable<DataSet> and Iterator<DataSet>. Note that when using Iterator<DataSet>, resetting of the DataSetIterator is not supported

Author:

raver119@gmail.com

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExistingDataSetIterator(Iterable<DataSet> iterable) Wraps the specified iterable.
ExistingDataSetIterator(Iterable<DataSet> iterable, int totalExamples, int numFeatures, int numLabels)
ExistingDataSetIterator(Iterable<DataSet> iterable, List<String> labels) Wraps the specified iterable.
ExistingDataSetIterator(Iterator<DataSet> iterator) Note that when using this constructor, resetting is not supported
ExistingDataSetIterator(Iterator<DataSet> iterator, List<String> labels) Note that when using this constructor, resetting is not supported

Method Summary

Modifier and Type	Method and Description
boolean	asyncSupported()
int	batch()
List<String>	getLabels()
boolean	hasNext()
int	inputColumns()
DataSet	next()
DataSet	next(int num)
void	remove()
void	reset()
boolean	resetSupported()
void	setPreProcessor(DataSetPreProcessor preProcessor)
int	totalOutcomes()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nd4j.linalg.dataset.api.iterator.DataSetIterator

getPreProcessor

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

ExistingDataSetIterator

public ExistingDataSetIterator(@NonNull
                               Iterator<DataSet> iterator)

Note that when using this constructor, resetting is not supported

Parameters:

iterator - Iterator to wrap

ExistingDataSetIterator

public ExistingDataSetIterator(@NonNull
                               Iterator<DataSet> iterator,
                               @NonNull
                               List<String> labels)

Note that when using this constructor, resetting is not supported

Parameters:

iterator - Iterator to wrap

labels - String labels. May be null.

ExistingDataSetIterator

public ExistingDataSetIterator(@NonNull
                               Iterable<DataSet> iterable)

Wraps the specified iterable. Supports resetting

Parameters:

iterable - Iterable to wrap

ExistingDataSetIterator

public ExistingDataSetIterator(@NonNull
                               Iterable<DataSet> iterable,
                               @NonNull
                               List<String> labels)

Wraps the specified iterable. Supports resetting

Parameters:

iterable - Iterable to wrap

labels - Labels list. May be null

ExistingDataSetIterator

public ExistingDataSetIterator(@NonNull
                               Iterable<DataSet> iterable,
                               int totalExamples,
                               int numFeatures,
                               int numLabels)

Method Detail

next

public DataSet next(int num)

Specified by:

next in interface DataSetIterator

inputColumns

public int inputColumns()

Specified by:

inputColumns in interface DataSetIterator

totalOutcomes

public int totalOutcomes()

Specified by:

totalOutcomes in interface DataSetIterator

resetSupported

public boolean resetSupported()

Specified by:

resetSupported in interface DataSetIterator

asyncSupported

public boolean asyncSupported()

Specified by:

asyncSupported in interface DataSetIterator

reset

public void reset()

Specified by:

reset in interface DataSetIterator

batch

public int batch()

Specified by:

batch in interface DataSetIterator

setPreProcessor

public void setPreProcessor(DataSetPreProcessor preProcessor)

Specified by:

setPreProcessor in interface DataSetIterator

getLabels

public List<String> getLabels()

Specified by:

getLabels in interface DataSetIterator

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<DataSet>

next

public DataSet next()

Specified by:

next in interface Iterator<DataSet>

remove

public void remove()

Specified by:

remove in interface Iterator<DataSet>