Nigerian Pidgin XLMRobertaForTokenClassification Base Cased model (from mbeukman)

Description

Pretrained XLMRobertaForTokenClassification model, adapted from Hugging Face and curated to provide scalability and production-readiness using Spark NLP. xlm-roberta-base-finetuned-naija-finetuned-ner-naija is a Nigerian Pidgin model originally trained by mbeukman.

Predicted Entities

ORG, LOC, PER, DATE

Live Demo Open in Colab Download Copy S3 URI

How to use

documentAssembler = DocumentAssembler() \
    .setInputCol("text") \
    .setOutputCol("document")

tokenizer = Tokenizer() \
    .setInputCols("document") \
    .setOutputCol("token")

token_classifier = XlmRoBertaForTokenClassification.pretrained("xlmroberta_ner_base_finetuned_naija_finetuned_naija","pcm") \
    .setInputCols(["document", "token"]) \
    .setOutputCol("ner")

ner_converter = NerConverter()\
    .setInputCols(["document", "token", "ner"])\
    .setOutputCol("ner_chunk")

pipeline = Pipeline(stages=[documentAssembler, tokenizer, token_classifier, ner_converter])

data = spark.createDataFrame([["PUT YOUR STRING HERE"]]).toDF("text")

result = pipeline.fit(data).transform(data)

val documentAssembler = new DocumentAssembler()
      .setInputCols(Array("text"))
      .setOutputCols(Array("document"))

val tokenizer = new Tokenizer()
    .setInputCols("document")
    .setOutputCol("token")

val token_classifier = XlmRoBertaForTokenClassification.pretrained("xlmroberta_ner_base_finetuned_naija_finetuned_naija","pcm")
    .setInputCols(Array("document", "token"))
    .setOutputCol("ner")

val ner_converter = new NerConverter()
    .setInputCols(Array("document", "token', "ner"))
    .setOutputCol("ner_chunk")

val pipeline = new Pipeline().setStages(Array(documentAssembler, tokenizer, token_classifier, ner_converter))

val data = Seq("PUT YOUR STRING HERE").toDS.toDF("text")

val result = pipeline.fit(data).transform(data)

import nlu
nlu.load("pcm.ner.xlmr_roberta.base_finetuned_naija.by_mbeukman").predict("""PUT YOUR STRING HERE""")

Model Information

References

• https://huggingface.co/mbeukman/xlm-roberta-base-finetuned-naija-finetuned-ner-naija
• https://arxiv.org/abs/2103.11811
• https://github.com/Michael-Beukman/NERTransfer
• https://www.apache.org/licenses/LICENSE-2.0
• https://github.com/Michael-Beukman/NERTransfer
• https://github.com/masakhane-io/masakhane-ner
• https://arxiv.org/pdf/2103.11811.pdf
• https://arxiv.org/abs/2103.11811
• https://arxiv.org/abs/2103.11811