Named Entity Recognition - ELECTRA Base (OntoNotes)

Description

Onto is a Named Entity Recognition (or NER) model trained on OntoNotes 5.0. It can extract up to 18 entities such as people, places, organizations, money, time, date, etc.

This model uses the pretrained electra_base_uncased embeddings model from the BertEmbeddings annotator as an input.

Predicted Entities

CARDINAL, DATE, EVENT, FAC, GPE, LANGUAGE, LAW, LOC, MONEY, NORP, ORDINAL, ORG, PERCENT, PERSON, PRODUCT, QUANTITY, TIME, WORK_OF_ART.

Live Demo Open in Colab Download

How to use

...
embeddings = BertEmbeddings.pretrained("electra_base_uncased", "en") \
      .setInputCols("sentence", "token") \
      .setOutputCol("embeddings")
ner_onto = NerDLModel.pretrained("onto_electra_base_uncased", "en") \
      .setInputCols(["document", "token", "embeddings"]) \
      .setOutputCol("ner")
...        
nlp_pipeline = Pipeline(stages=[document_assembler, sentence_detector, tokenizer, embeddings, ner_onto, ner_converter])
pipeline_model = nlp_pipeline.fit(spark.createDataFrame([['']]).toDF('text'))

result = pipeline_model.transform(spark.createDataFrame([["William Henry Gates III (born October 28, 1955) is an American business magnate, software developer, investor, and philanthropist. He is best known as the co-founder of Microsoft Corporation. During his career at Microsoft, Gates held the positions of chairman, chief executive officer (CEO), president and chief software architect, while also being the largest individual shareholder until May 2014. He is one of the best-known entrepreneurs and pioneers of the microcomputer revolution of the 1970s and 1980s. Born and raised in Seattle, Washington, Gates co-founded Microsoft with childhood friend Paul Allen in 1975, in Albuquerque, New Mexico; it went on to become the world's largest personal computer software company. Gates led the company as chairman and CEO until stepping down as CEO in January 2000, but he remained chairman and became chief software architect. During the late 1990s, Gates had been criticized for his business tactics, which have been considered anti-competitive. This opinion has been upheld by numerous court rulings. In June 2006, Gates announced that he would be transitioning to a part-time role at Microsoft and full-time work at the Bill & Melinda Gates Foundation, the private charitable foundation that he and his wife, Melinda Gates, established in 2000. He gradually transferred his duties to Ray Ozzie and Craig Mundie. He stepped down as chairman of Microsoft in February 2014 and assumed a new post as technology adviser to support the newly appointed CEO Satya Nadella."]], ["text"]))
...
val embeddings = BertEmbeddings.pretrained("electra_base_uncased", "en")
      .setInputCols(Array("sentence", "token"))
      .setOutputCol("embeddings")
val ner_onto = NerDLModel.pretrained("onto_electra_base_uncased", "en")
        .setInputCols(Array("document", "token", "embeddings"))
        .setOutputCol("ner")
...
val pipeline = new Pipeline().setStages(Array(document_assembler, sentence_detector, tokenizer, embeddings, ner_onto, ner_converter))

val data = Seq("William Henry Gates III (born October 28, 1955) is an American business magnate, software developer, investor, and philanthropist. He is best known as the co-founder of Microsoft Corporation. During his career at Microsoft, Gates held the positions of chairman, chief executive officer (CEO), president and chief software architect, while also being the largest individual shareholder until May 2014. He is one of the best-known entrepreneurs and pioneers of the microcomputer revolution of the 1970s and 1980s. Born and raised in Seattle, Washington, Gates co-founded Microsoft with childhood friend Paul Allen in 1975, in Albuquerque, New Mexico; it went on to become the world's largest personal computer software company. Gates led the company as chairman and CEO until stepping down as CEO in January 2000, but he remained chairman and became chief software architect. During the late 1990s, Gates had been criticized for his business tactics, which have been considered anti-competitive. This opinion has been upheld by numerous court rulings. In June 2006, Gates announced that he would be transitioning to a part-time role at Microsoft and full-time work at the Bill & Melinda Gates Foundation, the private charitable foundation that he and his wife, Melinda Gates, established in 2000. He gradually transferred his duties to Ray Ozzie and Craig Mundie. He stepped down as chairman of Microsoft in February 2014 and assumed a new post as technology adviser to support the newly appointed CEO Satya Nadella.").toDF("text")
val result = pipeline.fit(data).transform(data)
import nlu

text = ["""William Henry Gates III (born October 28, 1955) is an American business magnate, software developer, investor, and philanthropist. He is best known as the co-founder of Microsoft Corporation. During his career at Microsoft, Gates held the positions of chairman, chief executive officer (CEO), president and chief software architect, while also being the largest individual shareholder until May 2014. He is one of the best-known entrepreneurs and pioneers of the microcomputer revolution of the 1970s and 1980s. Born and raised in Seattle, Washington, Gates co-founded Microsoft with childhood friend Paul Allen in 1975, in Albuquerque, New Mexico; it went on to become the world's largest personal computer software company. Gates led the company as chairman and CEO until stepping down as CEO in January 2000, but he remained chairman and became chief software architect. During the late 1990s, Gates had been criticized for his business tactics, which have been considered anti-competitive. This opinion has been upheld by numerous court rulings. In June 2006, Gates announced that he would be transitioning to a part-time role at Microsoft and full-time work at the Bill & Melinda Gates Foundation, the private charitable foundation that he and his wife, Melinda Gates, established in 2000. He gradually transferred his duties to Ray Ozzie and Craig Mundie. He stepped down as chairman of Microsoft in February 2014 and assumed a new post as technology adviser to support the newly appointed CEO Satya Nadella."""]
ner_df = nlu.load('en.ner.onto.electra.uncased_base').predict(text, output_level='chunk')
ner_df[["entities", "entities_class"]]

Results


+-----------------------+---------+
|chunk                  |ner_label|
+-----------------------+---------+
|William Henry Gates III|PERSON   |
|October 28, 1955       |DATE     |
|American               |NORP     |
|Microsoft Corporation  |ORG      |
|Microsoft              |ORG      |
|Gates                  |PERSON   |
|May 2014               |DATE     |
|one                    |CARDINAL |
|the 1970s              |DATE     |
|1980s                  |DATE     |
|Seattle                |GPE      |
|Washington             |GPE      |
|Gates                  |PERSON   |
|Microsoft              |ORG      |
|Paul Allen             |PERSON   |
|1975                   |DATE     |
|Albuquerque            |GPE      |
|New Mexico             |GPE      |
|Gates                  |PERSON   |
|January 2000           |DATE     |
+-----------------------+---------+

Model Information

Model Name: onto_electra_base_uncased
Type: ner
Compatibility: Spark NLP 2.7.0+
License: Open Source
Edition: Official
Input Labels: [sentence, token, embeddings]
Output Labels: [ner]
Language: en

Data Source

The model is trained based on data from OntoNotes 5.0

Benchmarking

Micro-average:

prec: 0.88154626, rec: 0.88217854, f1: 0.8818623

CoNLL Eval:

processed 152728 tokens with 11257 phrases; found: 11296 phrases; correct: 9871.
accuracy:  97.56%; 9871 11257 11296 precision:  87.38%; recall:  87.69%; FB1:  87.54
         CARDINAL:  800  935  959 precision:  83.42%; recall:  85.56%; FB1:  84.48  959
             DATE:  1396  1602  1652 precision:  84.50%; recall:  87.14%; FB1:  85.80  1652
            EVENT:   23   63   38 precision:  60.53%; recall:  36.51%; FB1:  45.54  38
              FAC:   60  135   81 precision:  74.07%; recall:  44.44%; FB1:  55.56  81
              GPE:  2102  2240  2205 precision:  95.33%; recall:  93.84%; FB1:  94.58  2205
         LANGUAGE:    8   22   10 precision:  80.00%; recall:  36.36%; FB1:  50.00  10
              LAW:   16   40   21 precision:  76.19%; recall:  40.00%; FB1:  52.46  21
              LOC:  118  179  191 precision:  61.78%; recall:  65.92%; FB1:  63.78  191
            MONEY:  285  314  329 precision:  86.63%; recall:  90.76%; FB1:  88.65  329
             NORP:  801  841  897 precision:  89.30%; recall:  95.24%; FB1:  92.17  897
          ORDINAL:  180  195  225 precision:  80.00%; recall:  92.31%; FB1:  85.71  225
              ORG:  1538  1795  1816 precision:  84.69%; recall:  85.68%; FB1:  85.18  1816
          PERCENT:  312  349  348 precision:  89.66%; recall:  89.40%; FB1:  89.53  348
           PERSON:  1892  1988  2025 precision:  93.43%; recall:  95.17%; FB1:  94.29  2025
          PRODUCT:   39   76   49 precision:  79.59%; recall:  51.32%; FB1:  62.40  49
         QUANTITY:   81  105  102 precision:  79.41%; recall:  77.14%; FB1:  78.26  102
             TIME:  136  212  216 precision:  62.96%; recall:  64.15%; FB1:  63.55  216
      WORK_OF_ART:   84  166  132 precision:  63.64%; recall:  50.60%; FB1:  56.38  132