org.apache.ctakes.coreference.ae

Class MentionClusterCoreferenceAnnotator

java.lang.Object

org.apache.uima.analysis_component.AnalysisComponent_ImplBase

org.apache.uima.analysis_component.Annotator_ImplBase

org.apache.uima.analysis_component.JCasAnnotator_ImplBase

org.apache.uima.fit.component.JCasAnnotator_ImplBase

org.cleartk.ml.CleartkAnnotator<String>

org.apache.ctakes.coreference.ae.MentionClusterCoreferenceAnnotator

All Implemented Interfaces:

org.apache.uima.analysis_component.AnalysisComponent, org.apache.uima.fit.factory.initializable.Initializable

@PipeBitInfo(name="Coreference (Clusters)",
             description="Coreference annotator using mention-synchronous paradigm.",
             dependencies={BASE_TOKEN,SENTENCE,SECTION,IDENTIFIED_ANNOTATION,MARKABLE},
             products=COREFERENCE_RELATION)
public class MentionClusterCoreferenceAnnotator
extends org.cleartk.ml.CleartkAnnotator<String>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MentionClusterCoreferenceAnnotator.CollectionTextRelationIdentifiedAnnotationPair

Field Summary

Fields

Modifier and Type	Field and Description
protected Random	coin
static String	NO_RELATION_CATEGORY
static String	PARAM_PROBABILITY_OF_KEEPING_A_NEGATIVE_EXAMPLE
static String	PARAM_USE_EXISTING_ENCODERS
protected double	probabilityOfKeepingANegativeExample

Fields inherited from class org.cleartk.ml.CleartkAnnotator

classifier, dataWriter, PARAM_CLASSIFIER_FACTORY_CLASS_NAME, PARAM_DATA_WRITER_FACTORY_CLASS_NAME, PARAM_IS_TRAINING

Constructor Summary

Constructors

Constructor and Description
MentionClusterCoreferenceAnnotator()

Method Summary

Modifier and Type	Method and Description
protected String	classify(List<org.cleartk.ml.Feature> features) Predict an outcome given a set of features.
static org.apache.uima.analysis_engine.AnalysisEngineDescription	createAnnotatorDescription(String modelPath)
static org.apache.uima.analysis_engine.AnalysisEngineDescription	createDataWriterDescription(Class<? extends org.cleartk.ml.DataWriter<String>> dataWriterClass, File outputDirectory, float downsamplingRate)
protected void	createRelation(org.apache.uima.jcas.JCas jCas, CollectionTextRelation cluster, IdentifiedAnnotation mention, String predictedCategory, Double confidence) Create a UIMA relation type based on arguments and the relation label.
protected Iterable<MentionClusterCoreferenceAnnotator.CollectionTextRelationIdentifiedAnnotationPair>	getCandidateRelationArgumentPairs(org.apache.uima.jcas.JCas jcas, Markable mention)
protected List<RelationFeaturesExtractor<CollectionTextRelation,IdentifiedAnnotation>>	getFeatureExtractors()
Map<RelationExtractorEvaluation.HashableArguments,Double>	getMarkablePairScores(org.apache.uima.jcas.JCas jCas)
protected List<org.cleartk.ml.feature.extractor.FeatureExtractor1<Markable>>	getMentionExtractors()
protected List<ClusterMentionPairer_ImplBase>	getPairExtractors()
protected String	getRelationCategory(Map<MentionClusterCoreferenceAnnotator.CollectionTextRelationIdentifiedAnnotationPair,CollectionTextRelationIdentifiedAnnotationRelation> relationLookup, CollectionTextRelation cluster, IdentifiedAnnotation mention) Looks up the arguments in the specified lookup table and converts the relation into a label for classification
void	initialize(org.apache.uima.UimaContext context)
void	process(org.apache.uima.jcas.JCas jCas)

Methods inherited from class org.cleartk.ml.CleartkAnnotator

collectionProcessComplete, isTraining

Methods inherited from class org.apache.uima.fit.component.JCasAnnotator_ImplBase

getLogger

Methods inherited from class org.apache.uima.analysis_component.JCasAnnotator_ImplBase

getRequiredCasInterface, process

Methods inherited from class org.apache.uima.analysis_component.Annotator_ImplBase

getCasInstancesRequired, hasNext, next

Methods inherited from class org.apache.uima.analysis_component.AnalysisComponent_ImplBase

batchProcessComplete, destroy, getContext, getResultSpecification, reconfigure, setResultSpecification

Methods inherited from class java.lang.Object

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

Field Detail

NO_RELATION_CATEGORY

public static final String NO_RELATION_CATEGORY

See Also:

Constant Field Values

PARAM_PROBABILITY_OF_KEEPING_A_NEGATIVE_EXAMPLE

public static final String PARAM_PROBABILITY_OF_KEEPING_A_NEGATIVE_EXAMPLE

See Also:

Constant Field Values

probabilityOfKeepingANegativeExample

protected double probabilityOfKeepingANegativeExample

PARAM_USE_EXISTING_ENCODERS

public static final String PARAM_USE_EXISTING_ENCODERS

See Also:

Constant Field Values

coin

protected Random coin

Constructor Detail

MentionClusterCoreferenceAnnotator

public MentionClusterCoreferenceAnnotator()

Method Detail

createDataWriterDescription

public static org.apache.uima.analysis_engine.AnalysisEngineDescription createDataWriterDescription(Class<? extends org.cleartk.ml.DataWriter<String>> dataWriterClass,
                                                                                                    File outputDirectory,
                                                                                                    float downsamplingRate)
                                                                                             throws org.apache.uima.resource.ResourceInitializationException

Throws:

org.apache.uima.resource.ResourceInitializationException

createAnnotatorDescription

public static org.apache.uima.analysis_engine.AnalysisEngineDescription createAnnotatorDescription(String modelPath)
                                                                                            throws org.apache.uima.resource.ResourceInitializationException

Throws:

org.apache.uima.resource.ResourceInitializationException

getFeatureExtractors

protected List<RelationFeaturesExtractor<CollectionTextRelation,IdentifiedAnnotation>> getFeatureExtractors()

getMentionExtractors

protected List<org.cleartk.ml.feature.extractor.FeatureExtractor1<Markable>> getMentionExtractors()

getPairExtractors

protected List<ClusterMentionPairer_ImplBase> getPairExtractors()

getCandidateRelationArgumentPairs

protected Iterable<MentionClusterCoreferenceAnnotator.CollectionTextRelationIdentifiedAnnotationPair> getCandidateRelationArgumentPairs(org.apache.uima.jcas.JCas jcas,
                                                                                                                                        Markable mention)

initialize

public void initialize(org.apache.uima.UimaContext context)
                throws org.apache.uima.resource.ResourceInitializationException

Specified by:

initialize in interface org.apache.uima.analysis_component.AnalysisComponent

Specified by:

initialize in interface org.apache.uima.fit.factory.initializable.Initializable

Overrides:

initialize in class org.cleartk.ml.CleartkAnnotator<String>

Throws:

org.apache.uima.resource.ResourceInitializationException

process

public void process(org.apache.uima.jcas.JCas jCas)
             throws org.apache.uima.analysis_engine.AnalysisEngineProcessException

Specified by:

process in class org.apache.uima.analysis_component.JCasAnnotator_ImplBase

Throws:

org.apache.uima.analysis_engine.AnalysisEngineProcessException

getRelationCategory

protected String getRelationCategory(Map<MentionClusterCoreferenceAnnotator.CollectionTextRelationIdentifiedAnnotationPair,CollectionTextRelationIdentifiedAnnotationRelation> relationLookup,
                                     CollectionTextRelation cluster,
                                     IdentifiedAnnotation mention)

Looks up the arguments in the specified lookup table and converts the relation into a label for classification

Returns:

If this category should not be processed for training return null otherwise it returns the label sent to the datawriter

classify

protected String classify(List<org.cleartk.ml.Feature> features)
                   throws org.cleartk.ml.CleartkProcessingException

Predict an outcome given a set of features. By default, this simply delegates to the object's classifier. Subclasses may override this method to implement more complex classification procedures.

Parameters:

features - The features to be classified.

Returns:

The predicted outcome (label) for the features.

Throws:

org.cleartk.ml.CleartkProcessingException

createRelation

protected void createRelation(org.apache.uima.jcas.JCas jCas,
                              CollectionTextRelation cluster,
                              IdentifiedAnnotation mention,
                              String predictedCategory,
                              Double confidence)

Create a UIMA relation type based on arguments and the relation label. This allows subclasses to create/define their own types: e.g. coreference can create CoreferenceRelation instead of BinaryTextRelation

Parameters:

jCas - - JCas object, needed to create new UIMA types

arg1 - - First argument to relation

arg2 - - Second argument to relation

predictedCategory - - Name of relation

getMarkablePairScores

public Map<RelationExtractorEvaluation.HashableArguments,Double> getMarkablePairScores(org.apache.uima.jcas.JCas jCas)