com.bbn.bue.common.evaluation

Class TypeConfusionInspector<LeftRightT>

java.lang.Object

com.bbn.bue.common.evaluation.TypeConfusionInspector<LeftRightT>

Type Parameters:

LeftRightT - the type of both left and right items in the alignment

All Implemented Interfaces:

Finishable, Inspector<Alignment<? extends LeftRightT,? extends LeftRightT>>

@Beta
public final class TypeConfusionInspector<LeftRightT>
extends Object
implements Inspector<Alignment<? extends LeftRightT,? extends LeftRightT>>

Observes an Alignment between system items on the left and gold standard items on the right and creates a confusion matrix between them based on a specified confusion equivalence and labelling. To create the confusion matrix, the caller must specify:

1. A confusion labeler, which is a Function mapping each observation to its row/column in the confusion matrix. For example, in part of speech tagging, it would return the part of speech tag itself.
2. A confusion equivalence, which is an Equivalence that declares two observations to be equal if they are equal in every relevant way except for the value that would be returned by the confusion labeler. For example, in part of speech tagging, that equivalence should return true if two observations refer to the same token in the same document, regardless of whether the tags assigned to that token match.

Method Summary

Methods

Modifier and Type	Method and Description
static <LeftRightT> TypeConfusionInspector<LeftRightT>	createOutputtingTo(String name, com.google.common.base.Function<? super LeftRightT,String> confusionLabeler, com.google.common.base.Equivalence<LeftRightT> confusionEquivalence, File outputDir) Creates a new inspector.
void	finish()
void	inspect(Alignment<? extends LeftRightT,? extends LeftRightT> alignment)

Methods inherited from class java.lang.Object

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

Method Detail

createOutputtingTo

public static <LeftRightT> TypeConfusionInspector<LeftRightT> createOutputtingTo(String name,
                                                                 com.google.common.base.Function<? super LeftRightT,String> confusionLabeler,
                                                                 com.google.common.base.Equivalence<LeftRightT> confusionEquivalence,
                                                                 File outputDir)

Creates a new inspector. See class documentation for an explanation of the confusion labeler and confusion equivalence.

Type Parameters:

LeftRightT - the type of both left and right items in the alignment

Parameters:

name - a name to be used as a prefix for file output

confusionLabeler - a function for mapping an observation to its label in the confusion matrix

confusionEquivalence - an equivalence between observations that are considered confusable

outputDir - directory for writing output

Returns:

a new inspector

finish

public void finish()
            throws IOException

Specified by:

finish in interface Finishable

Throws:

IOException

inspect

public void inspect(Alignment<? extends LeftRightT,? extends LeftRightT> alignment)

Specified by:

inspect in interface Inspector<Alignment<? extends LeftRightT,? extends LeftRightT>>