MultipleEpochsIterator (deeplearning4j-nn 0.9.1 API)

java.lang.Object
- org.deeplearning4j.datasets.iterator.MultipleEpochsIterator

All Implemented Interfaces:

Serializable, Iterator<org.nd4j.linalg.dataset.DataSet>, org.nd4j.linalg.dataset.api.iterator.DataSetIterator
```
public class MultipleEpochsIterator
extends Object
implements org.nd4j.linalg.dataset.api.iterator.DataSetIterator
```
A dataset iterator for doing multiple passes over a dataset

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`batch`
`protected List<org.nd4j.linalg.dataset.DataSet>`	`batchedDS`
`protected org.nd4j.linalg.dataset.DataSet`	`ds`
`protected int`	`epochs`
`protected org.nd4j.linalg.dataset.api.iterator.DataSetIterator`	`iter`
`protected AtomicLong`	`iterationsCounter`
`protected int`	`lastBatch`
`protected static org.slf4j.Logger`	`log`
`protected boolean`	`newEpoch`
`protected int`	`numEpochs`
`protected org.nd4j.linalg.dataset.api.DataSetPreProcessor`	`preProcessor`
`protected long`	`totalIterations`

Constructor Summary

Constructors
Constructor and Description
`MultipleEpochsIterator(org.nd4j.linalg.dataset.api.iterator.DataSetIterator iter, int queueSize, long totalIterations)` Deprecated.
`MultipleEpochsIterator(org.nd4j.linalg.dataset.api.iterator.DataSetIterator iter, long totalIterations)`
`MultipleEpochsIterator(int numEpochs, org.nd4j.linalg.dataset.DataSet ds)`
`MultipleEpochsIterator(int numEpochs, org.nd4j.linalg.dataset.api.iterator.DataSetIterator iter)`
`MultipleEpochsIterator(int numEpochs, org.nd4j.linalg.dataset.api.iterator.DataSetIterator iter, int queueSize)` Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`asyncSupported()`
`int`	`batch()` Batch size
`int`	`cursor()` The current cursor if applicable
`List<String>`	`getLabels()`
`boolean`	`hasNext()` Returns `true` if the iteration has more elements.
`int`	`inputColumns()` Input columns for the dataset
`org.nd4j.linalg.dataset.DataSet`	`next()`
`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()`
`void`	`setPreProcessor(org.nd4j.linalg.dataset.api.DataSetPreProcessor preProcessor)`
`int`	`totalExamples()` Total examples in the iterator
`int`	`totalOutcomes()` The number of labels for the dataset
`void`	`trackEpochs()`

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
  - epochs
```
protected int epochs
```
  - numEpochs
```
protected int numEpochs
```
  - batch
```
protected int batch
```
  - lastBatch
```
protected int lastBatch
```
  - iter
```
protected org.nd4j.linalg.dataset.api.iterator.DataSetIterator iter
```
  - ds
```
protected org.nd4j.linalg.dataset.DataSet ds
```
  - batchedDS
```
protected List<org.nd4j.linalg.dataset.DataSet> batchedDS
```
  - log
```
protected static final org.slf4j.Logger log
```
  - preProcessor
```
protected org.nd4j.linalg.dataset.api.DataSetPreProcessor preProcessor
```
  - newEpoch
```
protected boolean newEpoch
```
  - iterationsCounter
```
protected AtomicLong iterationsCounter
```
  - totalIterations
```
protected long totalIterations
```
- Constructor Detail
  - MultipleEpochsIterator
```
public MultipleEpochsIterator(int numEpochs,
                              org.nd4j.linalg.dataset.api.iterator.DataSetIterator iter)
```
  - MultipleEpochsIterator
```
@Deprecated
public MultipleEpochsIterator(int numEpochs,
                                          org.nd4j.linalg.dataset.api.iterator.DataSetIterator iter,
                                          int queueSize)
```
    Deprecated.
  - MultipleEpochsIterator
```
@Deprecated
public MultipleEpochsIterator(org.nd4j.linalg.dataset.api.iterator.DataSetIterator iter,
                                          int queueSize,
                                          long totalIterations)
```
    Deprecated.
  - MultipleEpochsIterator
```
public MultipleEpochsIterator(org.nd4j.linalg.dataset.api.iterator.DataSetIterator iter,
                              long totalIterations)
```
  - MultipleEpochsIterator
```
public MultipleEpochsIterator(int numEpochs,
                              org.nd4j.linalg.dataset.DataSet ds)
```
- 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
  - trackEpochs
```
public void trackEpochs()
```
  - next
```
public org.nd4j.linalg.dataset.DataSet next()
```
    Specified by:
    
    next in interface Iterator<org.nd4j.linalg.dataset.DataSet>
  - 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()
```
    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()
```
    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)
```
    Specified by:
    
    setPreProcessor 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
  - 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

Class MultipleEpochsIterator

Field Summary

Constructor Summary

Method Summary

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

epochs

numEpochs

batch

lastBatch

iter

ds

batchedDS

log

preProcessor

newEpoch

iterationsCounter

totalIterations

Constructor Detail

MultipleEpochsIterator

MultipleEpochsIterator

MultipleEpochsIterator

MultipleEpochsIterator

MultipleEpochsIterator

Method Detail

next

trackEpochs

next

totalExamples

inputColumns

totalOutcomes

resetSupported

asyncSupported

reset

batch

cursor

numExamples

setPreProcessor

getLabels

hasNext

remove