OpenANN::DataSet Class Reference

Data set interface. More...

#include <DataSet.h>

Inheritance diagram for OpenANN::DataSet:

Public Member Functions
virtual	~DataSet ()
virtual int	samples ()=0
	Number of instances. More...
virtual int	inputs ()=0
	Input dimensions of instances. More...
virtual int	outputs ()=0
	Output dimensions of instances. More...
virtual Eigen::VectorXd &	getInstance (int n)=0
	Get the input of the ith instance. More...
virtual Eigen::VectorXd &	getTarget (int n)=0
	Get the output of the ith instance. More...
virtual void	finishIteration (Learner &learner)=0
	This function is called after an iteration of the optimization algorithm. More...

Detailed Description

Data set interface.

A data set can be either a training, validation or test set. Supervised data sets provide instances and targets. Unsupervised data sets might provide only instances.

See Creating a data set.

Constructor & Destructor Documentation

virtual OpenANN::DataSet::~DataSet ( )

inlinevirtual

Member Function Documentation

virtual void OpenANN::DataSet::finishIteration ( Learner &  learner)

pure virtual

This function is called after an iteration of the optimization algorithm.

It could log results, modify or extend the data set or whatever.

Parameters

learner

learned model

Implemented in BCIDataSet, OpenANN::DataSetView, OpenANN::DirectStorageDataSet, OpenANN::WeightedDataSet, and TwoSpiralsDataSet.

virtual Eigen::VectorXd& OpenANN::DataSet::getInstance ( int  n)

pure virtual

Get the input of the ith instance.

Parameters

n	number of instance

Returns

input

Implemented in BCIDataSet, OpenANN::DataSetView, OpenANN::DirectStorageDataSet, OpenANN::WeightedDataSet, and TwoSpiralsDataSet.

virtual Eigen::VectorXd& OpenANN::DataSet::getTarget ( int  n)

pure virtual

Get the output of the ith instance.

Parameters

n	number of instance

Returns

output

Implemented in BCIDataSet, OpenANN::DataSetView, OpenANN::DirectStorageDataSet, OpenANN::WeightedDataSet, and TwoSpiralsDataSet.

virtual int OpenANN::DataSet::inputs ( )

pure virtual

Input dimensions of instances.

Returns

number of inputs

Implemented in BCIDataSet, OpenANN::DataSetView, OpenANN::DirectStorageDataSet, OpenANN::WeightedDataSet, and TwoSpiralsDataSet.

virtual int OpenANN::DataSet::outputs ( )

pure virtual

Output dimensions of instances.

Returns

number of outputs

Implemented in BCIDataSet, OpenANN::DataSetView, OpenANN::DirectStorageDataSet, OpenANN::WeightedDataSet, and TwoSpiralsDataSet.

virtual int OpenANN::DataSet::samples ( )

pure virtual

Number of instances.

Assumes that the data set has a fixed size, at least for one iteration of the optimization algorithm.

Returns

number of examples

Implemented in BCIDataSet, OpenANN::DataSetView, OpenANN::DirectStorageDataSet, OpenANN::WeightedDataSet, and TwoSpiralsDataSet.

---

The documentation for this class was generated from the following file:

• OpenANN/io/DataSet.h