edu.stanford.nlp.pipeline

Class KBPAnnotator

java.lang.Object

edu.stanford.nlp.pipeline.KBPAnnotator

All Implemented Interfaces:

Annotator

public class KBPAnnotator
extends java.lang.Object
implements Annotator

An annotator which takes as input sentences, and produces KBP relation annotations.

Author:

Gabor Angeli

Field Summary

Fields

Modifier and Type	Field and Description
KBPRelationExtractor	extractor The extractor implementation.

Fields inherited from interface edu.stanford.nlp.pipeline.Annotator

DEFAULT_REQUIREMENTS, STANFORD_CDC_TOKENIZE, STANFORD_CLEAN_XML, STANFORD_COLUMN_DATA_CLASSIFIER, STANFORD_COREF, STANFORD_COREF_MENTION, STANFORD_DEPENDENCIES, STANFORD_DETERMINISTIC_COREF, STANFORD_DOCDATE, STANFORD_ENTITY_MENTIONS, STANFORD_GENDER, STANFORD_KBP, STANFORD_LEMMA, STANFORD_LINK, STANFORD_MWT, STANFORD_NATLOG, STANFORD_NER, STANFORD_OPENIE, STANFORD_PARSE, STANFORD_POS, STANFORD_QUOTE, STANFORD_QUOTE_ATTRIBUTION, STANFORD_REGEXNER, STANFORD_RELATION, STANFORD_SENTIMENT, STANFORD_SSPLIT, STANFORD_TOKENIZE, STANFORD_TOKENSREGEX, STANFORD_TRUECASE, STANFORD_UD_FEATURES

Constructor Summary

Constructors

Constructor and Description
KBPAnnotator(java.util.Properties properties)
KBPAnnotator(java.lang.String name, java.util.Properties props) Create a new KBP annotator from the given properties.

Method Summary

Modifier and Type	Method and Description
void	annotate(Annotation annotation) Annotate this document for KBP relations.
Pair<java.util.List<CoreMap>,CoreMap>	corefChainToKBPMentions(CorefChain corefChain, Annotation ann, java.util.HashMap<Pair<java.lang.Integer,java.lang.Integer>,CoreMap> kbpMentions) Helper method to find best kbp mention in a coref chain This is defined as longest kbp mention or null if the coref chain does not contain a kbp mention
static void	main(java.lang.String[] args) A debugging method to try relation extraction from the console.
java.util.Set<java.lang.Class<? extends CoreAnnotation>>	requirementsSatisfied() Returns a set of requirements for which tasks this annotator can provide.
java.util.Set<java.lang.Class<? extends CoreAnnotation>>	requires() Returns the set of tasks which this annotator requires in order to perform.

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.stanford.nlp.pipeline.Annotator

exactRequirements, unmount

Field Detail

extractor

public final KBPRelationExtractor extractor

The extractor implementation.

Constructor Detail

KBPAnnotator

public KBPAnnotator(java.lang.String name,
                    java.util.Properties props)

Create a new KBP annotator from the given properties.

Parameters:

props - The properties to use when creating this extractor.

KBPAnnotator

public KBPAnnotator(java.util.Properties properties)

See Also:

KBPAnnotator(String, Properties)

Method Detail

corefChainToKBPMentions

public Pair<java.util.List<CoreMap>,CoreMap> corefChainToKBPMentions(CorefChain corefChain,
                                                                     Annotation ann,
                                                                     java.util.HashMap<Pair<java.lang.Integer,java.lang.Integer>,CoreMap> kbpMentions)

Helper method to find best kbp mention in a coref chain This is defined as longest kbp mention or null if the coref chain does not contain a kbp mention

Parameters:

ann - the annotation

corefChain - CorefChain containing potential KBP mentions to search through

kbpMentions - HashMap mapping character offsets to KBP mentions

Returns:

a list of kbp mentions (or null) for each coref mention in this coref chain, and the index of "best" kbp mention, which in this case is the longest kbp mention

annotate

public void annotate(Annotation annotation)

Annotate this document for KBP relations.

Specified by:

annotate in interface Annotator

Parameters:

annotation - The document to annotate.

requirementsSatisfied

public java.util.Set<java.lang.Class<? extends CoreAnnotation>> requirementsSatisfied()

Returns a set of requirements for which tasks this annotator can provide. For example, the POS annotator will return "pos".

Specified by:

requirementsSatisfied in interface Annotator

requires

public java.util.Set<java.lang.Class<? extends CoreAnnotation>> requires()

Returns the set of tasks which this annotator requires in order to perform. For example, the POS annotator will return "tokenize", "ssplit".

Specified by:

requires in interface Annotator

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException

A debugging method to try relation extraction from the console.

Throws:

java.io.IOException - If any IO problem