org.encog.util.simple
Class EncogUtility

java.lang.Object
  org.encog.util.simple.EncogUtility

public final class EncogUtility
extends Object

General utility class for Encog. Provides for some common Encog procedures.

Method Summary

static void	convertCSV2Binary(File csvFile, File binFile, int inputCount, int outputCount, boolean headers) Convert a CSV file to a binary training file.
static void	evaluate(BasicNetwork network, NeuralDataSet training) Evaluate the network and display (to the console) the output for every value in the training set.
static String	formatNeuralData(NeuralData data) Format neural data as a list of numbers.
static BasicNetwork	simpleFeedForward(int input, int hidden1, int hidden2, int output, boolean tanh) Create a simple feedforward neural network.
static void	trainConsole(BasicNetwork network, NeuralDataSet trainingSet, int minutes) Train the neural network, using SCG training, and output status to the console.
static void	trainConsole(Train train, BasicNetwork network, NeuralDataSet trainingSet, int minutes) Train the network, using the specified training algorithm, and send the output to the console.
static void	trainDialog(BasicNetwork network, NeuralDataSet trainingSet) Train using SCG and display progress to a dialog box.
static void	trainDialog(Train train, BasicNetwork network, NeuralDataSet trainingSet) Train, using the specified training method, display progress to a dialog box.
static void	trainToError(BasicNetwork network, NeuralDataSet trainingSet, double error) Train the network, to a specific error, send the output to the console.
static void	trainToError(Train train, BasicNetwork network, NeuralDataSet trainingSet, double error) Train to a specific error, using the specified training method, send the output to the console.

Methods inherited from class java.lang.Object

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

Method Detail

convertCSV2Binary

public static void convertCSV2Binary(File csvFile,
                                     File binFile,
                                     int inputCount,
                                     int outputCount,
                                     boolean headers)

Convert a CSV file to a binary training file.

Parameters:

csvFile - The CSV file.

binFile - The binary file.

inputCount - The number of input values.

outputCount - The number of output values.

headers - True, if there are headers on the3 CSV.

evaluate

public static void evaluate(BasicNetwork network,
                            NeuralDataSet training)

Evaluate the network and display (to the console) the output for every value in the training set. Displays ideal and actual.

Parameters:

network - The network to evaluate.

training - The training set to evaluate.

formatNeuralData

public static String formatNeuralData(NeuralData data)

Format neural data as a list of numbers.

Parameters:

data - The neural data to format.

Returns:

The formatted neural data.

simpleFeedForward

public static BasicNetwork simpleFeedForward(int input,
                                             int hidden1,
                                             int hidden2,
                                             int output,
                                             boolean tanh)

Create a simple feedforward neural network.

Parameters:

input - The number of input neurons.

hidden1 - The number of hidden layer 1 neurons.

hidden2 - The number of hidden layer 2 neurons.

output - The number of output neurons.

tanh - True to use hyperbolic tangent activation function, false to use the sigmoid activation function.

Returns:

The neural network.

trainConsole

public static void trainConsole(BasicNetwork network,
                                NeuralDataSet trainingSet,
                                int minutes)

Train the neural network, using SCG training, and output status to the console.

Parameters:

network - The network to train.

trainingSet - The training set.

minutes - The number of minutes to train for.

trainConsole

public static void trainConsole(Train train,
                                BasicNetwork network,
                                NeuralDataSet trainingSet,
                                int minutes)

Train the network, using the specified training algorithm, and send the output to the console.

Parameters:

train - The training method to use.

network - The network to train.

trainingSet - The training set.

minutes - The number of minutes to train for.

trainDialog

public static void trainDialog(BasicNetwork network,
                               NeuralDataSet trainingSet)

Train using SCG and display progress to a dialog box.

Parameters:

network - The network to train.

trainingSet - The training set to use.

trainDialog

public static void trainDialog(Train train,
                               BasicNetwork network,
                               NeuralDataSet trainingSet)

Train, using the specified training method, display progress to a dialog box.

Parameters:

train - The training method to use.

network - The network to train.

trainingSet - The training set to use.

trainToError

public static void trainToError(BasicNetwork network,
                                NeuralDataSet trainingSet,
                                double error)

Train the network, to a specific error, send the output to the console.

Parameters:

network - The network to train.

trainingSet - The training set to use.

error - The error level to train to.

trainToError

public static void trainToError(Train train,
                                BasicNetwork network,
                                NeuralDataSet trainingSet,
                                double error)

Train to a specific error, using the specified training method, send the output to the console.

Parameters:

train - The training method.

network - The network to train.

trainingSet - The training set to use.

error - The desired error level.