edu.stanford.nlp.pipeline

Class WikidictAnnotator

java.lang.Object

edu.stanford.nlp.pipeline.SentenceAnnotator

edu.stanford.nlp.pipeline.WikidictAnnotator

All Implemented Interfaces:

Annotator

public class WikidictAnnotator
extends SentenceAnnotator

An annotator for entity linking to Wikipedia pages via the Wikidict.
The wikidict dictionary in particular is based on this paper:
"A Cross-Lingual Dictionary for English Wikipedia Concepts"
https://nlp.stanford.edu/pubs/crosswikis.pdf

Author:

Gabor Angeli

Nested Class Summary

Nested classes/interfaces inherited from class edu.stanford.nlp.pipeline.SentenceAnnotator

SentenceAnnotator.AnnotatorProcessor

Field Summary

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
WikidictAnnotator(java.util.Properties properties)
WikidictAnnotator(java.lang.String name, java.util.Properties properties) Create a new WikiDict annotator, with the given name and properties.

Method Summary

Modifier and Type	Method and Description
protected void	doOneFailedSentence(Annotation annotation, CoreMap sentence) Fills in empty annotations for trees, tags, etc if the annotator failed or timed out.
protected void	doOneSentence(Annotation annotation, CoreMap sentence) annotation is included in case there is global information we care about
java.util.Optional<java.lang.String>	link(CoreMap mention) Link the given mention, if possible.
static void	main(java.lang.String[] args) A debugging method to try entity linking sentences from the console.
protected long	maxTime() The maximum time to run this annotator for, in milliseconds.
static java.lang.String	normalizeTimex(java.lang.String timex) Try to normalize timex values to the form they would appear in the knowledge base.
protected int	nThreads()
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 edu.stanford.nlp.pipeline.SentenceAnnotator

annotate

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

Constructor Detail

WikidictAnnotator

public WikidictAnnotator(java.lang.String name,
                         java.util.Properties properties)

Create a new WikiDict annotator, with the given name and properties.

WikidictAnnotator

public WikidictAnnotator(java.util.Properties properties)

See Also:

WikidictAnnotator(String, Properties)

Method Detail

normalizeTimex

public static java.lang.String normalizeTimex(java.lang.String timex)

Try to normalize timex values to the form they would appear in the knowledge base.

Parameters:

timex - The timex value to normalize.

Returns:

The normalized timex value (e.g., dates have the time of day removed, etc.)

link

public java.util.Optional<java.lang.String> link(CoreMap mention)

Link the given mention, if possible.

Parameters:

mention - The mention to link, as given by EntityMentionsAnnotator

Returns:

The Wikidict entry for the given mention, or the normalized timex / numeric value -- as appropriate.

nThreads

protected int nThreads()

Specified by:

nThreads in class SentenceAnnotator

maxTime

protected long maxTime()

The maximum time to run this annotator for, in milliseconds.

Specified by:

maxTime in class SentenceAnnotator

doOneSentence

protected void doOneSentence(Annotation annotation,
                             CoreMap sentence)

annotation is included in case there is global information we care about

Specified by:

doOneSentence in class SentenceAnnotator

doOneFailedSentence

protected void doOneFailedSentence(Annotation annotation,
                                   CoreMap sentence)

Fills in empty annotations for trees, tags, etc if the annotator failed or timed out. Not supposed to do major processing.

Specified by:

doOneFailedSentence in class SentenceAnnotator

Parameters:

annotation - The whole Annotation object, in case it is needed for context.

sentence - The particular sentence to process

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".

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".

main

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

A debugging method to try entity linking sentences from the console.

Throws:

java.io.IOException