edu.mit.jmwe.harness.result
Interface IOverallResult<T extends IToken,S extends IMarkedSentence<T>>

Type Parameters:
T - the type of tokens in the sentence
S - the type of sentence the harness runs over. Is parameterized by tokens of type T.
All Superinterfaces:
IBaseResult
All Known Implementing Classes:
MWEResult

public interface IOverallResult<T extends IToken,S extends IMarkedSentence<T>>
extends IBaseResult

Contains results collected from running a test harness over a group of IMarkedSentence objects. Contains overall precision and recall scores as well as detailed results, an ISentenceResult, for each unit the harness runs over. The results are organized by part of speech.

Since:
jMWE 1.0.0
Version:
$Id: IOverallResult.java 614 2011-05-06 23:44:50Z markaf $
Author:
M.A. Finlayson, N. Kulkarni

Method Summary
 Map<MWEPOS,Integer> getAnswerData()
          Returns a map that stores the number of answer multi-word expressions for each part of speech.
 Map<MWEPOS,Integer> getCorrectData()
          Returns a map that stores the number of multi-word expressions correctly found by the detector for each part of speech.
 Map<String,ISentenceResult<T,S>> getDetails()
          Returns a map that stores the results for a unit under its ID.
 Map<MWEPOS,Double> getF1Scores()
          Returns a map that stores the f1 measures of the detector for each part of speech.
 Map<MWEPOS,Integer> getFoundData()
          Returns a map that stores the number of multi-word expressions found by the detector for each part of speech.
 double getPartialF1Score()
          Returns the total F score earned by the detector, taking into account partial credit.
 Map<MWEPOS,Double> getPartialF1Scores()
          Returns a map that stores the f1 measure of the detector for each part of speech after adding the partial credit to its correct score.
 double getPartialPrecision()
          Returns the total precision of the detector after counting partial credit.
 Map<MWEPOS,Double> getPartialPrecisionScores()
          Returns a map that stores the precision of the detector for each part of speech after adding the partial credit to its correct score.
 double getPartialRecall()
          Returns the total recall of the detector after counting partial credit.
 Map<MWEPOS,Double> getPartialRecallScores()
          Returns a map that stores the recall of the detector for each part of speech after adding the partial credit to its correct score.
 double getPartialScore()
          Returns the total partial credit earned by the detector.
 Map<MWEPOS,Double> getPartialScores()
          Returns a map that stores the partial credit for the partially correct multi-word expressions found by the detector for each part of speech.
 Map<MWEPOS,Double> getPrecisionScores()
          Returns a map that stores the precision of the detector for each part of speech.
 Map<MWEPOS,Double> getRecallScores()
          Returns a map that stores the recall of the detector for each part of speech.
 
Methods inherited from interface edu.mit.jmwe.harness.result.IBaseResult
getFScore, getPrecision, getRecall, getTotalAnswers, getTotalCorrect, getTotalFound
 

Method Detail

getDetails

Map<String,ISentenceResult<T,S>> getDetails()
Returns a map that stores the results for a unit under its ID. Should never be null.

Returns:
a map that stores a unit result under its ID.
Since:
jMWE 1.0.0

getAnswerData

Map<MWEPOS,Integer> getAnswerData()
Returns a map that stores the number of answer multi-word expressions for each part of speech. Should never be null.

Returns:
a map that stores the number of answer multi-word expressions for each part of speech.
Since:
jMWE 1.0.0

getFoundData

Map<MWEPOS,Integer> getFoundData()
Returns a map that stores the number of multi-word expressions found by the detector for each part of speech. Should never be null.

Returns:
a map that stores the number of number of multi-word expressions found by the detector for each part of speech.
Since:
jMWE 1.0.0

getCorrectData

Map<MWEPOS,Integer> getCorrectData()
Returns a map that stores the number of multi-word expressions correctly found by the detector for each part of speech. Should never be null.

Returns:
a map that stores the number of number of multi-word expressions correctly found by the detector for each part of speech.
Since:
jMWE 1.0.0

getPartialScores

Map<MWEPOS,Double> getPartialScores()
Returns a map that stores the partial credit for the partially correct multi-word expressions found by the detector for each part of speech. Partial credit should be given when the detector correctly identifies some but not all of the tokens in an expression or if it includes some extra incorrect tokens in the expression. Should never be null.

Returns:
a map that stores the partial credit for the partially correct multi-word expressions found by the detector for each part of speech.
Since:
jMWE 1.0.0

getPrecisionScores

Map<MWEPOS,Double> getPrecisionScores()
Returns a map that stores the precision of the detector for each part of speech. Should never be null.

Returns:
a map that stores the precision the detector for each part of speech.
Since:
jMWE 1.0.0

getF1Scores

Map<MWEPOS,Double> getF1Scores()
Returns a map that stores the f1 measures of the detector for each part of speech. Should never be null.

Returns:
a map that stores the f1 measures the detector for each part of speech.
Since:
jMWE 1.0.0

getRecallScores

Map<MWEPOS,Double> getRecallScores()
Returns a map that stores the recall of the detector for each part of speech. Should never be null.

Returns:
a map that stores the recall the detector for each part of speech.
Since:
jMWE 1.0.0

getPartialPrecisionScores

Map<MWEPOS,Double> getPartialPrecisionScores()
Returns a map that stores the precision of the detector for each part of speech after adding the partial credit to its correct score. Should never be null.

Returns:
a map that stores the precision the detector for each part of speech after counting partial credit.
Since:
jMWE 1.0.0

getPartialRecallScores

Map<MWEPOS,Double> getPartialRecallScores()
Returns a map that stores the recall of the detector for each part of speech after adding the partial credit to its correct score. Should never be null.

Returns:
a map that stores the recall the detector for each part of speech after counting partial credit.
Since:
jMWE 1.0.0

getPartialF1Scores

Map<MWEPOS,Double> getPartialF1Scores()
Returns a map that stores the f1 measure of the detector for each part of speech after adding the partial credit to its correct score. Should never be null.

Returns:
a map that stores the f1 measure the detector for each part of speech after counting partial credit.
Since:
jMWE 1.0.0

getPartialF1Score

double getPartialF1Score()
Returns the total F score earned by the detector, taking into account partial credit.

Returns:
the total F score earned by the detector, taking into account partial credit.
Since:
jMWE 1.0.0

getPartialScore

double getPartialScore()
Returns the total partial credit earned by the detector. Partial credit should be given when the detector correctly identifies some but not all of the tokens in a multi-word expression or if it includes some extra incorrect tokens in the expression.

Returns:
the total partial credit earned by the detector
Since:
jMWE 1.0.0

getPartialPrecision

double getPartialPrecision()
Returns the total precision of the detector after counting partial credit. Must be a number between 0 and 1.

Returns:
the total precision with partial credit
Since:
jMWE 1.0.0

getPartialRecall

double getPartialRecall()
Returns the total recall of the detector after counting partial credit. Must be a number between 0 and 1.

Returns:
the total precision with partial credit
Since:
jMWE 1.0.0


Copyright © 2011 Massachusetts Institute of Technology. All Rights Reserved.