Skip to main content

Annotate data in jupyter notebooks.

Project description

ipyannotations: create rich annotations in jupyter notebooks.

Documentation Status travis CI build Coverage Status Launch Binder

The ipyannotations library is designed to let you create rich annotations for your data (currently, primarily images) inside jupyter notebooks. It lets you leverage the rich jupyter display system from python. It was designed to integrate with superintendent, but does not need to.

For example, draw polygons onto images for your machine learning applications:



Start by installing ipyannotations:

$ pip install ipyannotations

If you are using Jupyter Lab, rather than the old Jupyter Notebook application, you will also have to install two Jupyter Lab extensions:

Jupyter Lab extensions

$ jupyter labextension install @jupyter-widgets/jupyterlab-manager ipycanvas
$ jupyter lab build

ipyannotations development

It's super helpful to have other people contribute to projects like this, so please fork this repository and make pull requests!

ipyannotations uses flit to manage the packaging, so the easiest way to use it is to set up a virtual environment, install ipyannotations as a symlink, and go from there:

git clone<your-username>/ipyannotations.git && cd ipyannotations
pre-commit install
python -m venv .venv
flit install --symlink --python .venv/bin/python
jupyter labextension install @jupyter-widgets/jupyterlab-manager ipycanvas
jupyter lab build

Project details

Download files

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

Files for ipyannotations, version 0.2.1
Filename, size File type Python version Upload date Hashes
Filename, size ipyannotations-0.2.1-py3-none-any.whl (17.3 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size ipyannotations-0.2.1.tar.gz (6.7 MB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page