C# Class Encog.Neural.Data.Buffer.BufferedNeuralDataSet

This class is not memory based, so very long files can be used, without running out of memory. This dataset uses a Encog binary training file as a buffer. When used with a slower access dataset, such as CSV, XML or SQL, where parsing must occur, this dataset can be used to load from the slower dataset and train at much higher speeds. If you are going to create a binary file, by using the add methods, you must call beginLoad to cause Encog to open an output file. Once the data has been loaded, call endLoad. You can also use the BinaryDataLoader class, with a CODEC, to load many other popular external formats. The binary files produced by this class are in the Encog binary training format, and can be used with any Encog platform. Encog binary files are stored using "little endian" numbers.

Inheritance: INeuralDataSet, IIndexable

Show file Open project: encog/encog-silverlight-core Class Usage Examples

Public Methods

Method	Description
Add ( INeuralData data1 ) : void	Add only input data, for an unsupervised dataset.
Add ( INeuralData inputData, INeuralData idealData ) : void	Add both the input and ideal data.
Add ( INeuralDataPair pair ) : void	Add a data pair of both input and ideal data.
BeginLoad ( int inputSize, int idealSize ) : void	Begin loading to the binary file. After calling this method the add methods may be called.
BufferedNeuralDataSet ( String binaryFile ) : System	Construct a buffered dataset using the specified file.
Close ( ) : void	Close the dataset.
CreatePersistor ( ) : IPersistor	Create an Encog persistor for this object.
EndLoad ( ) : void	This method should be called once all the data has been loaded. The underlying file will be closed. The binary fill will then be opened for reading.
GetEnumerator ( ) : IEnumerator	Create an enumerator.
GetRecord ( long index, IEngineData pair ) : void	Read an individual record.
Load ( INeuralDataSet training ) : void	Load the specified training set.
LoadToMemory ( ) : INeuralDataSet	Load the binary dataset to memory. Memory access is faster.
Open ( ) : void	Open the binary file for reading.
OpenAdditional ( ) : IEngineIndexableSet	Open an additional training set.
RemoveAdditional ( BufferedNeuralDataSet child ) : void	Remove an additional dataset that was created.

Method Details

Add() public method

Add only input data, for an unsupervised dataset.

public Add ( INeuralData data1 ) : void
data1	INeuralData	The data to be added.
return	void

Add() public method

Add both the input and ideal data.

public Add ( INeuralData inputData, INeuralData idealData ) : void
inputData	INeuralData	The input data.
idealData	INeuralData	The ideal data.
return	void

Add() public method

Add a data pair of both input and ideal data.

public Add ( INeuralDataPair pair ) : void
pair	INeuralDataPair	The pair to add.
return	void

BeginLoad() public method

Begin loading to the binary file. After calling this method the add methods may be called.

public BeginLoad ( int inputSize, int idealSize ) : void
inputSize	int	The input size.
idealSize	int	The ideal size.
return	void

BufferedNeuralDataSet() public method

Construct a buffered dataset using the specified file.

public BufferedNeuralDataSet ( String binaryFile ) : System
binaryFile	String	The file to read/write binary data to/from.
return	System

Close() public method

Close the dataset.

public Close ( ) : void
return	void

CreatePersistor() public method

Create an Encog persistor for this object.

public CreatePersistor ( ) : IPersistor
return	IPersistor

EndLoad() public method

This method should be called once all the data has been loaded. The underlying file will be closed. The binary fill will then be opened for reading.

public EndLoad ( ) : void
return	void

GetEnumerator() public method

Create an enumerator.

public GetEnumerator ( ) : IEnumerator
return	IEnumerator

GetRecord() public method

Read an individual record.

public GetRecord ( long index, IEngineData pair ) : void
index	long	The zero-based index. Specify 0 for the first record, 1 for /// the second, and so on.
pair	IEngineData	The data to read.
return	void

Load() public method

Load the specified training set.

public Load ( INeuralDataSet training ) : void
training	INeuralDataSet	The training set to load.
return	void

LoadToMemory() public method

Load the binary dataset to memory. Memory access is faster.

public LoadToMemory ( ) : INeuralDataSet
return	INeuralDataSet

Open() public method

Open the binary file for reading.

public Open ( ) : void
return	void

OpenAdditional() public method

Open an additional training set.

public OpenAdditional ( ) : IEngineIndexableSet
return	IEngineIndexableSet

RemoveAdditional() public method

Remove an additional dataset that was created.

public RemoveAdditional ( BufferedNeuralDataSet child ) : void
child	BufferedNeuralDataSet	The additional dataset to remove.
return	void