org.apache.ctakes.relationextractor.eval

Class RelationExtractorEvaluation

java.lang.Object

org.cleartk.eval.Evaluation_ImplBase<File,org.cleartk.eval.AnnotationStatistics<String>>

org.apache.ctakes.relationextractor.eval.SHARPXMI.Evaluation_ImplBase

org.apache.ctakes.relationextractor.eval.RelationExtractorEvaluation

public class RelationExtractorEvaluation
extends SHARPXMI.Evaluation_ImplBase

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RelationExtractorEvaluation.AddPotentialRelations
static class	RelationExtractorEvaluation.HashableArguments This class is useful for mapping the spans of relation arguments to the relation's category.
static interface	RelationExtractorEvaluation.Options
static class	RelationExtractorEvaluation.RemoveCTakesMentionsAndCopyGoldRelations Annotator that removes cTAKES mentions in the system view and copies relations from the gold view to the system view
static class	RelationExtractorEvaluation.RemoveSmallerEventMentions
static class	RelationExtractorEvaluation.ReplaceCTakesMentionsWithGoldMentions Annotator that removes cTAKES Mentions and Modifiers from the system view, and copies over the manually annotated Mentions and Modifiers from the gold view.

Field Summary

Fields

Modifier and Type	Field and Description
static Map<Class<? extends BinaryTextRelation>,Class<? extends RelationExtractorAnnotator>>	ANNOTATOR_CLASSES
static Map<Class<? extends BinaryTextRelation>,ParameterSettings>	BEST_PARAMETERS
static boolean	expandEvent
static Map<String,Class<? extends BinaryTextRelation>>	RELATION_CLASSES

Fields inherited from class org.cleartk.eval.Evaluation_ImplBase

baseDirectory

Constructor Summary

Constructors

Constructor and Description
RelationExtractorEvaluation(File baseDirectory, Class<? extends BinaryTextRelation> relationClass, Class<? extends RelationExtractorAnnotator> classifierAnnotatorClass, ParameterSettings parameterSettings)
RelationExtractorEvaluation(File baseDirectory, Class<? extends BinaryTextRelation> relationClass, Class<? extends RelationExtractorAnnotator> classifierAnnotatorClass, ParameterSettings parameterSettings, boolean testOnCTakes, boolean allowSmallerSystemArguments, boolean ignoreImpossibleGoldRelations, boolean printErrors, boolean setClassWeights, boolean expandEventParameter) An evaluation of a relation extractor.

Method Summary

Modifier and Type	Method and Description
static void	main(String[] args)
protected org.cleartk.eval.AnnotationStatistics<String>	test(org.apache.uima.collection.CollectionReader collectionReader, File directory)
void	train(org.apache.uima.collection.CollectionReader collectionReader, File directory)

Methods inherited from class org.apache.ctakes.relationextractor.eval.SHARPXMI.Evaluation_ImplBase

getCollectionReader

Methods inherited from class org.cleartk.eval.Evaluation_ImplBase

crossValidation, selectFoldTestItems, selectFoldTrainItems, trainAndTest

Methods inherited from class java.lang.Object

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

Field Detail

RELATION_CLASSES

public static final Map<String,Class<? extends BinaryTextRelation>> RELATION_CLASSES

ANNOTATOR_CLASSES

public static final Map<Class<? extends BinaryTextRelation>,Class<? extends RelationExtractorAnnotator>> ANNOTATOR_CLASSES

BEST_PARAMETERS

public static final Map<Class<? extends BinaryTextRelation>,ParameterSettings> BEST_PARAMETERS

expandEvent

public static boolean expandEvent

Constructor Detail

RelationExtractorEvaluation

public RelationExtractorEvaluation(File baseDirectory,
                                   Class<? extends BinaryTextRelation> relationClass,
                                   Class<? extends RelationExtractorAnnotator> classifierAnnotatorClass,
                                   ParameterSettings parameterSettings,
                                   boolean testOnCTakes,
                                   boolean allowSmallerSystemArguments,
                                   boolean ignoreImpossibleGoldRelations,
                                   boolean printErrors,
                                   boolean setClassWeights,
                                   boolean expandEventParameter)

An evaluation of a relation extractor.

Parameters:

baseDirectory - The directory where models, etc. should be written

relationClass - The class of the relation to be predicted

classifierAnnotatorClass - The CleartkAnnotator class that learns a relation extractor model

parameterSettings - The parameters defining how to train a classifier

testOnCTakes - During testing, use annotations from cTAKES, not from the gold standard

allowSmallerSystemArguments - During testing, allow system annotations to match gold annotations that enclose them

ignoreImpossibleGoldRelations - During testing, ignore gold relations that would be impossible to find because there are no corresponding system mentions // * @param expandEvent

RelationExtractorEvaluation

public RelationExtractorEvaluation(File baseDirectory,
                                   Class<? extends BinaryTextRelation> relationClass,
                                   Class<? extends RelationExtractorAnnotator> classifierAnnotatorClass,
                                   ParameterSettings parameterSettings)

Method Detail

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception

train

public void train(org.apache.uima.collection.CollectionReader collectionReader,
                  File directory)
           throws Exception

Specified by:

train in class org.cleartk.eval.Evaluation_ImplBase<File,org.cleartk.eval.AnnotationStatistics<String>>

Throws:

Exception

test

protected org.cleartk.eval.AnnotationStatistics<String> test(org.apache.uima.collection.CollectionReader collectionReader,
                                                             File directory)
                                                      throws Exception

Specified by:

test in class org.cleartk.eval.Evaluation_ImplBase<File,org.cleartk.eval.AnnotationStatistics<String>>

Throws:

Exception