org.deeplearning4j.datasets.iterator

Class AsyncShieldDataSetIterator

java.lang.Object

org.deeplearning4j.datasets.iterator.AsyncShieldDataSetIterator

All Implemented Interfaces:

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

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

This wrapper takes your existing DataSetIterator implementation and prevents asynchronous prefetch

Author:

[email protected]

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AsyncShieldDataSetIterator(org.nd4j.linalg.dataset.api.iterator.DataSetIterator iterator)

Method Summary

Modifier and Type	Method and Description
boolean	asyncSupported() Does this DataSetIterator support asynchronous prefetching of multiple DataSet objects? PLEASE NOTE: This iterator ALWAYS returns FALSE
int	batch() Batch size
int	cursor() The current cursor if applicable
List<String>	getLabels() Get dataset iterator record reader labels
org.nd4j.linalg.dataset.api.DataSetPreProcessor	getPreProcessor() Returns preprocessors, if defined
boolean	hasNext() Returns true if the iteration has more elements.
int	inputColumns() Input columns for the dataset
org.nd4j.linalg.dataset.DataSet	next() Returns the next element in the iteration.
org.nd4j.linalg.dataset.DataSet	next(int num) Like the standard next method but allows a customizable number of examples returned
int	numExamples() Total number of examples in the dataset
void	remove() Removes from the underlying collection the last element returned by this iterator (optional operation).
void	reset() Resets the iterator back to the beginning
boolean	resetSupported() Is resetting supported by this DataSetIterator? Many DataSetIterators do support resetting, but some don't
void	setPreProcessor(org.nd4j.linalg.dataset.api.DataSetPreProcessor preProcessor) Set a pre processor
int	totalExamples() Total examples in the iterator
int	totalOutcomes() The number of labels for the dataset

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

AsyncShieldDataSetIterator

public AsyncShieldDataSetIterator(@NonNull
                                  org.nd4j.linalg.dataset.api.iterator.DataSetIterator iterator)

Method Detail

next

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

Like the standard next method but allows a customizable number of examples returned

Specified by:

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

Parameters:

num - the number of examples

Returns:

the next data applyTransformToDestination

totalExamples

public int totalExamples()

Total examples in the iterator

Specified by:

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

Returns:

inputColumns

public int inputColumns()

Input columns for the dataset

Specified by:

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

Returns:

totalOutcomes

public int totalOutcomes()

The number of labels for the dataset

Specified by:

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

Returns:

resetSupported

public boolean resetSupported()

Is resetting supported by this DataSetIterator? Many DataSetIterators do support resetting, but some don't

Specified by:

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

Returns:

true if reset method is supported; false otherwise

asyncSupported

public boolean asyncSupported()

Does this DataSetIterator support asynchronous prefetching of multiple DataSet objects? PLEASE NOTE: This iterator ALWAYS returns FALSE

Specified by:

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

Returns:

true if asynchronous prefetching from this iterator is OK; false if asynchronous prefetching should not be used with this iterator

reset

public void reset()

Resets the iterator back to the beginning

Specified by:

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

batch

public int batch()

Batch size

Specified by:

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

Returns:

cursor

public int cursor()

The current cursor if applicable

Specified by:

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

Returns:

numExamples

public int numExamples()

Total number of examples in the dataset

Specified by:

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

Returns:

setPreProcessor

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

Set a pre processor

Specified by:

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

Parameters:

preProcessor - a pre processor to set

getPreProcessor

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

Returns preprocessors, if defined

Specified by:

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

Returns:

getLabels

public List<String> getLabels()

Get dataset iterator record reader labels

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