README.md

labelme: Image Annotation Tool with Python
==========================================

[![Build Status](https://travis-ci.org/wkentaro/labelme.svg?branch=master)](https://travis-ci.org/wkentaro/labelme)


Labelme is a graphical image annotation tool inspired by <http://labelme.csail.mit.edu>.

It is written in Python and uses Qt for its graphical interface.


Dependencies
------------

- [PyQt4](http://www.riverbankcomputing.co.uk/software/pyqt/intro)


Installation
------------

On Ubuntu:

```bash
sudo apt-get install python-qt4 pyqt4-dev-tools

sudo pip install labelme
```

On OS X:

```bash
brew install qt qt4

pip install labelme
```

On macOS Sierra:

```bash
brew install pyqt5

pip install git+https://github.com/wkentaro/labelme.git@pyqt5
```

Docker:

You need install [docker](https://www.docker.com), and please follow below section
for usage of `labelme_draw_json`.


Usage
-----

**Annotation**

Run `labelme --help` for detail.

```bash
labelme  # Open GUI
labelme _static/IMG_6319.jpg  # Specify file
labelme _static/IMG_6319.jpg -O _static/IMG_6319.json  # Close window after the save
```

If you are installed [docker](https://www.docker.com), you can run:

```bash
# Maybe you need http://sourabhbajaj.com/blog/2017/02/07/gui-applications-docker-mac/ on macOS
labelme_on_docker _static/IMG_6319.jpg -O _static/IMG_6319.json
```

The annotations are saved as a [JSON](http://www.json.org/) file. The
file includes the image itself.

**Visualization**

To view the json file quickly, you can use utility script:

```bash
labelme_draw_json _static/IMG_6319.json
```

**Convert to Dataset**

To convert the json to set of image and label, you can run following:


```bash
labelme_json_to_dataset _static/IMG_6319.json
```


Sample
------

- [Original Image](https://github.com/wkentaro/labelme/blob/master/_static/IMG_6319.jpg)
- [Screenshot](https://github.com/wkentaro/labelme/blob/master/_static/IMG_6319_screenshot.png)
- [Generated Json File](https://github.com/wkentaro/labelme/blob/master/_static/IMG_6319.json)
- [Visualized Json File](https://github.com/wkentaro/labelme/blob/master/_static/IMG_6319_draw_json.png)


Screencast
----------

<img src="https://github.com/wkentaro/labelme/raw/master/_static/screencast.gif" width="70%"/>