RecordReaderDataSetIterator.Builder (deeplearning4j 1.0.0-beta6 API)

java.lang.Object
- org.deeplearning4j.datasets.datavec.RecordReaderDataSetIterator.Builder

Enclosing class:

RecordReaderDataSetIterator
```
public static class RecordReaderDataSetIterator.Builder
extends Object
```
Builder class for RecordReaderDataSetIterator

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`batchSize`
`protected WritableConverter`	`converter`
`protected int`	`labelIndex`
`protected int`	`labelIndexTo`
`protected int`	`maxNumBatches`
`protected int`	`numPossibleLabels`
`protected DataSetPreProcessor`	`preProcessor`
`protected RecordReader`	`recordReader`
`protected boolean`	`regression`

Constructor Summary

Constructors
Constructor and Description

Builder(RecordReader rr, int batchSize)

Constructors
Constructor and Description
`Builder(RecordReader rr, int batchSize)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RecordReaderDataSetIterator`	`build()`
`RecordReaderDataSetIterator.Builder`	`classification(int labelIndex, int numClasses)` Use this for classification
`RecordReaderDataSetIterator.Builder`	`collectMetaData(boolean collectMetaData)` When set to true: metadata for the current examples will be present in the returned DataSet.
`RecordReaderDataSetIterator.Builder`	`maxNumBatches(int maxNumBatches)` Optional argument, usually not used.
`RecordReaderDataSetIterator.Builder`	`preProcessor(DataSetPreProcessor preProcessor)` Optional arg.
`RecordReaderDataSetIterator.Builder`	`regression(int labelIndex)` Use this for single output regression (i.e., 1 output/regression target)
`RecordReaderDataSetIterator.Builder`	`regression(int labelIndexFrom, int labelIndexTo)` Use this for multiple output regression (1 or more output/regression targets).
`RecordReaderDataSetIterator.Builder`	`writableConverter(WritableConverter converter)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - recordReader
```
protected RecordReader recordReader
```
  - converter
```
protected WritableConverter converter
```
  - batchSize
```
protected int batchSize
```
  - maxNumBatches
```
protected int maxNumBatches
```
  - labelIndex
```
protected int labelIndex
```
  - labelIndexTo
```
protected int labelIndexTo
```
  - numPossibleLabels
```
protected int numPossibleLabels
```
  - regression
```
protected boolean regression
```
  - preProcessor
```
protected DataSetPreProcessor preProcessor
```
- Constructor Detail
  - Builder
```
public Builder(@NonNull
               RecordReader rr,
               int batchSize)
```
    Parameters:
    
    rr - Underlying record reader to source data from
    
    batchSize - Batch size to use
- Method Detail
  - writableConverter
```
public RecordReaderDataSetIterator.Builder writableConverter(WritableConverter converter)
```
  - maxNumBatches
```
public RecordReaderDataSetIterator.Builder maxNumBatches(int maxNumBatches)
```
    Optional argument, usually not used. If set, can be used to limit the maximum number of minibatches that will be returned (between resets). If not set, will always return as many minibatches as there is data available.
    
    Parameters:
    
    maxNumBatches - Maximum number of minibatches per epoch / reset
  - regression
```
public RecordReaderDataSetIterator.Builder regression(int labelIndex)
```
    Use this for single output regression (i.e., 1 output/regression target)
    
    Parameters:
    
    labelIndex - Column index that contains the regression target (indexes start at 0)
  - regression
```
public RecordReaderDataSetIterator.Builder regression(int labelIndexFrom,
                                                      int labelIndexTo)
```
    Use this for multiple output regression (1 or more output/regression targets). Note that all regression targets must be contiguous (i.e., positions x to y, without gaps)
    
    Parameters:
    
    labelIndexFrom - Column index of the first regression target (indexes start at 0)
    
    labelIndexTo - Column index of the last regression target (inclusive)
  - classification
```
public RecordReaderDataSetIterator.Builder classification(int labelIndex,
                                                          int numClasses)
```
    Use this for classification
    
    Parameters:
    
    labelIndex - Index that contains the label index. Column (indexes start from 0) be an integer value, and contain values 0 to numClasses-1
    
    numClasses - Number of label classes (i.e., number of categories/classes in the dataset)
  - preProcessor
```
public RecordReaderDataSetIterator.Builder preProcessor(DataSetPreProcessor preProcessor)
```
    Optional arg. Allows the preprocessor to be set
    
    Parameters:
    
    preProcessor - Preprocessor to use
  - collectMetaData
```
public RecordReaderDataSetIterator.Builder collectMetaData(boolean collectMetaData)
```
    When set to true: metadata for the current examples will be present in the returned DataSet. Disabled by default.
    
    Parameters:
    
    collectMetaData - Whether metadata should be collected or not
  - build
```
public RecordReaderDataSetIterator build()
```

Class RecordReaderDataSetIterator.Builder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

recordReader

converter

batchSize

maxNumBatches

labelIndex

labelIndexTo

numPossibleLabels

regression

preProcessor

Constructor Detail

Builder

Method Detail

writableConverter

maxNumBatches

regression

regression

classification

preProcessor

collectMetaData

build