org.neuroph.core.data

Class DataSet

java.lang.Object

org.neuroph.core.data.DataSet

All Implemented Interfaces:

Serializable, Iterable<DataSetRow>, Collection<DataSetRow>, List<DataSetRow>

Direct Known Subclasses:

BufferedDataSet

public class DataSet
extends Object
implements List<DataSetRow>, Serializable

This class represents a collection of data rows (DataSetRow instances) used for training and testing neural network. TODO: add logging

Author:

Zoran Sevarac

See Also:

http://openforecast.sourceforge.net/docs/net/sourceforge/openforecast/DataSet.html, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DataSet(int inputSize) Creates an instance of new empty training set
DataSet(int inputSize, int outputSize) Creates an instance of new empty training set

Method Summary

Modifier and Type	Method and Description
boolean	add(DataSetRow row)
void	add(int index, DataSetRow row)
boolean	addAll(Collection<? extends DataSetRow> c)
boolean	addAll(int index, Collection<? extends DataSetRow> c)
boolean	addRow(DataSetRow row) Adds new row row to this data set
void	addRow(double[] input) Adds a new dataset row with specified input
void	addRow(double[] input, double[] output) Adds a new dataset row with specified input and output
void	clear() Removes all alements from training set
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
static DataSet	createFromFile(String filePath, int inputsCount, int outputsCount, String delimiter) Creates and returns data set from specified csv file
static DataSet	createFromFile(String filePath, int inputsCount, int outputsCount, String delimiter, boolean loadColumnNames) Creates and returns data set from specified csv file
DataSet[]	createTrainingAndTestSubsets(int trainSetPercent, int testSetPercent) Returns training and test subsets in the specified percent ratio
DataSetRow	get(int index)
String	getColumnName(int idx)
String[]	getColumnNames()
DataSetColumnType	getColumnType(int index)
DataSetColumnType[]	getColumnTypes()
String	getFilePath() Returns full file path for this training set
int	getInputSize() Returns input vector size of training elements in this training set This method is implementation of EngineIndexableSet interface, and it is added to provide compatibility with Encog data sets and FlatNetwork
String	getLabel() Returns label for this training set
int	getOutputSize() Returns output vector size of training elements in this training set.
DataSetRow	getRowAt(int idx) Returns training row at specified index position
List<DataSetRow>	getRows() Returns elements of this training set
int	indexOf(Object row)
boolean	isEmpty() Returns true if training set is empty, false otherwise
boolean	isSupervised() Returns true if data set is supervised, false otherwise
Iterator<DataSetRow>	iterator() Returns Iterator for iterating training elements collection
int	lastIndexOf(Object row)
ListIterator<DataSetRow>	listIterator()
ListIterator<DataSetRow>	listIterator(int index)
static DataSet	load(String filePath) Loads training set from the specified file TODO: throw checked exceptionse here
DataSetRow	remove(int index)
boolean	remove(Object row)
boolean	removeAll(Collection<?> c)
void	removeRowAt(int idx) Removes training row at specified index position
boolean	retainAll(Collection<?> c)
List<DataSet>	sample(Sampling sampling)
void	save() Saves this training set to file specified in its filePath field
void	save(String filePath) Saves this training set to the specified file
void	saveAsTxt(String filePath, String delimiter)
DataSetRow	set(int index, DataSetRow row)
void	setColumnName(int idx, String columnName)
void	setColumnNames(String[] columnNames)
void	setColumnType(int index, DataSetColumnType columnType) Sets column type for the given index.
void	setFilePath(String filePath) Sets full file path for this training set
void	setLabel(String label) Sets label for this training set
void	shuffle()
int	size() Returns number of training elements in this training set set
List<DataSet>	split(int... sizePercents)
List<DataSetRow>	subList(int fromIndex, int toIndex)
Object[]	toArray()
<T> T[]	toArray(T[] a)
String	toCSV() Returns enire dataset in csv format
String	toString() Returns string representation of this data set

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

equals, hashCode, replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

DataSet

public DataSet(int inputSize)

Creates an instance of new empty training set

Parameters:

inputSize -

DataSet

public DataSet(int inputSize,
               int outputSize)

Creates an instance of new empty training set

Parameters:

inputSize - Length of the input vector

outputSize - Length of the output vector

Method Detail

addRow

public boolean addRow(DataSetRow row)
               throws VectorSizeMismatchException

Adds new row row to this data set

Parameters:

row - data set row to add

Throws:

VectorSizeMismatchException

addRow

public void addRow(double[] input)

Adds a new dataset row with specified input

Parameters:

input -

addRow

public void addRow(double[] input,
                   double[] output)

Adds a new dataset row with specified input and output

Parameters:

input -

output -

removeRowAt

public void removeRowAt(int idx)

Removes training row at specified index position

Parameters:

idx - position of row to remove

iterator

public Iterator<DataSetRow> iterator()

Returns Iterator for iterating training elements collection

Specified by:

iterator in interface Iterable<DataSetRow>

Specified by:

iterator in interface Collection<DataSetRow>

Specified by:

iterator in interface List<DataSetRow>

Returns:

Iterator for iterating training elements collection

getRows

public List<DataSetRow> getRows()

Returns elements of this training set

Returns:

training elements

getRowAt

public DataSetRow getRowAt(int idx)

Returns training row at specified index position

Parameters:

idx - index position of training row to return

Returns:

training row at specified index position

clear

public void clear()

Removes all alements from training set

Specified by:

clear in interface Collection<DataSetRow>

Specified by:

clear in interface List<DataSetRow>

isEmpty

public boolean isEmpty()

Returns true if training set is empty, false otherwise

Specified by:

isEmpty in interface Collection<DataSetRow>

Specified by:

isEmpty in interface List<DataSetRow>

Returns:

true if training set is empty, false otherwise

isSupervised

public boolean isSupervised()

Returns true if data set is supervised, false otherwise

Returns:

size

public int size()

Returns number of training elements in this training set set

Specified by:

size in interface Collection<DataSetRow>

Specified by:

size in interface List<DataSetRow>

Returns:

number of training elements in this training set set

getLabel

public String getLabel()

Returns label for this training set

Returns:

label for this training set

setLabel

public void setLabel(String label)

Sets label for this training set

Parameters:

label - label for this training set

getColumnNames

public String[] getColumnNames()

setColumnNames

public void setColumnNames(String[] columnNames)

getColumnName

public String getColumnName(int idx)

setColumnName

public void setColumnName(int idx,
                          String columnName)

getColumnTypes

public DataSetColumnType[] getColumnTypes()

getColumnType

public DataSetColumnType getColumnType(int index)

setColumnType

public void setColumnType(int index,
                          DataSetColumnType columnType)

Sets column type for the given index.

Parameters:

index - Index of the column in the row.

columnType - Column type to set, nominal or numeric.

setFilePath

public void setFilePath(String filePath)

Sets full file path for this training set

Parameters:

filePath -

getFilePath

public String getFilePath()

Returns full file path for this training set

Returns:

full file path for this training set

toString

public String toString()

Returns string representation of this data set

Overrides:

toString in class Object

Returns:

string representation of this data set

toCSV

public String toCSV()

Returns enire dataset in csv format

Returns:

save

public void save(String filePath)

Saves this training set to the specified file

Parameters:

filePath -

save

public void save()

Saves this training set to file specified in its filePath field

saveAsTxt

public void saveAsTxt(String filePath,
                      String delimiter)

load

public static DataSet load(String filePath)

Loads training set from the specified file TODO: throw checked exceptionse here

Parameters:

filePath - training set file

Returns:

loded training set

createFromFile

public static DataSet createFromFile(String filePath,
                                     int inputsCount,
                                     int outputsCount,
                                     String delimiter,
                                     boolean loadColumnNames)

Creates and returns data set from specified csv file

Parameters:

filePath - path to csv dataset file to import

inputsCount - number of inputs

outputsCount - number of outputs

delimiter - delimiter of values

loadColumnNames - true if csv file contains column names in first line, false otherwise

Returns:

instance of dataset with values from specified file TODO: try with resources, provide information on exact line of error if format is not good in NumberFormatException

createFromFile

public static DataSet createFromFile(String filePath,
                                     int inputsCount,
                                     int outputsCount,
                                     String delimiter)

Creates and returns data set from specified csv file

Parameters:

filePath - path to csv dataset file to import

inputsCount - number of inputs

outputsCount - number of outputs

delimiter - delimiter of values

Returns:

instance of dataset with values from specified file

createTrainingAndTestSubsets

public DataSet[] createTrainingAndTestSubsets(int trainSetPercent,
                                              int testSetPercent)

Returns training and test subsets in the specified percent ratio

Parameters:

trainSetPercent -

testSetPercent -

Returns:

split

public List<DataSet> split(int... sizePercents)

sample

public List<DataSet> sample(Sampling sampling)

getOutputSize

public int getOutputSize()

Returns output vector size of training elements in this training set.

getInputSize

public int getInputSize()

Returns input vector size of training elements in this training set This method is implementation of EngineIndexableSet interface, and it is added to provide compatibility with Encog data sets and FlatNetwork

shuffle

public void shuffle()

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<DataSetRow>

Specified by:

contains in interface List<DataSetRow>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<DataSetRow>

Specified by:

toArray in interface List<DataSetRow>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<DataSetRow>

Specified by:

toArray in interface List<DataSetRow>

add

public boolean add(DataSetRow row)

Specified by:

add in interface Collection<DataSetRow>

Specified by:

add in interface List<DataSetRow>

remove

public boolean remove(Object row)

Specified by:

remove in interface Collection<DataSetRow>

Specified by:

remove in interface List<DataSetRow>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<DataSetRow>

Specified by:

containsAll in interface List<DataSetRow>

addAll

public boolean addAll(Collection<? extends DataSetRow> c)

Specified by:

addAll in interface Collection<DataSetRow>

Specified by:

addAll in interface List<DataSetRow>

addAll

public boolean addAll(int index,
                      Collection<? extends DataSetRow> c)

Specified by:

addAll in interface List<DataSetRow>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<DataSetRow>

Specified by:

removeAll in interface List<DataSetRow>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<DataSetRow>

Specified by:

retainAll in interface List<DataSetRow>

get

public DataSetRow get(int index)

Specified by:

get in interface List<DataSetRow>

set

public DataSetRow set(int index,
                      DataSetRow row)

Specified by:

set in interface List<DataSetRow>

add

public void add(int index,
                DataSetRow row)

Specified by:

add in interface List<DataSetRow>

remove

public DataSetRow remove(int index)

Specified by:

remove in interface List<DataSetRow>

indexOf

public int indexOf(Object row)

Specified by:

indexOf in interface List<DataSetRow>

lastIndexOf

public int lastIndexOf(Object row)

Specified by:

lastIndexOf in interface List<DataSetRow>

listIterator

public ListIterator<DataSetRow> listIterator()

Specified by:

listIterator in interface List<DataSetRow>

listIterator

public ListIterator<DataSetRow> listIterator(int index)

Specified by:

listIterator in interface List<DataSetRow>

subList

public List<DataSetRow> subList(int fromIndex,
                                int toIndex)

Specified by:

subList in interface List<DataSetRow>