Skip to main content

fine-tune transformer-based models for named entity recognition

Project description

A python package to fine-tune transformer-based models for Named Entity Recognition (NER).

PyPI PyPI - Python Version Travis CI https://img.shields.io/badge/code%20style-black-000000.svg PyPI - License

Resources

About

Transformer-based models like BERT have had a game-changing impact on Natural Language Processing.

In order to utilize the publicly accessible pretrained models for Named Entity Recognition, one needs to retrain (or “fine-tune”) them using labeled text.

nerblackbox makes this easy.

https://raw.githubusercontent.com/af-ai-center/nerblackbox/master/docs/_static/nerblackbox.png

You give it

  • a Dataset (labeled text)

  • a Pretrained Model (transformers)

and you get

  • the best Fine-tuned Model

  • its Performance on the dataset

Installation

pip install nerblackbox

Usage

Fine-tuning can be done in a few simple steps using an “experiment configuration file”

# cat <experiment_name>.ini
dataset_name = swedish_ner_corpus
pretrained_model_name = af-ai-center/bert-base-swedish-uncased

and either the Command Line Interface (CLI) or the Python API:

# CLI
nerbb run_experiment <experiment_name>          # fine-tune
nerbb get_experiment_results <experiment_name>  # get results/performance
nerbb predict <experiment_name> <text_input>    # apply best model

# Python API
nerbb = NerBlackBox()
nerbb.run_experiment(<experiment_name>)         # fine-tune
nerbb.get_experiment_results(<experiment_name>) # get results/performance
nerbb.predict(<experiment_name>, <text_input>)  # apply best model

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

nerblackbox-0.0.7.tar.gz (45.9 kB view details)

Uploaded Source

Built Distribution

nerblackbox-0.0.7-py3-none-any.whl (67.1 kB view details)

Uploaded Python 3

File details

Details for the file nerblackbox-0.0.7.tar.gz.

File metadata

  • Download URL: nerblackbox-0.0.7.tar.gz
  • Upload date:
  • Size: 45.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/47.3.2 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.7.7

File hashes

Hashes for nerblackbox-0.0.7.tar.gz
Algorithm Hash digest
SHA256 1de84b55b04aadfd564e384b25fe50baa80981bcb49390d9d215b2826e6c7f4a
MD5 f2f6ff155921795e3bb4423339971e62
BLAKE2b-256 bc19c99902c61680bbf05e816d65fee5ea88e8092a1e5cba0a164076f79ea199

See more details on using hashes here.

File details

Details for the file nerblackbox-0.0.7-py3-none-any.whl.

File metadata

  • Download URL: nerblackbox-0.0.7-py3-none-any.whl
  • Upload date:
  • Size: 67.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/47.3.2 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.7.7

File hashes

Hashes for nerblackbox-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 7d797718515033760f70defb3295ebf53f013f58d40447ea73af7b4b66172aa4
MD5 9561d03a0d70ea7549da5c30db714794
BLAKE2b-256 a182fc8251cad4d74de6f0fa244ec759a51067cb28b592a43ff4f985a6dbe672

See more details on using hashes here.

Supported by

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