Metadata-Version: 2.1
Name: superintendent
Version: 0.4.2
Summary: Interactive machine learning supervision.
Home-page: https://www.janfreyberg.com/superintendent
License: MIT
Keywords: widgets,labelling,annotation
Author: Jan Freyberg
Author-email: jan.freyberg@gmail.com
Requires-Python: >=3.5,<4.0
Classifier: Framework :: Jupyter
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Dist: bs4[examples] (>=0.0.1,<0.0.2)
Requires-Dist: cachetools (>=3.1,<4.0)
Requires-Dist: flask (>=1.0,<2.0)
Requires-Dist: html5lib[examples] (>=1.0,<2.0)
Requires-Dist: hypothesis[tests] (>=4.17,<5.0)
Requires-Dist: ipyevents (>=0.4.1,<0.5.0)
Requires-Dist: ipywidgets (>=7.4,<8.0)
Requires-Dist: jupyter[tests] (>=1.0,<2.0)
Requires-Dist: jupyter_sphinx[documentation] (>=0.1.4,<0.2.0)
Requires-Dist: m2r[documentation] (>=0.2.1,<0.3.0)
Requires-Dist: matplotlib (>=3.0,<4.0)
Requires-Dist: nbconvert[tests] (>=5.4,<6.0)
Requires-Dist: nbsphinx[documentation] (>=0.4.2,<0.5.0)
Requires-Dist: numpy (>=1.16,<2.0)
Requires-Dist: pandas (>=0.24.2,<0.25.0)
Requires-Dist: psycopg2-binary (>=2.8,<3.0)
Requires-Dist: pytest-helpers-namespace[tests] (>=2019.1,<2020.0)
Requires-Dist: pytest-mock[tests] (>=1.10,<2.0)
Requires-Dist: pytest[tests] (>=4.4,<5.0)
Requires-Dist: requests[examples] (>=2.21,<3.0)
Requires-Dist: schedule (>=0.6.0,<0.7.0)
Requires-Dist: scikit-learn (>=0.20.3,<0.21.0)
Requires-Dist: scipy (>=1.2,<2.0)
Requires-Dist: sphinx[documentation] (>=2.0,<3.0)
Requires-Dist: sphinx_rtd_theme[documentation] (>=0.4.3,<0.5.0)
Requires-Dist: sqlalchemy (>=1.3,<2.0)
Requires-Dist: wordcloud[examples] (>=1.5,<2.0)
Project-URL: Repository, https://github.com/janfreyberg/superintendent
Description-Content-Type: text/markdown

# Superintendent

[![Build Status](https://travis-ci.org/janfreyberg/superintendent.svg?branch=master)](https://travis-ci.org/janfreyberg/superintendent)
[![PyPI version](https://badge.fury.io/py/superintendent.svg)](https://badge.fury.io/py/superintendent)
[![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)
![Python versions](https://img.shields.io/badge/python-3.5%2B-blue.svg)


---

![](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]`

