Skip to main content

A Framework for Finetuning Transformers for Named Entity Recognition

Project description

NERDA - UNDER CONSTRUCTION

Build status codecov PyPI PyPI - Downloads License

!!! UNDER CONSTRUCTION!!!!

NERDA is not only a mesmerizing muppet-like character. NERDA is also a python package, that offers a complete framework for fine-tuning pretrained huggingface transformers for Named Entity Recognition (=NER) tasks.

Installation guide

pip install NERDA

NER tasks

Named Entity Recognition (NER) tasks are all about identifying and extracting names of named entitites from natural language texts.

Read more about NER on Wikipedia.

Performance

The table below summarizes the performance (=F1-scores) of the model configurations, that NERDA ships with.

Level MBERT DABERT ELECTRA XLMROBERTA DISTILMBERT
B-PER 0.92 0.93 0.92 0.94 0.89
I-PER 0.97 0.99 0.97 0.99 0.96
B-ORG 0.68 0.79 0.65 0.78 0.66
I-ORG 0.67 0.79 0.72 0.77 0.61
B-LOC 0.86 0.85 0.79 0.87 0.80
I-LOC 0.33 0.32 0.44 0.24 0.29
B-MISC 0.73 0.74 0.61 0.77 0.70
I-MISC 0.70 0.86 0.65 0.91 0.61
AVG_MICRO 0.81 0.85 0.79 0.86 0.78
AVG_MACRO 0.73 0.78 0.72 0.78 0.69

AVG_ stands for micro- and macro AVeraGed F1-scores.

'NERDA'?

'NERDA' originally stands for 'Named Entity Recognition for DAnish'. However, this is somewhat misleading, since the functionality is no longer limited to Danish. On the contrary it generalizes to all other languages, i.e. NERDA supports fine-tuning of transformer-based models for NER tasks for any arbitrary language.

Read more

The documentation for NERDA including code references and examples can be accessed here.

Contact

We hope, that you will find NERDA useful.

Please direct any questions and feedbacks to us!

If you want to contribute (which we encourage you to), open a PR.

If you encounter a bug or want to suggest an enhancement, please open an issue.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

NERDA-0.0.31.tar.gz (14.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

NERDA-0.0.31-py3-none-any.whl (16.5 kB view details)

Uploaded Python 3

File details

Details for the file NERDA-0.0.31.tar.gz.

File metadata

  • Download URL: NERDA-0.0.31.tar.gz
  • Upload date:
  • Size: 14.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.7.9

File hashes

Hashes for NERDA-0.0.31.tar.gz
Algorithm Hash digest
SHA256 c3dbc4e0a243283ee65fb55328d5c93b6ad9af86ac89023288f1f33182d38b0a
MD5 63c2c95e1569cee904fdfe22a2976025
BLAKE2b-256 8d9b8fed511fa5b8e781ad38c922cdcf7fd5b6b0ed2bbb645ea553976572f792

See more details on using hashes here.

File details

Details for the file NERDA-0.0.31-py3-none-any.whl.

File metadata

  • Download URL: NERDA-0.0.31-py3-none-any.whl
  • Upload date:
  • Size: 16.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.7.9

File hashes

Hashes for NERDA-0.0.31-py3-none-any.whl
Algorithm Hash digest
SHA256 dd58af9fca12042a11fb914c15a5d4d0b585fa8877bcf3b6f8ccdc8c763ee683
MD5 6d36edb5983190e675c001093350e435
BLAKE2b-256 597fca394964ed356ecc2058599bbb89ed60ace8e337568c0f53b566bf69dace

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page