weka.classifiers.timeseries.eval

Class ErrorModule

java.lang.Object

weka.classifiers.timeseries.eval.TSEvalModule

weka.classifiers.timeseries.eval.ErrorModule

Direct Known Subclasses:

DACModule, MAEModule, MAPEModule, MSEModule, RAEModule, RRSEModule

public class ErrorModule
extends TSEvalModule

Superclass of error-based evaluation modules. Stores the predictions for each target along with the actual values. Computes the sum of errors for each target.

Version:

$Revision: 45163 $

Author:

Mark Hall (mhall{[at]}pentaho{[dot]}com)

Constructor Summary

Constructors

Constructor and Description
ErrorModule()

Method Summary

Methods

Modifier and Type	Method and Description
double[]	calculateMeasure() Calculate the measure that this module represents.
double[]	countsForTargets() Gets the number of predicted, actual pairs for each target.
void	evaluateForInstance(List<weka.classifiers.evaluation.NumericPrediction> forecasts, weka.core.Instance inst) Evaluate the given forecast(s) with respect to the given test instance.
String	getDefinition() Return the mathematical formula that this evaluation module computes.
String	getDescription() Return the longer (single sentence) description of this evaluation module
List<Double>	getErrorsForTarget(String targetName) Get a list of the errors for the supplied target
String	getEvalName() Return the short identifying name of this evaluation module
List<List<weka.classifiers.evaluation.NumericPrediction>>	getPredictionsForAllTargets() Gets the predictions for all targets
List<weka.classifiers.evaluation.NumericPrediction>	getPredictionsForTarget(String targetName) Get a list of predictions (plus actuals if known) for the supplied target
void	reset() Reset this module
String	toString() Gets a textual description of this module : getDescription() + getEvalName()
String	toSummaryString() Return the summary description of the computed measure for each target.

Methods inherited from class weka.classifiers.timeseries.eval.TSEvalModule

getModule, getModuleList, getTargetFields, setTargetFields

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ErrorModule

public ErrorModule()

Method Detail

reset

public void reset()

Reset this module

Specified by:

reset in class TSEvalModule

getEvalName

public String getEvalName()

Return the short identifying name of this evaluation module

Specified by:

getEvalName in class TSEvalModule

Returns:

the short identifying name of this evaluation module

getDescription

public String getDescription()

Return the longer (single sentence) description of this evaluation module

Specified by:

getDescription in class TSEvalModule

Returns:

the longer description of this module

getDefinition

public String getDefinition()

Return the mathematical formula that this evaluation module computes.

Specified by:

getDefinition in class TSEvalModule

Returns:

the mathematical formula that this module computes.

toString

public String toString()

Gets a textual description of this module : getDescription() + getEvalName()

Overrides:

toString in class Object

evaluateForInstance

public void evaluateForInstance(List<weka.classifiers.evaluation.NumericPrediction> forecasts,
                       weka.core.Instance inst)
                         throws Exception

Evaluate the given forecast(s) with respect to the given test instance. Targets with missing values are ignored.

Specified by:

evaluateForInstance in class TSEvalModule

Parameters:

forecasts - a List of forecasted values. Each element corresponds to one of the targets and is assumed to be in the same order as the list of targets supplied to the setTargetFields() method.

Throws:

Exception - if the evaluation can't be completed for some reason.

calculateMeasure

public double[] calculateMeasure()
                          throws Exception

Calculate the measure that this module represents.

Specified by:

calculateMeasure in class TSEvalModule

Returns:

the value of the measure for this module for each of the target(s).

Throws:

Exception - if the measure can't be computed for some reason.

countsForTargets

public double[] countsForTargets()
                          throws Exception

Gets the number of predicted, actual pairs for each target. Only entries that are non-missing for both actual and predicted contribute to the overall count.

Returns:

the number of predicted, actual pairs for each target.

Throws:

Exception

getErrorsForTarget

public List<Double> getErrorsForTarget(String targetName)
                                throws IllegalArgumentException

Get a list of the errors for the supplied target

Parameters:

targetName - the target to get the errors for

Returns:

the errors as a list of Double

Throws:

IllegalArgumentException - if the target name is unknown

getPredictionsForTarget

public List<weka.classifiers.evaluation.NumericPrediction> getPredictionsForTarget(String targetName)
                                                                            throws IllegalArgumentException

Get a list of predictions (plus actuals if known) for the supplied target

Parameters:

targetName - the target to get predictions for

Returns:

a list of predictions for the supplied target

Throws:

IllegalArgumentException - if the target name is unknown

getPredictionsForAllTargets

public List<List<weka.classifiers.evaluation.NumericPrediction>> getPredictionsForAllTargets()

Gets the predictions for all targets

Returns:

the predictions for all targets as a list of lists the outer list indexes targets.

toSummaryString

public String toSummaryString()
                       throws Exception

Description copied from class: TSEvalModule

Return the summary description of the computed measure for each target.

Specified by:

toSummaryString in class TSEvalModule

Returns:

the summary string description of the computed measure.

Throws:

Exception - if the measure can't be computed for some reason.