keel.Algorithms.Neural_Networks.NNEP_Clas.listener

Class NeuralNetReporterClas

java.lang.Object

keel.Algorithms.Neural_Networks.NNEP_Clas.listener.NeuralNetReporterClas

public class NeuralNetReporterClas
extends java.lang.Object

Generation reporter of neural net algorithms

Since:

JDK1.5

Version:

0.1

Author:

Written by Pedro Antonio Gutierrez Penia (University of Cordoba) 16/7/2009, Modified by Aaron Ruiz Mora (University of Cordoba) 16/7/2009

Constructor Summary

Constructors

Constructor and Description
NeuralNetReporterClas() Empty constructor

Method Summary

Modifier and Type	Method and Description
void	algorithmFinished(<any> event) This event is fired when the algorithm has finished its execution.
void	algorithmStarted(<any> event) This event is fired when the algorithm has started its execution.
void	doIterationReport(NeuralNetAlgorithm<NeuralNetIndividual> algorithm) Outputs the information of an iteration to System.out
java.lang.String	getBestModelResultFile() Returns file name where the best model obtained will be written
java.lang.String	getHeader() Returns KEEL file header
IAttribute	getOutputAttribute() Returns output attribute metadata
java.lang.String	getTestResultFile() Returns file name where the testing results of best model obtained will be written
java.lang.String	getTrainResultFile() Returns file name where the training results of best model obtained will be written
void	iterationCompleted(<any> event) This event is fired when the algorithm has finished a generation.
void	printGeneration(int nofgeneration, <any> bestNnind, <any> bestCCRNnind, ParametricMutator<NeuralNetIndividual> parametricMutator, IEvaluator evaluator) Outputs the information of a generation to System.out
protected java.lang.String	renderGeneration(int nofgeneration, <any> bestNnind, <any> bestCCRNnind, ParametricMutator<NeuralNetIndividual> parametricMutator, IEvaluator evaluator) Renders a generation of the algorithm to a String
protected java.lang.String	renderNeuralNetIndividual(<any> nnind, IEvaluator evaluator) Renders a NeuralNetIndividual to a String
void	setBestModelResultFile(java.lang.String bestModelResultFile) Sets file name where the best model obtained will be written
void	setHeader(java.lang.String header) Sets KEEL file header
void	setOutputAttribute(IAttribute outputAttribute) Sets output attribute metadata
void	setTestResultFile(java.lang.String testResultFile) Sets file name where the testing results of best model obtained will be written
void	setTrainResultFile(java.lang.String trainResultFile) Sets file name where the testing results of best model obtained will be written

Methods inherited from class java.lang.Object

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

Constructor Detail

NeuralNetReporterClas

public NeuralNetReporterClas()

Empty constructor

Method Detail

algorithmStarted

public void algorithmStarted(<any> event)

This event is fired when the algorithm has started its execution.

Parameters:

event - An event containing a reference to the source algorithm.

algorithmFinished

public void algorithmFinished(<any> event)

This event is fired when the algorithm has finished its execution.

Parameters:

event - An event containing a reference to the source algorithm.

iterationCompleted

public void iterationCompleted(<any> event)

This event is fired when the algorithm has finished a generation.

Parameters:

event - An event containing a reference to the source algorithm.

getBestModelResultFile

public java.lang.String getBestModelResultFile()

Returns file name where the best model obtained will be written

Returns:

String File name

setBestModelResultFile

public void setBestModelResultFile(java.lang.String bestModelResultFile)

Sets file name where the best model obtained will be written

Parameters:

bestModelResultFile - File name

getTestResultFile

public java.lang.String getTestResultFile()

Returns file name where the testing results of best model obtained will be written

Returns:

String File name

setTestResultFile

public void setTestResultFile(java.lang.String testResultFile)

Sets file name where the testing results of best model obtained will be written

Parameters:

testResultFile - File name

getTrainResultFile

public java.lang.String getTrainResultFile()

Returns file name where the training results of best model obtained will be written

Returns:

String File name

setTrainResultFile

public void setTrainResultFile(java.lang.String trainResultFile)

Sets file name where the testing results of best model obtained will be written

Parameters:

trainResultFile - File name

getHeader

public java.lang.String getHeader()

Returns KEEL file header

Returns:

String KEEL file header

setHeader

public void setHeader(java.lang.String header)

Sets KEEL file header

Parameters:

header - KEEL file header

getOutputAttribute

public IAttribute getOutputAttribute()

Returns output attribute metadata

Returns:

IAttribute Output attribute metadata

setOutputAttribute

public void setOutputAttribute(IAttribute outputAttribute)

Sets output attribute metadata

Parameters:

outputAttribute - New output attribute metadata

doIterationReport

public void doIterationReport(NeuralNetAlgorithm<NeuralNetIndividual> algorithm)

Outputs the information of an iteration to System.out

Parameters:

algorithm - Algorithm that is exectuting currently

printGeneration

public void printGeneration(int nofgeneration,
                            <any> bestNnind,
                            <any> bestCCRNnind,
                            ParametricMutator<NeuralNetIndividual> parametricMutator,
                            IEvaluator evaluator)

Outputs the information of a generation to System.out

Parameters:

nofgeneration - Number of generation of the algorithm

bestNnind - Best NeuralNetIndividual of the algorithm

bestCCRNnind - Best CCR NeuralNetIndividual of the algorithm (if it is a Classification problem)

parametricMutator - ParametricMutator of the algorithm

evaluator - NeuralNetEvaluator to use in individual evaluation

renderGeneration

protected java.lang.String renderGeneration(int nofgeneration,
                                            <any> bestNnind,
                                            <any> bestCCRNnind,
                                            ParametricMutator<NeuralNetIndividual> parametricMutator,
                                            IEvaluator evaluator)

Renders a generation of the algorithm to a String

Parameters:

nofgeneration - Number of generation of the algorithm

bestNnind - Best NeuralNetIndividual of the algorithm

bestCCRNnind - Best CCR NeuralNetIndividual of the algorithm (if it is a Classification problem)

parametricMutator - ParametricMutator of the algorithm

evaluator - NeuralNetEvaluator to use in individual evaluation

Returns:

String String with the render of a generation

renderNeuralNetIndividual

protected java.lang.String renderNeuralNetIndividual(<any> nnind,
                                                     IEvaluator evaluator)

Renders a NeuralNetIndividual to a String

Parameters:

nnind - IGenotype(INeuralNet) to render

evaluator - NeuralNetEvaluator to use in individual evaluation

Returns:

String String with the render of a NeuralNetIndividual