Skip to main content

nertk - Name Entity Recognition toolkit

Entator class - Annotate name entities in text inline within your Jupyter notebook in Python.

1 - Overview

In a data science or machine learning project, you may prepare and study text with name entities within a Jupyter notebook then need to annotate the data to augment the training or fix errors in your source data.

Since you are already working within a Jupyter notebook, the Entator works inline allowing you to interact with your data and annotate it quickly and easily, syncing straight back to your input data arrays or matrices.

Within Jupyter, you can easily home in on problem input data - perhaps only misclassified entity - so you can step through and adjust token type just for those items.

The Entator widget is designed with a flexible API making it quick and easy to get started exploring your dataset, guessing how to work with your data without explicit configuration where possible.

The project is currently in ALPHA development phase, and I appreciate all feedback on any problems including details on how the current code works or fails to work for the structure of your particular projects.

2 - Examples

You can easily combine Entator's interactive components to suit your project. Here are some examples.

Annotate new samples

Then set up Entator to display buttons for each label and each word in the text, click on button to change the label.

from nertk import Entator
annotator = Entator(labels=['other','person','location'],
                    inputs=[['John','is','going','to','Germany','tomorrow','.']])
annotator.run()

#get annotation
annotator.targets

Screenshot of Enttor widget in Jupyter

Correct annotated samples

from nertk import Entator
annotator = Entator(labels=['other','person','location'],
                    inputs=[['John','is','going','to','Germany','tomorrow','.']],
                    targets=[['person', 'other', 'other', 'other', 'location', 'other', 'other']])
annotator.run()

#get annotation
annotator.targets

3 - Installation

Install from PyPi (recommended)

pip install nertk

4 - Contact for Feedback

Please get in touch with any feedback or questions: Linkedin. It will be especially useful to understand the structure of your project and what is needed for your data annotation - e.g. extra entity types. There are many ideas on the roadmap, and your input is vital for prioritising these.

5 - License

This code is released under an MIT license.

Metadata

Release files for nertk 0.0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nertk 0.0.4
File Size Uploaded Provenance
nertk-0.0.4.tar.gz 3.9 kB Without provenance Details

Release files / nertk-0.0.4.tar.gz

Download URL nertk-0.0.4.tar.gz
Size 3.9 kB
Tags Source
SHA-256 checksum
How to use checksums
f31feff02f592c46a067920fe54fcbd958816df4769c58f4b6534e3d397fb36b
BLAKE2b-256 checksum
How to use checksums
765a25e427a5d8d4c739f3745e9e9e5e7a95da518c10c9cbc579696b29b8a6bb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.5.0.1 requests/2.25.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6

Security for nertk 0.0.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page