org.nd4j.linalg.dataset

Class MultiDataSet

java.lang.Object

org.nd4j.linalg.dataset.MultiDataSet

All Implemented Interfaces:

Serializable, MultiDataSet

public class MultiDataSet
extends Object
implements MultiDataSet

Implementation of MultiDataSet

Author:

Alex Black

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MultiDataSet(INDArray[] features, INDArray[] labels) MultiDataSet constructor with no mask arrays
MultiDataSet(INDArray[] features, INDArray[] labels, INDArray[] featuresMaskArrays, INDArray[] labelsMaskArrays)
MultiDataSet(INDArray features, INDArray labels) MultiDataSet constructor with single features/labels input, no mask arrays

Method Summary

Modifier and Type	Method and Description
INDArray[]	getFeatures() Get all of the input features, as an array of INDArrays
INDArray	getFeatures(int index) Get a single feature/input array
INDArray	getFeaturesMaskArray(int index) Get the specified feature mask array.
INDArray[]	getFeaturesMaskArrays() Get the feature mask arrays.
INDArray[]	getLabels() Get all of the labels, as an array of INDArrays
INDArray	getLabels(int index) Get a single label/output array
INDArray	getLabelsMaskArray(int index) Get the specified label mask array.
INDArray[]	getLabelsMaskArrays() Get the labels mask arrays.
boolean	hasMaskArrays() Whether there are any mask arrays (features or labels) present for this MultiDataSet
static MultiDataSet	merge(Collection<? extends MultiDataSet> toMerge) Merge a collection of MultiDataSet objects into a single MultiDataSet.
int	numFeatureArrays() Number of arrays of features/input data in the MultiDataSet
int	numLabelsArrays() Number of arrays of label/output data in the MultiDataSet
void	setFeatures(INDArray[] features) Set all of the features arrays for the MultiDataSet
void	setFeatures(int idx, INDArray features) Set a single features array (by index) for the MultiDataSet
void	setFeaturesMaskArray(int idx, INDArray maskArray) Set a single feature mask array by index
void	setFeaturesMaskArrays(INDArray[] maskArrays) Set the feature mask arrays
void	setLabels(INDArray[] labels) Set all of the labels arrays for the MultiDataSet
void	setLabels(int idx, INDArray labels) Set a single labels array (by index) for the MultiDataSet
void	setLabelsMaskArray(INDArray[] labelsMaskArrays) Set the labels mask arrays
void	setLabelsMaskArray(int idx, INDArray labelsMaskArray) Set a single labels mask array by index

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiDataSet

public MultiDataSet(INDArray features,
                    INDArray labels)

MultiDataSet constructor with single features/labels input, no mask arrays

MultiDataSet

public MultiDataSet(INDArray[] features,
                    INDArray[] labels)

MultiDataSet constructor with no mask arrays

MultiDataSet

public MultiDataSet(INDArray[] features,
                    INDArray[] labels,
                    INDArray[] featuresMaskArrays,
                    INDArray[] labelsMaskArrays)

Parameters:

features - The features (inputs) to the algorithm/neural network

labels - The labels (outputs) to the algorithm/neural network

featuresMaskArrays - The mask arrays for the features. May be null. Typically used with variable-length time series models, etc

labelsMaskArrays - The mask arrays for the labels. May be null. Typically used with variable-length time series models, etc

Method Detail

numFeatureArrays

public int numFeatureArrays()

Description copied from interface: MultiDataSet

Number of arrays of features/input data in the MultiDataSet

Specified by:

numFeatureArrays in interface MultiDataSet

numLabelsArrays

public int numLabelsArrays()

Description copied from interface: MultiDataSet

Number of arrays of label/output data in the MultiDataSet

Specified by:

numLabelsArrays in interface MultiDataSet

getFeatures

public INDArray[] getFeatures()

Description copied from interface: MultiDataSet

Get all of the input features, as an array of INDArrays

Specified by:

getFeatures in interface MultiDataSet

getFeatures

public INDArray getFeatures(int index)

Description copied from interface: MultiDataSet

Get a single feature/input array

Specified by:

getFeatures in interface MultiDataSet

setFeatures

public void setFeatures(INDArray[] features)

Description copied from interface: MultiDataSet

Set all of the features arrays for the MultiDataSet

Specified by:

setFeatures in interface MultiDataSet

setFeatures

public void setFeatures(int idx,
                        INDArray features)

Description copied from interface: MultiDataSet

Set a single features array (by index) for the MultiDataSet

Specified by:

setFeatures in interface MultiDataSet

getLabels

public INDArray[] getLabels()

Description copied from interface: MultiDataSet

Get all of the labels, as an array of INDArrays

Specified by:

getLabels in interface MultiDataSet

getLabels

public INDArray getLabels(int index)

Description copied from interface: MultiDataSet

Get a single label/output array

Specified by:

getLabels in interface MultiDataSet

setLabels

public void setLabels(INDArray[] labels)

Description copied from interface: MultiDataSet

Set all of the labels arrays for the MultiDataSet

Specified by:

setLabels in interface MultiDataSet

setLabels

public void setLabels(int idx,
                      INDArray labels)

Description copied from interface: MultiDataSet

Set a single labels array (by index) for the MultiDataSet

Specified by:

setLabels in interface MultiDataSet

hasMaskArrays

public boolean hasMaskArrays()

Description copied from interface: MultiDataSet

Whether there are any mask arrays (features or labels) present for this MultiDataSet

Specified by:

hasMaskArrays in interface MultiDataSet

getFeaturesMaskArrays

public INDArray[] getFeaturesMaskArrays()

Description copied from interface: MultiDataSet

Get the feature mask arrays. May return null if no feature mask arrays are present; otherwise, any entry in the array may be null if no mask array is present for that particular feature

Specified by:

getFeaturesMaskArrays in interface MultiDataSet

getFeaturesMaskArray

public INDArray getFeaturesMaskArray(int index)

Description copied from interface: MultiDataSet

Get the specified feature mask array. Returns null if no feature mask is present for that particular feature/input

Specified by:

getFeaturesMaskArray in interface MultiDataSet

setFeaturesMaskArrays

public void setFeaturesMaskArrays(INDArray[] maskArrays)

Description copied from interface: MultiDataSet

Set the feature mask arrays

Specified by:

setFeaturesMaskArrays in interface MultiDataSet

setFeaturesMaskArray

public void setFeaturesMaskArray(int idx,
                                 INDArray maskArray)

Description copied from interface: MultiDataSet

Set a single feature mask array by index

Specified by:

setFeaturesMaskArray in interface MultiDataSet

getLabelsMaskArrays

public INDArray[] getLabelsMaskArrays()

Description copied from interface: MultiDataSet

Get the labels mask arrays. May return null if no labels mask arrays are present; otherwise, any entry in the array may be null if no mask array is present for that particular label

Specified by:

getLabelsMaskArrays in interface MultiDataSet

getLabelsMaskArray

public INDArray getLabelsMaskArray(int index)

Description copied from interface: MultiDataSet

Get the specified label mask array. Returns null if no label mask is present for that particular feature/input

Specified by:

getLabelsMaskArray in interface MultiDataSet

setLabelsMaskArray

public void setLabelsMaskArray(INDArray[] labelsMaskArrays)

Description copied from interface: MultiDataSet

Set the labels mask arrays

Specified by:

setLabelsMaskArray in interface MultiDataSet

setLabelsMaskArray

public void setLabelsMaskArray(int idx,
                               INDArray labelsMaskArray)

Description copied from interface: MultiDataSet

Set a single labels mask array by index

Specified by:

setLabelsMaskArray in interface MultiDataSet

merge

public static MultiDataSet merge(Collection<? extends MultiDataSet> toMerge)

Merge a collection of MultiDataSet objects into a single MultiDataSet. Merging is done by concatenating along dimension 0 (example number in batch) Merging operation may introduce mask arrays (when necessary) for time series data that has different lengths; if mask arrays already exist, these will be merged also.

Parameters:

toMerge - Collection of MultiDataSet objects to merge

Returns:

a single MultiDataSet object, containing the arrays of