gov.sandia.cognition.learning.performance
Class AbstractSupervisedPerformanceEvaluator<InputType,TargetType,EstimateType,ResultType>

java.lang.Object
  extended by gov.sandia.cognition.util.AbstractCloneableSerializable
      extended by gov.sandia.cognition.learning.performance.AbstractSupervisedPerformanceEvaluator<InputType,TargetType,EstimateType,ResultType>
Type Parameters:
InputType - The input type to evaluate.
TargetType - The type of the ground-truth targets (the labels).
EstimateType - The type of estimate to evaluate.
ResultType - The output type of the performance evalautor.
All Implemented Interfaces:
PerformanceEvaluator<Evaluator<? super InputType,? extends EstimateType>,Collection<? extends InputOutputPair<InputType,TargetType>>,ResultType>, SupervisedPerformanceEvaluator<InputType,TargetType,EstimateType,ResultType>, CloneableSerializable, Summarizer<TargetEstimatePair<? extends TargetType,? extends EstimateType>,ResultType>, Serializable, Cloneable
Direct Known Subclasses:
AbstractSupervisedCostFunction, ConfusionMatrixPerformanceEvaluator, DefaultBinaryConfusionMatrix.PerformanceEvaluator, MeanAbsoluteErrorEvaluator, MeanSquaredErrorEvaluator, RootMeanSquaredErrorEvaluator

public abstract class AbstractSupervisedPerformanceEvaluator<InputType,TargetType,EstimateType,ResultType>
extends AbstractCloneableSerializable
implements SupervisedPerformanceEvaluator<InputType,TargetType,EstimateType,ResultType>, Summarizer<TargetEstimatePair<? extends TargetType,? extends EstimateType>,ResultType>

The AbstractSupervisedPerformanceEvaluator class contains an abstract implementation of the SupervisedPerformanceEvaluator class. It does the conversion of a dataset of input-target pairs to a set of target-estimate pairs given the estimate returned by the evaluator whose performance is being assessed.

Since:
2.0
Author:
Justin Basilico
See Also:
Serialized Form

Constructor Summary
AbstractSupervisedPerformanceEvaluator()
          Creates a new AbstractSupervisedPerformanceEvaluator.
 
Method Summary
abstract  ResultType evaluatePerformance(Collection<? extends TargetEstimatePair<? extends TargetType,? extends EstimateType>> data)
          Evaluates the performance accuracy of the given estimates against the given targets.
 ResultType evaluatePerformance(Evaluator<? super InputType,? extends EstimateType> evaluator, Collection<? extends InputOutputPair<InputType,TargetType>> data)
          Evaluates the performance accuracy of the given estimates against the given targets.
 ResultType summarize(Collection<? extends TargetEstimatePair<? extends TargetType,? extends EstimateType>> data)
          Creates a summary of the given collection of data.
 
Methods inherited from class gov.sandia.cognition.util.AbstractCloneableSerializable
clone
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface gov.sandia.cognition.util.CloneableSerializable
clone
 

Constructor Detail

AbstractSupervisedPerformanceEvaluator

public AbstractSupervisedPerformanceEvaluator()
Creates a new AbstractSupervisedPerformanceEvaluator.

Method Detail

evaluatePerformance

public ResultType evaluatePerformance(Evaluator<? super InputType,? extends EstimateType> evaluator,
                                      Collection<? extends InputOutputPair<InputType,TargetType>> data)
Evaluates the performance accuracy of the given estimates against the given targets.

Specified by:
evaluatePerformance in interface PerformanceEvaluator<Evaluator<? super InputType,? extends EstimateType>,Collection<? extends InputOutputPair<InputType,TargetType>>,ResultType>
Parameters:
evaluator - Evaluator to generate estimates
data - The target-estimate pairs to use to evaluate performance.
Returns:
The performance evaluation result.

summarize

public ResultType summarize(Collection<? extends TargetEstimatePair<? extends TargetType,? extends EstimateType>> data)
Description copied from interface: Summarizer
Creates a summary of the given collection of data.

Specified by:
summarize in interface Summarizer<TargetEstimatePair<? extends TargetType,? extends EstimateType>,ResultType>
Parameters:
data - The collection of data to summarize.
Returns:
The summary of the data.

evaluatePerformance

public abstract ResultType evaluatePerformance(Collection<? extends TargetEstimatePair<? extends TargetType,? extends EstimateType>> data)
Description copied from interface: SupervisedPerformanceEvaluator
Evaluates the performance accuracy of the given estimates against the given targets.

Specified by:
evaluatePerformance in interface SupervisedPerformanceEvaluator<InputType,TargetType,EstimateType,ResultType>
Parameters:
data - The target-estimate pairs to use to evaluate performance.
Returns:
The performance evaluation result.