edu.stanford.nlp.pipeline

Class NERCombinerAnnotator

java.lang.Object

edu.stanford.nlp.pipeline.SentenceAnnotator

edu.stanford.nlp.pipeline.NERCombinerAnnotator

All Implemented Interfaces:

Annotator

public class NERCombinerAnnotator
extends SentenceAnnotator

This class will add NER information to an Annotation using a combination of NER models. It assumes that the Annotation already contains the tokenized words in sentences under CoreAnnotations.SentencesAnnotation.class as List<? extends CoreLabel>} or a List<List<? extends CoreLabel>> under Annotation.WORDS_KEY and adds NER information to each CoreLabel, in the CoreLabel.NER_KEY field. It uses the NERClassifierCombiner class in the ie package.

Author:

Jenny Finkel, Mihai Surdeanu (modified it to work with the new NERClassifierCombiner)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NERCombinerAnnotator.TokenMergeCountAnnotation Helper class for aligning merged tokens and original tokens, stores number of merged tokens this merged token contains (e.g.

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

SentenceAnnotator.AnnotatorProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.function.Function<CoreLabel,java.lang.Boolean>	afterIsEmpty Check that after() is not null and the empty string

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
NERCombinerAnnotator()
NERCombinerAnnotator(boolean verbose)
NERCombinerAnnotator(boolean verbose, java.lang.String... classifiers)
NERCombinerAnnotator(NERClassifierCombiner ner, boolean verbose)
NERCombinerAnnotator(NERClassifierCombiner ner, boolean verbose, int nThreads, long maxTime)
NERCombinerAnnotator(NERClassifierCombiner ner, boolean verbose, int nThreads, long maxTime, int maxSentenceLength)
NERCombinerAnnotator(NERClassifierCombiner ner, boolean verbose, int nThreads, long maxTime, int maxSentenceLength, boolean fineGrained, boolean entityMentions)
NERCombinerAnnotator(java.util.Properties properties)

Method Summary

Modifier and Type	Method and Description
void	annotate(Annotation annotation) Given an Annotation, perform a task on this Annotation.
void	doOneFailedSentence(Annotation annotation, CoreMap sentence) Fills in empty annotations for trees, tags, etc if the annotator failed or timed out.
void	doOneSentence(Annotation annotation, CoreMap sentence) annotation is included in case there is global information we care about
protected long	maxTime() The maximum time to run this annotator for, in milliseconds.
static void	mergeTokens(CoreLabel token, CoreLabel nextToken) Helper method for creating NER-specific tokenization
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.
static void	transferNERAnnotationsToAnnotation(Annotation nerTokenizedAnnotation, Annotation originalAnnotation) Copy NER annotations from the NER-tokenized annotation.

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

afterIsEmpty

public static java.util.function.Function<CoreLabel,java.lang.Boolean> afterIsEmpty

Check that after() is not null and the empty string

Constructor Detail

NERCombinerAnnotator

public NERCombinerAnnotator(java.util.Properties properties)
                     throws java.io.IOException

Throws:

java.io.IOException

NERCombinerAnnotator

public NERCombinerAnnotator()
                     throws java.io.IOException,
                            java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException

NERCombinerAnnotator

public NERCombinerAnnotator(boolean verbose)
                     throws java.io.IOException,
                            java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException

NERCombinerAnnotator

public NERCombinerAnnotator(boolean verbose,
                            java.lang.String... classifiers)
                     throws java.io.IOException,
                            java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException

NERCombinerAnnotator

public NERCombinerAnnotator(NERClassifierCombiner ner,
                            boolean verbose)

NERCombinerAnnotator

public NERCombinerAnnotator(NERClassifierCombiner ner,
                            boolean verbose,
                            int nThreads,
                            long maxTime)

NERCombinerAnnotator

public NERCombinerAnnotator(NERClassifierCombiner ner,
                            boolean verbose,
                            int nThreads,
                            long maxTime,
                            int maxSentenceLength)

NERCombinerAnnotator

public NERCombinerAnnotator(NERClassifierCombiner ner,
                            boolean verbose,
                            int nThreads,
                            long maxTime,
                            int maxSentenceLength,
                            boolean fineGrained,
                            boolean entityMentions)

Method Detail

nThreads

protected int nThreads()

Specified by:

nThreads in class SentenceAnnotator

maxTime

protected long maxTime()

Description copied from class: SentenceAnnotator

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

Specified by:

maxTime in class SentenceAnnotator

mergeTokens

public static void mergeTokens(CoreLabel token,
                               CoreLabel nextToken)

Helper method for creating NER-specific tokenization

transferNERAnnotationsToAnnotation

public static void transferNERAnnotationsToAnnotation(Annotation nerTokenizedAnnotation,
                                                      Annotation originalAnnotation)

Copy NER annotations from the NER-tokenized annotation. nerTokenizedAnnotation should have the same text as originalAnnotation,

Parameters:

nerTokenizedAnnotation -

originalAnnotation -

annotate

public void annotate(Annotation annotation)

Description copied from interface: Annotator

Given an Annotation, perform a task on this Annotation.

Specified by:

annotate in interface Annotator

Overrides:

annotate in class SentenceAnnotator

doOneSentence

public void doOneSentence(Annotation annotation,
                          CoreMap sentence)

Description copied from class: SentenceAnnotator

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

Specified by:

doOneSentence in class SentenceAnnotator

doOneFailedSentence

public 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

requires

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

Description copied from interface: Annotator

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

requirementsSatisfied

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

Description copied from interface: Annotator

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