com.bbn.bue.common.evaluation

Interface ScoringEventObserver<KeyT,TestT>

public interface ScoringEventObserver<KeyT,TestT>

An object which records scoring events of objects where the expected (gold) item is of type KeyT and the predicted (system) item is of type TestT. finish(File) is expected to be called when there are no more items to inspect. What happens if more items are observed after finishing is not defined by the interface contract. Implementations may silently take no action for some types of observations. For example, an F-score related observer would take no action upon observation of a true negative. However, an implementation should not raise an exception simply because it is asked to observe an event for which it will take no action.

Author:

Constantine Lignos

Method Summary

Methods

Modifier and Type	Method and Description
void	finish(File outputDirectory) Performs any final tasks, using the specified output directory as the base for output.
void	observeFalseNegative(KeyT gold, double score) Records a false negative event.
void	observeFalsePositive(TestT predicted, double score) Records a false positive event.
void	observeTrueNegative(KeyT gold, TestT predicted, double score) Records a true negative event.
void	observeTruePositive(KeyT gold, TestT predicted, double score) Records a true positive event.

Method Detail

observeTruePositive

void observeTruePositive(KeyT gold,
                       TestT predicted,
                       double score)

Records a true positive event.

observeTrueNegative

void observeTrueNegative(KeyT gold,
                       TestT predicted,
                       double score)

Records a true negative event.

observeFalsePositive

void observeFalsePositive(TestT predicted,
                        double score)

Records a false positive event.

observeFalseNegative

void observeFalseNegative(KeyT gold,
                        double score)

Records a false negative event.

finish

void finish(File outputDirectory)
            throws IOException

Performs any final tasks, using the specified output directory as the base for output.

Throws:

IOException