weka.dl4j.iterators.instance.sequence

Class RelationalInstanceIterator

java.lang.Object

weka.dl4j.iterators.instance.AbstractInstanceIterator

weka.dl4j.iterators.instance.sequence.AbstractSequenceInstanceIterator

weka.dl4j.iterators.instance.sequence.RelationalInstanceIterator

All Implemented Interfaces:

java.io.Serializable, weka.core.OptionHandler

public class RelationalInstanceIterator
extends AbstractSequenceInstanceIterator

Converts the given Instances containing a single relational attribute into a DataSet.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RelationalInstanceIterator()

Method Summary

Modifier and Type	Method and Description
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	getRelationalAttributeIndex()
int	getTruncateLength()
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	setRelationalAttributeIndex(int relationalAttributeIndex)
void	setTruncateLength(int truncateLength)
void	validate(weka.core.Instances data) Validates the input dataset

Methods inherited from class weka.dl4j.iterators.instance.AbstractInstanceIterator

getDataSetIterator, getTrainBatchSize, initialize, setTrainBatchSize

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

RelationalInstanceIterator

public RelationalInstanceIterator()

Method Detail

getDataSetIterator

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

Description copied from class: AbstractInstanceIterator

Returns the actual iterator.

Specified by:

getDataSetIterator in class AbstractInstanceIterator

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

validate

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

Description copied from class: AbstractInstanceIterator

Validates the input dataset

Specified by:

validate in class AbstractInstanceIterator

Parameters:

data - the input dataset

Throws:

InvalidInputDataException - if validation is unsuccessful

getTruncateLength

@OptionMetadata(displayName="truncation length",
                description="The maximum number of instances per row (default = 100).",
                commandLineParamName="truncationLength",
                commandLineParamSynopsis="-truncationLength <int>",
                displayOrder=2)
public int getTruncateLength()

setTruncateLength

public void setTruncateLength(int truncateLength)

getRelationalAttributeIndex

@OptionMetadata(displayName="relational attribute index",
                description="Set the relational attribute\'s index (default = 0)",
                commandLineParamName="relationalAttributeIndex",
                commandLineParamSynopsis="-relationalAttributeIndex <int>",
                displayOrder=2)
public int getRelationalAttributeIndex()

setRelationalAttributeIndex

public void setRelationalAttributeIndex(int relationalAttributeIndex)

listOptions

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

Returns an enumeration describing the available options.

Specified by:

listOptions in interface weka.core.OptionHandler

Overrides:

listOptions in class AbstractInstanceIterator

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

Overrides:

getOptions in class AbstractInstanceIterator

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

Overrides:

setOptions in class AbstractInstanceIterator

Parameters:

options - the list of options as an array of strings

Throws:

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