Metadata-Version: 2.1
Name: superintendent
Version: 0.6.0rc1
Summary: Interactive machine learning supervision.
Home-page: https://github.com/janfreyberg/superintendent
License: MIT
Keywords: widgets labelling annotation
Author: Jan Freyberg
Author-email: jan.freyberg@gmail.com
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Science/Research
Classifier: Framework :: Jupyter
Requires-Dist: ipywidgets>=7.4
Requires-Dist: numpy>=1.15
Requires-Dist: pandas>=0.24.0
Requires-Dist: scikit-learn>=0.20.3
Requires-Dist: scipy>=1.2
Requires-Dist: schedule>=0.6.0
Requires-Dist: sqlalchemy>=1.3
Requires-Dist: Pillow
Requires-Dist: cachetools>=3.1
Requires-Dist: psycopg2-binary>=2.8
Requires-Dist: flask>=1.0
Requires-Dist: ipyevents>=0.6.0
Requires-Dist: typing-extensions
Requires-Dist: sqlmodel
Requires-Dist: codetiming>=1.3.0
Requires-Dist: jupyterlab>=3.0 ; extra == "dev"
Requires-Dist: rope ; extra == "dev"
Requires-Dist: sphinx>=4.0 ; extra == "doc"
Requires-Dist: requests>=2.21 ; extra == "doc"
Requires-Dist: html5lib>=1.0 ; extra == "doc"
Requires-Dist: bs4>=0.0.1 ; extra == "doc"
Requires-Dist: wordcloud>=1.5 ; extra == "doc"
Requires-Dist: myst-parser>=0.18.0 ; extra == "doc"
Requires-Dist: sphinx_rtd_theme>=0.4.3 ; extra == "doc"
Requires-Dist: jupyter-sphinx>=0.1.4 ; extra == "doc"
Requires-Dist: nbsphinx>=0.4.2 ; extra == "doc"
Requires-Dist: sphinx-automodapi ; extra == "doc"
Requires-Dist: ipyannotations>=0.5.1 ; extra == "doc"
Requires-Dist: requests>=2.21 ; extra == "examples"
Requires-Dist: html5lib>=1.0 ; extra == "examples"
Requires-Dist: bs4>=0.0.1 ; extra == "examples"
Requires-Dist: wordcloud>=1.5 ; extra == "examples"
Requires-Dist: isort>=4.3.21 ; extra == "test"
Requires-Dist: pytest>=4.1 ; extra == "test"
Requires-Dist: pytest-cov>=2.6 ; extra == "test"
Requires-Dist: hypothesis>=4.17 ; extra == "test"
Requires-Dist: pytest-helpers-namespace>=2019.1 ; extra == "test"
Requires-Dist: pytest-mock>=1.10 ; extra == "test"
Requires-Dist: nbconvert>=5.4 ; extra == "test"
Requires-Dist: coveralls>=1.7 ; extra == "test"
Requires-Dist: docargs>=0.2.0 ; extra == "test"
Requires-Dist: black>=19.3b0 ; extra == "test"
Requires-Dist: flake8>=3.7 ; extra == "test"
Requires-Dist: mypy ; extra == "test"
Requires-Dist: types-cachetools ; extra == "test"
Provides-Extra: dev
Provides-Extra: doc
Provides-Extra: examples
Provides-Extra: test

# Superintendent

[![PyPI version](https://badge.fury.io/py/superintendent.svg)](https://badge.fury.io/py/superintendent)
![Unit tests and linting](https://github.com/janfreyberg/superintendent/workflows/Unit%20tests%20and%20linting/badge.svg)
[![Documentation Status](https://readthedocs.org/projects/superintendent/badge/?version=latest)](https://superintendent.readthedocs.io/en/latest/?badge=latest)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/janfreyberg/superintendent/master)
[![Coverage Status](https://coveralls.io/repos/github/janfreyberg/superintendent/badge.svg)](https://coveralls.io/github/janfreyberg/superintendent)


---

![](docs/img/logo.png)

**`superintendent`** provides an `ipywidget`-based interactive labelling tool
for your data. It allows you to flexibly label all kinds of data. It also allows
you to combine your data-labelling task with a statistical or machine learning
model to enable quick and practical active learning.

## Getting started

Take a look at the documentation: http://www.janfreyberg.com/superintendent/

It has some explanations of how the library works, and it also has many
examples.

If you'd like to try the library without installing it, check out the
[repository on binder](https://mybinder.org/v2/gh/janfreyberg/superintendent/master?filepath=examples.ipynb).

## Installation

```
pip install superintendent
```

If you want to also use the keyboard shortcuts for labelling faster, you will
also have to enable the ipyevents jupyter extension:

```
jupyter nbextension enable --py --sys-prefix ipyevents
```

If you also want to run the examples, you need three additional packages:
`requests`, `bs4` and `wordcloud`. You can install them via pip by running:

```
pip install superintendent[examples]
```

If you want to contribute to `superintendent`, you will need to install the test
dependencies as well. You can do so with
`pip install superintendent[tests,examples]`


## Acknowledgements

Much of the initial work on `superintendent` was done during my time at
[Faculty AI](https://faculty.ai/).

