weka.dl4j.iterators

Class AbstractDataSetIterator

java.lang.Object

weka.dl4j.iterators.AbstractDataSetIterator

All Implemented Interfaces:

java.io.Serializable, OptionHandler

Direct Known Subclasses:

ConvolutionalInstancesIterator, DefaultInstancesIterator, ImageDataSetIterator

public abstract class AbstractDataSetIterator
extends java.lang.Object
implements OptionHandler, java.io.Serializable

An abstract iterator wrapper.

Version:

$Revision: 11711 $

Author:

Christopher Beckham, Eibe Frank

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractDataSetIterator()

Method Summary

Modifier and Type	Method and Description
org.nd4j.linalg.dataset.api.iterator.DataSetIterator	getIterator(Instances data, int seed) Returns the actual iterator.
abstract org.nd4j.linalg.dataset.api.iterator.DataSetIterator	getIterator(Instances data, int seed, int batchSize) Returns the actual iterator.
abstract int	getNumAttributes(Instances data) Get the number of predictor attributes for this iterator.
java.lang.String[]	getOptions() Gets the current settings of the Classifier.
int	getTrainBatchSize() Getting the training batch size
java.util.Enumeration<Option>	listOptions() Returns an enumeration describing the available options.
void	setOptions(java.lang.String[] options) Parses a given list of options.
void	setTrainBatchSize(int trainBatchSize) Setting the training batch size

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractDataSetIterator

public AbstractDataSetIterator()

Method Detail

getNumAttributes

public abstract int getNumAttributes(Instances data)
                              throws java.lang.Exception

Get the number of predictor attributes for this iterator.

Parameters:

data - the dataset to compute the number of attributes from

Returns:

the number of attributes

Throws:

java.lang.Exception - if the number of attributes cannot be computed successfully

getIterator

public org.nd4j.linalg.dataset.api.iterator.DataSetIterator getIterator(Instances data,
                                                                        int seed)
                                                                 throws java.lang.Exception

Returns the actual iterator.

Parameters:

data - the dataset to use

seed - the seed for the random number generator

Returns:

the iterator

Throws:

java.lang.Exception - if the constructor cannot be constructed successfully

getIterator

public abstract org.nd4j.linalg.dataset.api.iterator.DataSetIterator getIterator(Instances data,
                                                                                 int seed,
                                                                                 int batchSize)
                                                                          throws java.lang.Exception

Returns the actual iterator.

Parameters:

data - the dataset to use

seed - the seed for the random number generator

batchSize - the batch size to use

Returns:

the iterator

Throws:

java.lang.Exception - if the constructor cannot be constructed successfully

setTrainBatchSize

public void setTrainBatchSize(int trainBatchSize)

Setting the training batch size

Parameters:

trainBatchSize - the batch size

getTrainBatchSize

public int getTrainBatchSize()

Getting the training batch size

Returns:

the batch size

listOptions

public java.util.Enumeration<Option> listOptions()

Returns an enumeration describing the available options.

Specified by:

listOptions in interface OptionHandler

Returns:

an enumeration of all the available options.

getOptions

public java.lang.String[] getOptions()

Gets the current settings of the Classifier.

Specified by:

getOptions in interface OptionHandler

Returns:

an array of strings suitable for passing to setOptions

setOptions

public void setOptions(java.lang.String[] options)
                throws java.lang.Exception

Parses a given list of options.

Specified by:

setOptions in interface OptionHandler

Parameters:

options - the list of options as an array of strings

Throws:

java.lang.Exception - if an option is not supported