https://github.com/janfreyberg/superintendent

Practical active learning in python
https://github.com/janfreyberg/superintendent

Last synced: 9 days ago
JSON representation

Practical active learning in python

• Host: GitHub
• URL: https://github.com/janfreyberg/superintendent
• Owner: janfreyberg
• Created: 2017-11-27T09:23:06.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2022-09-22T21:58:32.000Z (over 2 years ago)
• Last Synced: 2025-03-30T10:09:08.660Z (16 days ago)
• Language: Python
• Homepage: https://superintendent.readthedocs.io
• Size: 6.42 MB
• Stars: 189
• Watchers: 11
• Forks: 18
• Open Issues: 12
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-production-machine-learning - Superintendent - superintendent provides an ipywidget-based interactive labelling tool for your data. (Data Labelling and Synthesis)

README

        
# Superintendent

[![PyPI version](https://badge.fury.io/py/superintendent.svg)](https://badge.fury.io/py/superintendent)

[![Tests](https://github.com/janfreyberg/superintendent/actions/workflows/test.yml/badge.svg)](https://github.com/janfreyberg/superintendent/actions/workflows/test.yml)

[![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/).