org.deeplearning4j.datasets.iterator.impl

Class BenchmarkDataSetIterator

java.lang.Object

org.deeplearning4j.datasets.iterator.impl.BenchmarkDataSetIterator

All Implemented Interfaces:

Serializable, Iterator<DataSet>, DataSetIterator

public class BenchmarkDataSetIterator
extends Object
implements DataSetIterator

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BenchmarkDataSetIterator(DataSet example, int totalIterations)
BenchmarkDataSetIterator(int[] featuresShape, int numLabels, int totalIterations)
BenchmarkDataSetIterator(int[] featuresShape, int numLabels, int totalIterations, int gridWidth, int gridHeight) Creates 2d (shape [minibatch, numLabels]) or 4d labels ([minibatch, numLabels, gridWidth, gridHeight]), depending on value of gridWidth and gridHeight.

Method Summary

Modifier and Type	Method and Description
boolean	asyncSupported()
int	batch()
List<String>	getLabels()
DataSetPreProcessor	getPreProcessor()
boolean	hasNext() Returns true if the iteration has more elements.
int	inputColumns()
DataSet	next() Returns the next element in the iteration.
DataSet	next(int i)
void	remove() Removes from the underlying collection the last element returned by this iterator (optional operation).
void	reset()
boolean	resetSupported()
void	setPreProcessor(DataSetPreProcessor dataSetPreProcessor)
int	totalOutcomes()

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

Constructor Detail

BenchmarkDataSetIterator

public BenchmarkDataSetIterator(int[] featuresShape,
                                int numLabels,
                                int totalIterations)

Parameters:

featuresShape - Shape of the features data to randomly generate

numLabels - Number of label classes (for classification)

totalIterations - Total number of iterations per epoch

BenchmarkDataSetIterator

public BenchmarkDataSetIterator(int[] featuresShape,
                                int numLabels,
                                int totalIterations,
                                int gridWidth,
                                int gridHeight)

Creates 2d (shape [minibatch, numLabels]) or 4d labels ([minibatch, numLabels, gridWidth, gridHeight]), depending on value of gridWidth and gridHeight.

Parameters:

featuresShape - Shape of the features data to randomly generate

numLabels - Number of label classes (for classification)

totalIterations - Total number of iterations

gridWidth - If > 0, use to create 4d labels

gridHeight - If > 0, use to create 4d labels

BenchmarkDataSetIterator

public BenchmarkDataSetIterator(DataSet example,
                                int totalIterations)

Parameters:

example - DataSet to return on each call of next()

totalIterations - Total number of iterations

Method Detail

next

public DataSet next(int i)

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 dataSetPreProcessor)

Specified by:

setPreProcessor in interface DataSetIterator

getPreProcessor

public DataSetPreProcessor getPreProcessor()

Specified by:

getPreProcessor in interface DataSetIterator

getLabels

public List<String> getLabels()

Specified by:

getLabels in interface DataSetIterator

hasNext

public boolean hasNext()

Returns true if the iteration has more elements. (In other words, returns true if next(int) would return an element rather than throwing an exception.)

Specified by:

hasNext in interface Iterator<DataSet>

Returns:

true if the iteration has more elements

next

public DataSet next()

Returns the next element in the iteration.

Specified by:

next in interface Iterator<DataSet>

Returns:

the next element in the iteration

remove

public void remove()

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next(int). The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method.

Specified by:

remove in interface Iterator<DataSet>

Throws:

UnsupportedOperationException - if the remove operation is not supported by this iterator

IllegalStateException - if the next method has not yet been called, or the remove method has already been called after the last call to the next method