CifarDataSetIterator

java.lang.Object
- org.deeplearning4j.datasets.datavec.RecordReaderDataSetIterator
- - org.deeplearning4j.datasets.iterator.impl.CifarDataSetIterator

All Implemented Interfaces:

java.io.Serializable, java.util.Iterator<DataSet>, DataSetIterator
```
public class CifarDataSetIterator
extends RecordReaderDataSetIterator
```
CifarDataSetIterator is an iterator for Cifar10 dataset explicitly There is a special preProcessor used to normalize the dataset based on Sergey Zagoruyko example https://github.com/szagoruyko/cifar.torch

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.deeplearning4j.datasets.datavec.RecordReaderDataSetIterator
  RecordReaderDataSetIterator.Builder

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`CHANNELS`
`protected int`	`exampleCount`
`protected static int`	`HEIGHT`
`protected ImageTransform`	`imageTransform`
`protected CifarLoader`	`loader`
`protected int`	`numExamples`
`protected boolean`	`overshot`
`protected boolean`	`train`
`protected boolean`	`useSpecialPreProcessCifar`
`protected static int`	`WIDTH`

Fields inherited from class org.deeplearning4j.datasets.datavec.RecordReaderDataSetIterator
batchNum, batchSize, converter, labelIndex, labelIndexTo, last, maxNumBatches, numPossibleLabels, preProcessor, recordReader, regression, sequenceIter, useCurrent

Constructor Summary

Constructors
Constructor and Description
`CifarDataSetIterator(int batchSize, int numExamples)` Loads images with given batchSize & numExamples returned by the generator.
`CifarDataSetIterator(int batchSize, int[] imgDim)` Loads images with given batchSize & imgDim returned by the generator.
`CifarDataSetIterator(int batchSize, int numExamples, boolean train)` Loads images with given batchSize, numExamples, & version returned by the generator.
`CifarDataSetIterator(int batchSize, int numExamples, int[] imgDim)` Loads images with given batchSize, numExamples, & imgDim returned by the generator.
`CifarDataSetIterator(int batchSize, int numExamples, int[] imgDim, boolean train)` Loads images with given batchSize, numExamples, imgDim & version returned by the generator.
`CifarDataSetIterator(int batchSize, int numExamples, int[] imgDim, boolean useSpecialPreProcessCifar, boolean train)` Loads images with given batchSize, numExamples, imgDim & version returned by the generator.
`CifarDataSetIterator(int batchSize, int numExamples, int[] imgDim, int numPossibleLables, ImageTransform imageTransform, boolean useSpecialPreProcessCifar, boolean train)` Create Cifar data specific iterator
`CifarDataSetIterator(int batchSize, int numExamples, int[] imgDim, int numPossibleLables, ImageTransform imageTransform, boolean useSpecialPreProcessCifar, boolean train, long rngSeed, boolean randomize)` Create Cifar data specific iterator

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`asyncSupported()` Does this DataSetIterator support asynchronous prefetching of multiple DataSet objects? Most DataSetIterators do, but in some cases it may not make sense to wrap this iterator in an iterator that does asynchronous prefetching.
`java.util.List<java.lang.String>`	`getLabels()` Get dataset iterator class labels, if any.
`boolean`	`hasNext()`
`DataSet`	`next(int batchSize)` Like the standard next method but allows a customizable number of examples returned
`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

Methods inherited from class org.deeplearning4j.datasets.datavec.RecordReaderDataSetIterator
batch, inputColumns, loadFromMetaData, loadFromMetaData, next, remove, setCollectMetaData, setPreProcessor, 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

- Field Detail
  - HEIGHT
```
protected static final int HEIGHT
```
    See Also:
    
    Constant Field Values
  - WIDTH
```
protected static final int WIDTH
```
    See Also:
    
    Constant Field Values
  - CHANNELS
```
protected static final int CHANNELS
```
    See Also:
    
    Constant Field Values
  - loader
```
protected final CifarLoader loader
```
  - numExamples
```
protected final int numExamples
```
  - useSpecialPreProcessCifar
```
protected final boolean useSpecialPreProcessCifar
```
  - train
```
protected final boolean train
```
  - imageTransform
```
protected final ImageTransform imageTransform
```
  - exampleCount
```
protected int exampleCount
```
  - overshot
```
protected boolean overshot
```
- Constructor Detail
  - CifarDataSetIterator
```
public CifarDataSetIterator(int batchSize,
                            int numExamples)
```
    Loads images with given batchSize & numExamples returned by the generator.
  - CifarDataSetIterator
```
public CifarDataSetIterator(int batchSize,
                            int numExamples,
                            boolean train)
```
    Loads images with given batchSize, numExamples, & version returned by the generator.
  - CifarDataSetIterator
```
public CifarDataSetIterator(int batchSize,
                            int[] imgDim)
```
    Loads images with given batchSize & imgDim returned by the generator.
  - CifarDataSetIterator
```
public CifarDataSetIterator(int batchSize,
                            int numExamples,
                            int[] imgDim)
```
    Loads images with given batchSize, numExamples, & imgDim returned by the generator.
  - CifarDataSetIterator
```
public CifarDataSetIterator(int batchSize,
                            int numExamples,
                            int[] imgDim,
                            boolean train)
```
    Loads images with given batchSize, numExamples, imgDim & version returned by the generator.
  - CifarDataSetIterator
```
public CifarDataSetIterator(int batchSize,
                            int numExamples,
                            int[] imgDim,
                            boolean useSpecialPreProcessCifar,
                            boolean train)
```
    Loads images with given batchSize, numExamples, imgDim & version returned by the generator.
  - CifarDataSetIterator
```
public CifarDataSetIterator(int batchSize,
                            int numExamples,
                            int[] imgDim,
                            int numPossibleLables,
                            ImageTransform imageTransform,
                            boolean useSpecialPreProcessCifar,
                            boolean train)
```
    Create Cifar data specific iterator
    
    Parameters:
    
    batchSize - the batch size of the examples
    
    imgDim - an array of height, width and channels
    
    numExamples - the overall number of examples
    
    imageTransform - the transformation to apply to the images
    
    useSpecialPreProcessCifar - use Zagoruyko's preprocess for Cifar
    
    train - true if use training set and false for test
  - CifarDataSetIterator
```
public CifarDataSetIterator(int batchSize,
                            int numExamples,
                            int[] imgDim,
                            int numPossibleLables,
                            ImageTransform imageTransform,
                            boolean useSpecialPreProcessCifar,
                            boolean train,
                            long rngSeed,
                            boolean randomize)
```
    Create Cifar data specific iterator
    
    Parameters:
    
    batchSize - the batch size of the examples
    
    imgDim - an array of height, width and channels
    
    numExamples - the overall number of examples
    
    imageTransform - the transformation to apply to the images
    
    useSpecialPreProcessCifar - use Zagoruyko's preprocess for Cifar
    
    train - true if use training set and false for test
    
    rngSeed - Seed for RNG repeatability
    
    randomize - If true: randomize the iteration order of the images
- Method Detail
  - next
```
public DataSet next(int batchSize)
```
    Description copied from interface: DataSetIterator
    
    Like the standard next method but allows a customizable number of examples returned
    
    Specified by:
    
    next in interface DataSetIterator
    
    Overrides:
    
    next in class RecordReaderDataSetIterator
    
    Parameters:
    
    batchSize - the number of examples
    
    Returns:
    
    the next data applyTransformToDestination
  - hasNext
```
public boolean hasNext()
```
    Specified by:
    
    hasNext in interface java.util.Iterator<DataSet>
    
    Overrides:
    
    hasNext in class RecordReaderDataSetIterator
  - reset
```
public void reset()
```
    Description copied from interface: DataSetIterator
    
    Resets the iterator back to the beginning
    
    Specified by:
    
    reset in interface DataSetIterator
    
    Overrides:
    
    reset in class RecordReaderDataSetIterator
  - resetSupported
```
public boolean resetSupported()
```
    Description copied from interface: DataSetIterator
    
    Is resetting supported by this DataSetIterator? Many DataSetIterators do support resetting, but some don't
    
    Specified by:
    
    resetSupported in interface DataSetIterator
    
    Overrides:
    
    resetSupported in class RecordReaderDataSetIterator
    
    Returns:
    
    true if reset method is supported; false otherwise
  - getLabels
```
public java.util.List<java.lang.String> getLabels()
```
    Description copied from interface: DataSetIterator
    
    Get dataset iterator class labels, if any. Note that implementations are not required to implement this, and can simply return null
    
    Specified by:
    
    getLabels in interface DataSetIterator
    
    Overrides:
    
    getLabels in class RecordReaderDataSetIterator
  - asyncSupported
```
public boolean asyncSupported()
```
    Description copied from interface: DataSetIterator
    
    Does this DataSetIterator support asynchronous prefetching of multiple DataSet objects? Most DataSetIterators do, but in some cases it may not make sense to wrap this iterator in an iterator that does asynchronous prefetching. For example, it would not make sense to use asynchronous prefetching for the following types of iterators: (a) Iterators that store their full contents in memory already (b) Iterators that re-use features/labels arrays (as future next() calls will overwrite past contents) (c) Iterators that already implement some level of asynchronous prefetching (d) Iterators that may return different data depending on when the next() method is called
    
    Specified by:
    
    asyncSupported in interface DataSetIterator
    
    Overrides:
    
    asyncSupported in class RecordReaderDataSetIterator
    
    Returns:
    
    true if asynchronous prefetching from this iterator is OK; false if asynchronous prefetching should not be used with this iterator

Class CifarDataSetIterator

Nested Class Summary

Nested classes/interfaces inherited from class org.deeplearning4j.datasets.datavec.RecordReaderDataSetIterator

Field Summary

Fields inherited from class org.deeplearning4j.datasets.datavec.RecordReaderDataSetIterator

Constructor Summary

Method Summary

Methods inherited from class org.deeplearning4j.datasets.datavec.RecordReaderDataSetIterator

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

Field Detail

HEIGHT

WIDTH

CHANNELS

loader

numExamples

useSpecialPreProcessCifar

train

imageTransform

exampleCount

overshot

Constructor Detail

CifarDataSetIterator

CifarDataSetIterator

CifarDataSetIterator

CifarDataSetIterator

CifarDataSetIterator

CifarDataSetIterator

CifarDataSetIterator

CifarDataSetIterator

Method Detail

next

hasNext

reset

resetSupported

getLabels

asyncSupported