org.deeplearning4j.datasets.iterator.impl

Class BenchmarkDataSetIterator

java.lang.Object

org.deeplearning4j.datasets.iterator.impl.BenchmarkDataSetIterator

All Implemented Interfaces:

Serializable, Iterator<org.nd4j.linalg.dataset.DataSet>, org.nd4j.linalg.dataset.api.iterator.DataSetIterator

public class BenchmarkDataSetIterator
extends Object
implements org.nd4j.linalg.dataset.api.iterator.DataSetIterator

Dataset iterator for simulated inputs, or input derived from a DataSet example. Primarily used for benchmarking.

Author:

Justin Long (crockpotveggies)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BenchmarkDataSetIterator(org.nd4j.linalg.dataset.DataSet example, int totalIterations)
BenchmarkDataSetIterator(int[] featuresShape, int numLabels, int totalIterations)

Method Summary

Modifier and Type	Method and Description
boolean	asyncSupported()
int	batch()
int	cursor()
List<String>	getLabels()
org.nd4j.linalg.dataset.api.DataSetPreProcessor	getPreProcessor()
boolean	hasNext() Returns true if the iteration has more elements.
int	inputColumns()
org.nd4j.linalg.dataset.DataSet	next() Returns the next element in the iteration.
org.nd4j.linalg.dataset.DataSet	next(int i)
int	numExamples()
void	remove() Removes from the underlying collection the last element returned by this iterator (optional operation).
void	reset()
boolean	resetSupported()
void	setPreProcessor(org.nd4j.linalg.dataset.api.DataSetPreProcessor dataSetPreProcessor)
int	totalExamples()
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)

BenchmarkDataSetIterator

public BenchmarkDataSetIterator(org.nd4j.linalg.dataset.DataSet example,
                                int totalIterations)

Method Detail

next

public org.nd4j.linalg.dataset.DataSet next(int i)

Specified by:

next in interface org.nd4j.linalg.dataset.api.iterator.DataSetIterator

totalExamples

public int totalExamples()

Specified by:

totalExamples in interface org.nd4j.linalg.dataset.api.iterator.DataSetIterator

inputColumns

public int inputColumns()

Specified by:

inputColumns in interface org.nd4j.linalg.dataset.api.iterator.DataSetIterator

totalOutcomes

public int totalOutcomes()

Specified by:

totalOutcomes in interface org.nd4j.linalg.dataset.api.iterator.DataSetIterator

resetSupported

public boolean resetSupported()

Specified by:

resetSupported in interface org.nd4j.linalg.dataset.api.iterator.DataSetIterator

asyncSupported

public boolean asyncSupported()

Specified by:

asyncSupported in interface org.nd4j.linalg.dataset.api.iterator.DataSetIterator

reset

public void reset()

Specified by:

reset in interface org.nd4j.linalg.dataset.api.iterator.DataSetIterator

batch

public int batch()

Specified by:

batch in interface org.nd4j.linalg.dataset.api.iterator.DataSetIterator

cursor

public int cursor()

Specified by:

cursor in interface org.nd4j.linalg.dataset.api.iterator.DataSetIterator

numExamples

public int numExamples()

Specified by:

numExamples in interface org.nd4j.linalg.dataset.api.iterator.DataSetIterator

setPreProcessor

public void setPreProcessor(org.nd4j.linalg.dataset.api.DataSetPreProcessor dataSetPreProcessor)

Specified by:

setPreProcessor in interface org.nd4j.linalg.dataset.api.iterator.DataSetIterator

getPreProcessor

public org.nd4j.linalg.dataset.api.DataSetPreProcessor getPreProcessor()

Specified by:

getPreProcessor in interface org.nd4j.linalg.dataset.api.iterator.DataSetIterator

getLabels

public List<String> getLabels()

Specified by:

getLabels in interface org.nd4j.linalg.dataset.api.iterator.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<org.nd4j.linalg.dataset.DataSet>

Returns:

true if the iteration has more elements

next

public org.nd4j.linalg.dataset.DataSet next()

Returns the next element in the iteration.

Specified by:

next in interface Iterator<org.nd4j.linalg.dataset.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<org.nd4j.linalg.dataset.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