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 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.6.tar.gz (43.5 kB view details)

Uploaded Source

Built Distribution

nerblackbox-0.0.6-py3-none-any.whl (64.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nerblackbox-0.0.6.tar.gz
  • Upload date:
  • Size: 43.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.0 requests/2.24.0 setuptools/47.3.2 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.7.7

File hashes

Hashes for nerblackbox-0.0.6.tar.gz
Algorithm Hash digest
SHA256 730abac89306822114e629f67c0c3546a54f346998cc577e44332be182f15fba
MD5 7280200e00e1cc43ef62fad7b9117395
BLAKE2b-256 787c045ad697ed708b828071a943a094bb08ca1ca01c1dee297d2af3f604ab2c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nerblackbox-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 64.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.0 requests/2.24.0 setuptools/47.3.2 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.7.7

File hashes

Hashes for nerblackbox-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 8cfa5132045e254ba0e3102992b1e0cbd471061a416112f00ecdf56a64452222
MD5 d5fd88af9cec3fcd1769069a67945754
BLAKE2b-256 756152538a17187108676b8cbe816a4fb588e9e1f7793aa7c7fb88200b908163

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