NeurApp 1.1
NeurApp - software for exploring approximation by artificial neural networks on functions of one or two variables.

IG::Neural::INeuralApproximator Interface Reference

Approximator of response by using neural networks. $A Igor Mar11;. More...

Inheritance diagram for IG::Neural::INeuralApproximator:

List of all members.

Public Member Functions

int GetNumNeuronsInHiddenLayer (int whichLayer)
 Returns the number of neurons in the specified hidden layer. Hidden layers are those not containing input or output neurons.
void SetNumNeuronsInHiddenLayer (int whichLayer, int numNeurons)
 Sets the number of neurons in the specified hidden layer. Hidden layers are those not containing input or output neurons.
void SetHiddenLayers (params int[] numNeurons)
 Sets the numbers of neurons in each hidden layer. Can be called with table of integers as argument, kor with variable number of integer parameters. Numbers are set by an array of integers in which each element contains the number of neurons in the corresponding hidden layer (indexed from 0). Hidden layers are those not containing input or output neurons.
void PrepareNetwork ()
 Prepares neural network for use. If networks have not yet been created according to internal data, they are created. If networks are already prepared then this method does nothing.
void CreateNetwork ()
 Creates the neural network anew. If the network already exists on the current object, it is discarded.
void ResetNetwork ()
 Resets the neural network.
void DestroyNetwork ()
 Destroys the neural network.
string GetNetworkFilePath (string fileOrDirectoryPath, int whichNetwork)
 Returns an absolute path to the file for storing the specified neural network contained on the current object, with respect to suggested file path and index of the network. The returned path is in the same directory as suggested file path and has the same file extension (if any). If the suggested path represents a directory, then some default suggested path is assumed. If there is only one network then the returned file path is the same as the suggested one (or the same as default file name within the suggested directory, if a directory path is proposed).
void SaveNetwork (string filePath)
 Saves the state of the neural network to the specified file. If the file already exists, its contents are overwritten.
void LoadNetwork (string filePath)
 Restores neural network from a file where it has been stored before.
void SaveTrainingDataJson (string filePath)
 Saves network's training data to the specified JSON file. File is owerwritten if it exists.
void LoadTrainingDataJson (string filePath)
 Restores training data from the specified file in JSON format.
void SetNeuronsInputRange (double min, double max)
 Sets the neurons input range. Bounds for all input neurons are set equally.
void SetNeuronsOutputRange (double min, double max)
 Sets the neurons output range. Bounds for all output neurons are set equally.
void RecalculateInputDataBounds ()
 Recalculates input data bounds by taking into account the training data set of the current object.
void RecalculateOutputDataBounds ()
 Recalculates output data bounds by taking into account the training data set of the current object.
void RecalculateDataBounds ()
 Recalculates input and output data bounds by taking into account the training data set of the current object.
void RecalculateInputDataBounds (SampledDataSet trainingData)
 Recalculates input data bounds by taking into account the specified training data set.
void RecalculateOutputDataBounds (SampledDataSet trainingData)
 Recalculates output data bounds by taking into account the specified training data set.
void RecalculateDataBounds (SampledDataSet trainingData)
 Recalculates input and output data bounds by taking into account the specified training data set.
void GetErrorsTrainingRms (ref IVector errors)
 Calculates the RMS (root mean square) of the errors of output values for the training elements of the training set (this excludes verification points).
void GetErrorsVerificationRms (ref IVector errors)
 Calculates the RMS (root mean square) of the errors of output values for the verification elements of the training set.
void GetErrorsTrainingMax (ref IVector errors)
 Calculates the maximum absolute errors of output values for the training elements of the training set (this excludes verification points).
void GetErrorsVerificationMax (ref IVector errors)
 Calculates the maximum absolute errors of output values for the verification elements of the training set.
void GetErrorsTrainingMeanAbs (ref IVector errors)
 Calculates the mean absolute errors of output values for the training elements of the training set (this excludes verification points).
void GetErrorsVerificationMeanAbs (ref IVector errors)
 Calculates the mean absolute errors of output values for the verification elements of the training set.
void InvalidateTrainingDependencies ()
 Invalidates all data that must be recalculated after training of the network is done. This method is called after training or additional training of the network is performed. Invalidation is achieved throughthe the appropriate flags.
void InvalidateTrainingDataDependencies ()
 Invalidates all data that must be re-calculated after training data changes. This method is called after training data is modified. Invalidation is achieved throughthe the appropriate flags.
void InvalidateNetworkDependencies ()
 Invalidates all data that must be re-calculated after the neural network itself changes. This method must be called after the internal neural network is re-defined (or are re-defined). Invalidation is achieved throughthe the appropriate flags.
void TrainNetwork (int numEpochs)
 Trains neural network wiht the specified data, performing the specified number of epochs.
void TrainNetwork ()
 Trains neural network until stopping criteria are met (in terms of errors and number of epochs performed.
bool StopTrainingCriteriaMet ()
 Returns true if the stopping criteria for training is met, with respect to current settings, errors and number of epochs already performed, and false otherwise.
void CalculateOutput (IVector input, ref IVector output)
 Calculates and returns the approximated outputs corresponding to the specified inputs, by using the current neural network.
double CalculateOutput (IVector input, int whichElement)
 Calculates and returns the specified output by using the neural network.
void CalculateOutput (IVector input, int[] indices, ref IVector filteredOutput)
 Calculates and returns the required output values corresponding to the specified inputs, by using the current neural network(s).

Properties

int OutputLevel [get, set]
 Level of output printed to console when performing actions.
bool MultipleNetworks [get, set]
 Flag indicating whether multiple neural networks are used to approximate multiple outputs (one network for each output)
int InputLength [get, set]
 Gets or sets the number of input neurons.
int OutputLength [get, set]
 Gets or sets the number of output neurons.
int[] NumHiddenNeurons [get, set]
 Sets the numbers of neurons in each hidden layer. Numbers are set by an array of integers in which each element contains the number of neurons in the corresponding hidden layer (indexed from 0). Hidden layers are those not containing input or output neurons.
int NumHiddenLayers [get, set]
 Gets or sets the number of hidden layers of the neural network (these are layers that don't contain input or output neurons).
bool NetworkPrepared [get]
 Gets a flag telling whether the network is prepared for operation (training and calculation of output).
double SigmoidAlphaValue [get, set]
 Alpha value specifying the shape of the activation function.
double LearningRate [get, set]
 Gets or sets learning rate.
double Momentum [get, set]
 Gets or sets momentum.
int EpochCount [get]
 Number of learning epochs performed up to the current moment.
int MaxEpochs [get, set]
 Maximal number of epochs in training.
int EpochsInBundle [get, set]
 Number of epochs in a single training bundle. This number of epochs is performed at once when training, without checking convergence criteria between. Larger value means slightly more efficient training (because of less checks) but rougher criteria checks.
IVector ToleranceRms [get, set]
 Tolerance over RMS error of output over training points. Training will continue until error becomes below tolerance or until maximal number of epochs is reached. If less or equal than 0 then this tolerance is not taken into account.
IVector ToleranceMax [get, set]
 Tolerance on maximal error of output over training points. Training will continue until error becomes below tolerance or until maximal number of epochs is reached. If less or equal than 0 then this tolerance is not taken into account.
IVector ToleranceRmsRelativeToRange [get, set]
 Relative tolerances on RMS errors of outputs over training points, relative to the correspoinding ranges of output data.
double ToleranceRmsRelativeToRangeScalar [get, set]
 Scalar through which all components of the Relative tolerances on RMS errors of outputs can be set to the same value.
IVector ToleranceMaxRelativeToRange [get, set]
 Relative tolerances on max. abs. errors of outputs over training points, relative to the correspoinding ranges of output data.
double ToleranceMaxRelativeToRangeScalar [get, set]
 Scalar through which all components of the Relative tolerances on max. abs. errors of outputs can be set to the same value.
bool SaveConvergenceRms [get, set]
 Flag to enable Rms error convergence colection. Default is false.
List< int > EpochNumbers [get, set]
 List of epoch numbers at which convergence data was sampled. Saved after every set of epochs.
List< IVector > ConvergenceErrorsTrainingRmsList [get, set]
 Convergence List of Rms errors calculated on training data. Saved after every set of epochs.
List< IVector > ConvergenceErrorsTrainingMaxList [get, set]
 Convergence List of Maximum errors calculated on training data. Saved after every set of epochs.
List< IVector > ConvergenceErrorsVerificationRmsList [get, set]
 Convergence List of Rms errors calculated on verification data. Saved after every set of epochs.
List< IVector > ConvergenceErrorsVerificationMaxList [get, set]
 Convergence List of Maximum errors calculated on verification data. Saved after every set of epochs.
string NeuralApproximatorType [get]
 Gets string representation of type of the current object. This is used e.g. in deserialization in order to prevent that wrong type of internal representation would be read in.
string NetworkStateFilePath [get]
 Path where the curren network state has been saved, or null if the current state has not been saved yet. The SaveFile methods takes care that the file path is stored when network state is saved. InvalidateTrainingDependencies() takes care that this file path is set to null if network state has changed after last save.
string NetworkStateRelativePath [get, set]
 Relative path where the curren network state has been saved. Auxiliary property used in deserialization. When the whole Neural network approximator is saved to a file, tis path is updated in such a way that it points to the fiele where the network state has been saved, but relative to the path where the whole approximator is saved. This enables restore of the saved network state at a later time, even if the containing directory has moved within the file system or has even been copied to another system.
SampledDataSet TrainingData [get, set]
 Gets or sets the training data.
IndexList VerificationIndices [get, set]
 Gets or sets indices of training data elements that are used for verification of how precise appeoximation is. These elements are excluded from training of neural network.
IBoundingBox InputDataBounds [get, set]
 Bounds on input data, used for scaling from actual input to input used by neural network. Scaling is performed because of the bound codomain and image of activation functions.
IBoundingBox OutputDataBounds [get, set]
 Bounds on output data, used for scaling from actual output to output produced by neural network. Scaling is performed because of the bound codomain and image of activation functions.
double InputBoundsSafetyFactor [get, set]
 Safety factor by which interval lenghts of input data bounds are enlarged after bounds are automatically determined from the range of input data in the training set. Setter re-calculated the input data bounds and therefore invalidates training data dependencies.
double OutputBoundsSafetyFactor [get, set]
 Safety factor by which interval lenghts of output data bounds are enlarged after bounds are automatically determined from the range of output data in the training set. Setter re-calculated the output data bounds and therefore invalidates training data dependencies.
IBoundingBox InputNeuronsRange [get]
 Gets the range in which data should be for input neurons, used for scaling from actual input to input used by neural network. This depends on the activation function.
IBoundingBox OutputNeuronsRange [get]
 Gets the range of the data output from output neurons, used for scaling from actual output to output produced by neural network. This will normally depend on the activation function.
int NumAllTrainingPoints [get]
 Gets number of all training points, including verification points.
int NumTrainingPoints [get]
 Gets number of training points (this excludes verification points).
int NumVerificationPoints [get]
 Gets number of verification points.
bool NetworkTrained [get]
 Whether network has been trained since the training data was set.
bool BreakTraining [get, set]
 Flags that signalizes (if true) that training should be broken on external request.

Detailed Description

Approximator of response by using neural networks. $A Igor Mar11;.


Member Function Documentation

int IG::Neural::INeuralApproximator::GetNumNeuronsInHiddenLayer ( int  whichLayer)

Returns the number of neurons in the specified hidden layer. Hidden layers are those not containing input or output neurons.

Parameters:
whichLayerIndex of the hidden layer for which number of neurons is returned.

Implemented in IG::Neural::NeuralApproximatorBase.

void IG::Neural::INeuralApproximator::SetNumNeuronsInHiddenLayer ( int  whichLayer,
int  numNeurons 
)

Sets the number of neurons in the specified hidden layer. Hidden layers are those not containing input or output neurons.

Parameters:
whichLayerIndex of the hidden layer for which number of neurons is returned.
numNeuronsPrescribed number of neurons in the specified layer.

Implemented in IG::Neural::NeuralApproximatorBase.

void IG::Neural::INeuralApproximator::SetHiddenLayers ( params int[]  numNeurons)

Sets the numbers of neurons in each hidden layer. Can be called with table of integers as argument, kor with variable number of integer parameters. Numbers are set by an array of integers in which each element contains the number of neurons in the corresponding hidden layer (indexed from 0). Hidden layers are those not containing input or output neurons.

Parameters:
numNeuronsArray containing the prescribed numbers of neurons in each hidden layer. Instead of array, a variable number of integer parameters can be specified.

Implemented in IG::Neural::NeuralApproximatorBase.

void IG::Neural::INeuralApproximator::PrepareNetwork ( )

Prepares neural network for use. If networks have not yet been created according to internal data, they are created. If networks are already prepared then this method does nothing.

Some things suc as creation of a neural network follow the pattern of lazy evaluation.

Implemented in IG::Neural::NeuralApproximatorAforge, IG::Neural::NeuralApproximatorBase, and IG::Neural::NeuralApproximatorNeuron.

void IG::Neural::INeuralApproximator::CreateNetwork ( )

Creates the neural network anew. If the network already exists on the current object, it is discarded.

Implemented in IG::Neural::NeuralApproximatorAforge, IG::Neural::NeuralApproximatorBase, and IG::Neural::NeuralApproximatorNeuron.

void IG::Neural::INeuralApproximator::ResetNetwork ( )
void IG::Neural::INeuralApproximator::DestroyNetwork ( )
string IG::Neural::INeuralApproximator::GetNetworkFilePath ( string  fileOrDirectoryPath,
int  whichNetwork 
)

Returns an absolute path to the file for storing the specified neural network contained on the current object, with respect to suggested file path and index of the network. The returned path is in the same directory as suggested file path and has the same file extension (if any). If the suggested path represents a directory, then some default suggested path is assumed. If there is only one network then the returned file path is the same as the suggested one (or the same as default file name within the suggested directory, if a directory path is proposed).

Parameters:
fileOrDirectoryPathSuggested file or directory path, can be a relative path.
whichNetworkIndex of the network for which path of the file to store the network is returned.
Returns:

Implemented in IG::Neural::NeuralApproximatorBase.

void IG::Neural::INeuralApproximator::SaveNetwork ( string  filePath)

Saves the state of the neural network to the specified file. If the file already exists, its contents are overwritten.

Parameters:
filePathPath to the file into which the network is saved.

Implemented in IG::Neural::NeuralApproximatorBase.

void IG::Neural::INeuralApproximator::LoadNetwork ( string  filePath)

Restores neural network from a file where it has been stored before.

Parameters:
filePathPath to the file from which the neural network is read.

Implemented in IG::Neural::NeuralApproximatorBase.

void IG::Neural::INeuralApproximator::SaveTrainingDataJson ( string  filePath)

Saves network's training data to the specified JSON file. File is owerwritten if it exists.

Parameters:
filePathPath to the file where training data is saved.

Implemented in IG::Neural::NeuralApproximatorBase.

void IG::Neural::INeuralApproximator::LoadTrainingDataJson ( string  filePath)

Restores training data from the specified file in JSON format.

Parameters:
filePathFile from which training data is restored.

Implemented in IG::Neural::NeuralApproximatorBase.

void IG::Neural::INeuralApproximator::SetNeuronsInputRange ( double  min,
double  max 
)

Sets the neurons input range. Bounds for all input neurons are set equally.

Parameters:
minLower bound for all input neurons.
maxUpper bound for all input neurons.

Implemented in IG::Neural::NeuralApproximatorBase.

void IG::Neural::INeuralApproximator::SetNeuronsOutputRange ( double  min,
double  max 
)

Sets the neurons output range. Bounds for all output neurons are set equally.

Parameters:
minLower bound for all output neurons.
maxUpper bound for all output neurons.

Implemented in IG::Neural::NeuralApproximatorBase.

void IG::Neural::INeuralApproximator::RecalculateInputDataBounds ( )

Recalculates input data bounds by taking into account the training data set of the current object.

Training data dependencies are invalidated by this method because setting bounds invalidates them.

Implemented in IG::Neural::NeuralApproximatorBase.

void IG::Neural::INeuralApproximator::RecalculateOutputDataBounds ( )

Recalculates output data bounds by taking into account the training data set of the current object.

Training data dependencies are invalidated by this method because setting bounds invalidates them.

Implemented in IG::Neural::NeuralApproximatorBase.

void IG::Neural::INeuralApproximator::RecalculateDataBounds ( )

Recalculates input and output data bounds by taking into account the training data set of the current object.

Training data dependencies are invalidated by this method because setting bounds invalidates them.

Implemented in IG::Neural::NeuralApproximatorBase.

void IG::Neural::INeuralApproximator::RecalculateInputDataBounds ( SampledDataSet  trainingData)

Recalculates input data bounds by taking into account the specified training data set.

Parameters:
trainingDataTraining data set accourding to which input bounds are adjusted.

Training data dependencies are invalidated by this method because setting bounds invalidates them.

Implemented in IG::Neural::NeuralApproximatorBase.

void IG::Neural::INeuralApproximator::RecalculateOutputDataBounds ( SampledDataSet  trainingData)

Recalculates output data bounds by taking into account the specified training data set.

Parameters:
trainingDataTraining data set accourding to which output bounds are adjusted.

Training data dependencies are invalidated by this method because setting bounds invalidates them.

Implemented in IG::Neural::NeuralApproximatorBase.

void IG::Neural::INeuralApproximator::RecalculateDataBounds ( SampledDataSet  trainingData)

Recalculates input and output data bounds by taking into account the specified training data set.

Parameters:
trainingDataTraining data set accourding to which input and output bounds are adjusted.

Training data dependencies are invalidated by this method because setting bounds invalidates them.

Implemented in IG::Neural::NeuralApproximatorBase.

void IG::Neural::INeuralApproximator::GetErrorsTrainingRms ( ref IVector  errors)

Calculates the RMS (root mean square) of the errors of output values for the training elements of the training set (this excludes verification points).

Parameters:
errors

Implemented in IG::Neural::NeuralApproximatorBase.

void IG::Neural::INeuralApproximator::GetErrorsVerificationRms ( ref IVector  errors)

Calculates the RMS (root mean square) of the errors of output values for the verification elements of the training set.

Parameters:
errors

Implemented in IG::Neural::NeuralApproximatorBase.

void IG::Neural::INeuralApproximator::GetErrorsTrainingMax ( ref IVector  errors)

Calculates the maximum absolute errors of output values for the training elements of the training set (this excludes verification points).

Parameters:
errors

Implemented in IG::Neural::NeuralApproximatorBase.

void IG::Neural::INeuralApproximator::GetErrorsVerificationMax ( ref IVector  errors)

Calculates the maximum absolute errors of output values for the verification elements of the training set.

Parameters:
errors

Implemented in IG::Neural::NeuralApproximatorBase.

void IG::Neural::INeuralApproximator::GetErrorsTrainingMeanAbs ( ref IVector  errors)

Calculates the mean absolute errors of output values for the training elements of the training set (this excludes verification points).

Parameters:
errors

Implemented in IG::Neural::NeuralApproximatorBase.

void IG::Neural::INeuralApproximator::GetErrorsVerificationMeanAbs ( ref IVector  errors)

Calculates the mean absolute errors of output values for the verification elements of the training set.

Parameters:
errors

Implemented in IG::Neural::NeuralApproximatorBase.

void IG::Neural::INeuralApproximator::InvalidateTrainingDependencies ( )

Invalidates all data that must be recalculated after training of the network is done. This method is called after training or additional training of the network is performed. Invalidation is achieved throughthe the appropriate flags.

Implemented in IG::Neural::NeuralApproximatorBase.

void IG::Neural::INeuralApproximator::InvalidateTrainingDataDependencies ( )

Invalidates all data that must be re-calculated after training data changes. This method is called after training data is modified. Invalidation is achieved throughthe the appropriate flags.

Implemented in IG::Neural::NeuralApproximatorBase.

void IG::Neural::INeuralApproximator::InvalidateNetworkDependencies ( )

Invalidates all data that must be re-calculated after the neural network itself changes. This method must be called after the internal neural network is re-defined (or are re-defined). Invalidation is achieved throughthe the appropriate flags.

Implemented in IG::Neural::NeuralApproximatorBase.

void IG::Neural::INeuralApproximator::TrainNetwork ( int  numEpochs)

Trains neural network wiht the specified data, performing the specified number of epochs.

Parameters:
numEpochsNumber of epochs used in training of the network.

Implemented in IG::Neural::NeuralApproximatorBase.

void IG::Neural::INeuralApproximator::TrainNetwork ( )

Trains neural network until stopping criteria are met (in terms of errors and number of epochs performed.

Implemented in IG::Neural::NeuralApproximatorBase.

bool IG::Neural::INeuralApproximator::StopTrainingCriteriaMet ( )

Returns true if the stopping criteria for training is met, with respect to current settings, errors and number of epochs already performed, and false otherwise.

Implemented in IG::Neural::NeuralApproximatorBase.

void IG::Neural::INeuralApproximator::CalculateOutput ( IVector  input,
ref IVector  output 
)

Calculates and returns the approximated outputs corresponding to the specified inputs, by using the current neural network.

Parameters:
inputInput parameters.
Returns:
Vector of output values generated by the trained neural network.

Currently, only all outputs at once can be calculated. This makes no difference in the arrangement with a single network with multiple outputs, but does when several networks with single output each are used. If the implementation changes in the future then performance configuratins should be taken into account carefully, and tracking input for which input parameters the outputs have been calculated might be necessary.

Implemented in IG::Neural::NeuralApproximatorAforge, IG::Neural::NeuralApproximatorBase, and IG::Neural::NeuralApproximatorNeuron.

double IG::Neural::INeuralApproximator::CalculateOutput ( IVector  input,
int  whichElement 
)

Calculates and returns the specified output by using the neural network.

Implemented in IG::Neural::NeuralApproximatorBase.

void IG::Neural::INeuralApproximator::CalculateOutput ( IVector  input,
int[]  indices,
ref IVector  filteredOutput 
)

Calculates and returns the required output values corresponding to the specified inputs, by using the current neural network(s).

Parameters:
inputInput parameters for which output values are calculated.
indicesArray of indices of the output values to be returned.
filteredOutputVector where filtered output values are stored.

Implemented in IG::Neural::NeuralApproximatorBase.


Property Documentation

int IG::Neural::INeuralApproximator::OutputLevel [get, set]

Level of output printed to console when performing actions.

Implemented in IG::Neural::NeuralApproximatorBase.

bool IG::Neural::INeuralApproximator::MultipleNetworks [get, set]

Flag indicating whether multiple neural networks are used to approximate multiple outputs (one network for each output)

Implemented in IG::Neural::NeuralApproximatorBase.

int IG::Neural::INeuralApproximator::InputLength [get, set]

Gets or sets the number of input neurons.

Implemented in IG::Neural::NeuralApproximatorBase.

int IG::Neural::INeuralApproximator::OutputLength [get, set]

Gets or sets the number of output neurons.

Implemented in IG::Neural::NeuralApproximatorBase.

int [] IG::Neural::INeuralApproximator::NumHiddenNeurons [get, set]

Sets the numbers of neurons in each hidden layer. Numbers are set by an array of integers in which each element contains the number of neurons in the corresponding hidden layer (indexed from 0). Hidden layers are those not containing input or output neurons.

Getter is protected cecause we don't want users of the class to set number of neurons in individual layers.

Implemented in IG::Neural::NeuralApproximatorBase.

int IG::Neural::INeuralApproximator::NumHiddenLayers [get, set]

Gets or sets the number of hidden layers of the neural network (these are layers that don't contain input or output neurons).

Implemented in IG::Neural::NeuralApproximatorBase.

bool IG::Neural::INeuralApproximator::NetworkPrepared [get]

Gets a flag telling whether the network is prepared for operation (training and calculation of output).

Implemented in IG::Neural::NeuralApproximatorBase.

double IG::Neural::INeuralApproximator::SigmoidAlphaValue [get, set]

Alpha value specifying the shape of the activation function.

Implemented in IG::Neural::NeuralApproximatorBase.

double IG::Neural::INeuralApproximator::LearningRate [get, set]

Gets or sets learning rate.

Implemented in IG::Neural::NeuralApproximatorBase.

double IG::Neural::INeuralApproximator::Momentum [get, set]

Gets or sets momentum.

Implemented in IG::Neural::NeuralApproximatorBase.

int IG::Neural::INeuralApproximator::EpochCount [get]

Number of learning epochs performed up to the current moment.

Implemented in IG::Neural::NeuralApproximatorBase.

int IG::Neural::INeuralApproximator::MaxEpochs [get, set]

Maximal number of epochs in training.

Implemented in IG::Neural::NeuralApproximatorBase.

int IG::Neural::INeuralApproximator::EpochsInBundle [get, set]

Number of epochs in a single training bundle. This number of epochs is performed at once when training, without checking convergence criteria between. Larger value means slightly more efficient training (because of less checks) but rougher criteria checks.

Implemented in IG::Neural::NeuralApproximatorBase.

IVector IG::Neural::INeuralApproximator::ToleranceRms [get, set]

Tolerance over RMS error of output over training points. Training will continue until error becomes below tolerance or until maximal number of epochs is reached. If less or equal than 0 then this tolerance is not taken into account.

Implemented in IG::Neural::NeuralApproximatorBase.

IVector IG::Neural::INeuralApproximator::ToleranceMax [get, set]

Tolerance on maximal error of output over training points. Training will continue until error becomes below tolerance or until maximal number of epochs is reached. If less or equal than 0 then this tolerance is not taken into account.

Implemented in IG::Neural::NeuralApproximatorBase.

IVector IG::Neural::INeuralApproximator::ToleranceRmsRelativeToRange [get, set]

Relative tolerances on RMS errors of outputs over training points, relative to the correspoinding ranges of output data.

When this vector is set to a non-null value, elements of RMS tolerances vector (property ToleranceRms) are set to the specified fractions of the ranges of the corresponding output values in training parameters (defined by the property OutputDataBounds) if these are defined (otherwise this may happen when the property gets defined).

Whenever this property is defined, re-setting the property OutputDataBounds will cause recalculation of ToleranceRms according to elements of this property and the ranges of corresponding output values.

Setting this property undefines the ToleranceRmsRelativeToRangeScalar property, even if it is set to null.

If the scalar relative tolerance is set (property ToleranceRmsRelativeToRangeScalar) and this property is not set yet, the getter of this property will evaluate to a vector whose elements are equal to the scalar relative tolerance.

Implemented in IG::Neural::NeuralApproximatorBase.

double IG::Neural::INeuralApproximator::ToleranceRmsRelativeToRangeScalar [get, set]

Scalar through which all components of the Relative tolerances on RMS errors of outputs can be set to the same value.

Getter returns a value greater than 0 only if the property has been previously set.

Setting a vector of relative tolerances (property ToleranceRmsRelativeToRange) sets this property to 0, even it it is set to null.

Setting the property to a value greater than 0 automatically sets the vector of relative tolerances (property ToleranceRmsRelativeToRange) in such a way that all elements are equal to this property.

Implemented in IG::Neural::NeuralApproximatorBase.

IVector IG::Neural::INeuralApproximator::ToleranceMaxRelativeToRange [get, set]

Relative tolerances on max. abs. errors of outputs over training points, relative to the correspoinding ranges of output data.

When this vector is set to a non-null value, elements of max. abs. tolerances vector (property ToleranceMax) are set to the specified fractions of the ranges of the corresponding output values in training parameters (defined by the property OutputDataBounds) if these are defined (otherwise this may happen when the property gets defined).

Whenever this property is defined, re-setting the property OutputDataBounds will cause recalculation of ToleranceMax according to elements of this property and the ranges of corresponding output values.

Setting this property undefines the ToleranceMaxRelativeToRangeScalar property, even if it is set to null.

If the scalar relative tolerance is set (property ToleranceMaxRelativeToRangeScalar) and this property is not set yet, the getter of this property will evaluate to a vector whose elements are equal to the scalar relative tolerance.

Implemented in IG::Neural::NeuralApproximatorBase.

double IG::Neural::INeuralApproximator::ToleranceMaxRelativeToRangeScalar [get, set]

Scalar through which all components of the Relative tolerances on max. abs. errors of outputs can be set to the same value.

Getter returns a value greater than 0 only if the property has been previously set.

Setting a vector of relative tolerances (property ToleranceMaxRelativeToRange) sets this property to 0, even it it is set to null.

Setting the property to a value greater than 0 automatically sets the vector of relative tolerances (property ToleranceMaxRelativeToRange) in such a way that all elements are equal to this property.

Implemented in IG::Neural::NeuralApproximatorBase.

bool IG::Neural::INeuralApproximator::SaveConvergenceRms [get, set]

Flag to enable Rms error convergence colection. Default is false.

Implemented in IG::Neural::NeuralApproximatorBase.

List<int> IG::Neural::INeuralApproximator::EpochNumbers [get, set]

List of epoch numbers at which convergence data was sampled. Saved after every set of epochs.

$A Tako78 Sep12;

Implemented in IG::Neural::NeuralApproximatorBase.

List<IVector> IG::Neural::INeuralApproximator::ConvergenceErrorsTrainingRmsList [get, set]

Convergence List of Rms errors calculated on training data. Saved after every set of epochs.

Implemented in IG::Neural::NeuralApproximatorBase.

List<IVector> IG::Neural::INeuralApproximator::ConvergenceErrorsTrainingMaxList [get, set]

Convergence List of Maximum errors calculated on training data. Saved after every set of epochs.

Implemented in IG::Neural::NeuralApproximatorBase.

List<IVector> IG::Neural::INeuralApproximator::ConvergenceErrorsVerificationRmsList [get, set]

Convergence List of Rms errors calculated on verification data. Saved after every set of epochs.

Implemented in IG::Neural::NeuralApproximatorBase.

List<IVector> IG::Neural::INeuralApproximator::ConvergenceErrorsVerificationMaxList [get, set]

Convergence List of Maximum errors calculated on verification data. Saved after every set of epochs.

Implemented in IG::Neural::NeuralApproximatorBase.

string IG::Neural::INeuralApproximator::NeuralApproximatorType [get]

Gets string representation of type of the current object. This is used e.g. in deserialization in order to prevent that wrong type of internal representation would be read in.

Implemented in IG::Neural::NeuralApproximatorBase.

string IG::Neural::INeuralApproximator::NetworkStateFilePath [get]

Path where the curren network state has been saved, or null if the current state has not been saved yet. The SaveFile methods takes care that the file path is stored when network state is saved. InvalidateTrainingDependencies() takes care that this file path is set to null if network state has changed after last save.

Implemented in IG::Neural::NeuralApproximatorBase.

string IG::Neural::INeuralApproximator::NetworkStateRelativePath [get, set]

Relative path where the curren network state has been saved. Auxiliary property used in deserialization. When the whole Neural network approximator is saved to a file, tis path is updated in such a way that it points to the fiele where the network state has been saved, but relative to the path where the whole approximator is saved. This enables restore of the saved network state at a later time, even if the containing directory has moved within the file system or has even been copied to another system.

Implemented in IG::Neural::NeuralApproximatorBase.

SampledDataSet IG::Neural::INeuralApproximator::TrainingData [get, set]

Gets or sets the training data.

Implemented in IG::Neural::NeuralApproximatorBase.

IndexList IG::Neural::INeuralApproximator::VerificationIndices [get, set]

Gets or sets indices of training data elements that are used for verification of how precise appeoximation is. These elements are excluded from training of neural network.

Object of type IndexList that contains indices of elements used for verification, always contains a sorted list of unique indices.

Implemented in IG::Neural::NeuralApproximatorBase.

IBoundingBox IG::Neural::INeuralApproximator::InputDataBounds [get, set]

Bounds on input data, used for scaling from actual input to input used by neural network. Scaling is performed because of the bound codomain and image of activation functions.

Implemented in IG::Neural::NeuralApproximatorBase.

IBoundingBox IG::Neural::INeuralApproximator::OutputDataBounds [get, set]

Bounds on output data, used for scaling from actual output to output produced by neural network. Scaling is performed because of the bound codomain and image of activation functions.

Implemented in IG::Neural::NeuralApproximatorBase.

double IG::Neural::INeuralApproximator::InputBoundsSafetyFactor [get, set]

Safety factor by which interval lenghts of input data bounds are enlarged after bounds are automatically determined from the range of input data in the training set. Setter re-calculated the input data bounds and therefore invalidates training data dependencies.

Implemented in IG::Neural::NeuralApproximatorBase.

double IG::Neural::INeuralApproximator::OutputBoundsSafetyFactor [get, set]

Safety factor by which interval lenghts of output data bounds are enlarged after bounds are automatically determined from the range of output data in the training set. Setter re-calculated the output data bounds and therefore invalidates training data dependencies.

Implemented in IG::Neural::NeuralApproximatorBase.

IBoundingBox IG::Neural::INeuralApproximator::InputNeuronsRange [get]

Gets the range in which data should be for input neurons, used for scaling from actual input to input used by neural network. This depends on the activation function.

Setter is not public.

Implemented in IG::Neural::NeuralApproximatorBase.

IBoundingBox IG::Neural::INeuralApproximator::OutputNeuronsRange [get]

Gets the range of the data output from output neurons, used for scaling from actual output to output produced by neural network. This will normally depend on the activation function.

Setter is not public.

Implemented in IG::Neural::NeuralApproximatorBase.

int IG::Neural::INeuralApproximator::NumAllTrainingPoints [get]

Gets number of all training points, including verification points.

Implemented in IG::Neural::NeuralApproximatorBase.

int IG::Neural::INeuralApproximator::NumTrainingPoints [get]

Gets number of training points (this excludes verification points).

Implemented in IG::Neural::NeuralApproximatorBase.

int IG::Neural::INeuralApproximator::NumVerificationPoints [get]

Gets number of verification points.

Implemented in IG::Neural::NeuralApproximatorBase.

bool IG::Neural::INeuralApproximator::NetworkTrained [get]

Whether network has been trained since the training data was set.

Implemented in IG::Neural::NeuralApproximatorBase.

bool IG::Neural::INeuralApproximator::BreakTraining [get, set]

Flags that signalizes (if true) that training should be broken on external request.

Implemented in IG::Neural::NeuralApproximatorBase.


The documentation for this interface was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties