weka.dl4j.iterators.instance

Class AbstractInstanceIterator

java.lang.Object

weka.dl4j.iterators.instance.AbstractInstanceIterator

All Implemented Interfaces:

java.io.Serializable, weka.core.OptionHandler

Direct Known Subclasses:

AbstractSequenceInstanceIterator, DefaultInstanceIterator, ImageInstanceIterator

public abstract class AbstractInstanceIterator
extends java.lang.Object
implements weka.core.OptionHandler, java.io.Serializable

An abstract iterator that wraps DataSetIterators around Weka Instances.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractInstanceIterator()

Method Summary

Modifier and Type	Method and Description
org.nd4j.linalg.dataset.api.iterator.DataSetIterator	getDataSetIterator(weka.core.Instances data, int seed) Returns the actual iterator.
abstract org.nd4j.linalg.dataset.api.iterator.DataSetIterator	getDataSetIterator(weka.core.Instances data, int seed, int batchSize) Returns the actual iterator.
java.lang.String[]	getOptions() Gets the current settings of the Classifier.
int	getTrainBatchSize() Getting the training batch size
void	initialize() Initialize the iterator
java.util.Enumeration<weka.core.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
abstract void	validate(weka.core.Instances data) Validates the input dataset

Methods inherited from class java.lang.Object

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

Methods inherited from interface weka.core.OptionHandler

makeCopy

Constructor Detail

AbstractInstanceIterator

public AbstractInstanceIterator()

Method Detail

getDataSetIterator

public org.nd4j.linalg.dataset.api.iterator.DataSetIterator getDataSetIterator(weka.core.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

getDataSetIterator

public abstract org.nd4j.linalg.dataset.api.iterator.DataSetIterator getDataSetIterator(weka.core.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

getTrainBatchSize

@OptionMetadata(displayName="size of mini batch",
                description="The mini batch size to use in the iterator (default = 1).",
                commandLineParamName="bs",
                commandLineParamSynopsis="-bs <int>",
                displayOrder=1)
public int getTrainBatchSize()

Getting the training batch size

Returns:

the batch size

setTrainBatchSize

public void setTrainBatchSize(int trainBatchSize)

Setting the training batch size

Parameters:

trainBatchSize - the batch size

initialize

public void initialize()

Initialize the iterator

validate

public abstract void validate(weka.core.Instances data)
                       throws InvalidInputDataException

Validates the input dataset

Parameters:

data - the input dataset

Throws:

InvalidInputDataException - if validation is unsuccessful

listOptions

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

Returns an enumeration describing the available options.

Specified by:

listOptions in interface weka.core.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 weka.core.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 weka.core.OptionHandler

Parameters:

options - the list of options as an array of strings

Throws:

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