labelme README

The project's README from github.com/wkentaro/labelme. As one markdown file: README.md.


labelme

Image annotation with Python.

Installation | Usage | Examples | labelme.io ↗

Description

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.

Looking for a simple install without Python or Qt? Get the standalone app at labelme.io.


VOC dataset example of instance segmentation.


Other examples (semantic segmentation, bbox detection, and classification).


Various primitives (polygon, rectangle, circle, line, and point).

Multi-language support (English, 中文, 日本語, 한국어, Deutsch, Français, and more).

Features

🌏 Available in 20 languages - English · 日本語 · 한국어 · 简体中文 · 繁體中文 · Deutsch · Ελληνικά · Français · Español · Italiano · Português · Nederlands · Magyar · Русский · ไทย · Tiếng Việt · Türkçe · Українська · Polski · فارسی (LANG=ja_JP.UTF-8 labelme)

Installation

There are 3 options to install labelme:

Option 1: Using pip

For more detail, check "Install Labelme using Terminal"

pip install labelme

# To install the latest version from GitHub:
# pip install git+https://github.com/wkentaro/labelme.git

Option 2: Using standalone executable (Easiest)

If you're willing to invest in the convenience of simple installation without any dependencies (Python, Qt), you can download the standalone executable from "Install Labelme as App".

It's a one-time payment for lifetime access, and it helps us to maintain this project.

Option 3: Linux distribution packages

On some Linux distributions, labelme is also packaged in the system's native repository and can be installed with the distribution's standard package tooling. The badge below tracks which distributions currently ship labelme and which version each one provides:

Packaging status

Supported Python and platforms

Supported (v7.x) Maintenance (v6.3.x)
Python 3.12 - 3.14 3.10 - 3.11
Qt Qt6 (PySide6) Qt5
OS 64-bit macOS / Windows / Linux older OSes

labelme follows SPEC 0 (the successor to NEP 29) for dropping Python versions, in step with its core scientific dependencies (numpy, scipy, scikit-image). v6.3.x is the maintenance line for Qt5 and Python 3.10 / 3.11 stragglers.

v6.3.x receives critical fixes only, on a best-effort basis with no release cadence or SLA. "Critical" is limited to:

Feature backports and non-critical bugs are out of scope; all new development happens on v7.x.

Upgrading from v6.x to v7

v7.0.0 raises the platform floor:

If you need to stay on PyQt5/Qt5, Python 3.10 or 3.11, or an older OS, pin to the v6.3.x maintenance line:

pip install 'labelme<7'

All previous releases remain installable from PyPI, so existing pins keep working.

v7.0.0 also changes config parsing:

Public interface

labelme is an application. The interfaces you can build on and that we keep stable are:

Everything else, including the Python import surface, is internal and may change or be renamed without notice. To consume annotations from your own code, read the JSON format directly (see examples/utils.py).

Usage

Run labelme --help for detail.
The annotations are saved as a JSON file.

labelme  # just open gui

# tutorial (single image example)
cd examples/tutorial
labelme apc2016_obj3.jpg  # specify image file
labelme apc2016_obj3.jpg --output annotations/  # save annotation JSON files to a directory
labelme apc2016_obj3.jpg --with-image-data  # include image data in JSON file
labelme apc2016_obj3.jpg \
  --labels highland_6539_self_stick_notes,mead_index_cards,kong_air_dog_squeakair_tennis_ball  # specify label list

# semantic segmentation example
cd examples/semantic_segmentation
labelme data_annotated/  # Open directory to annotate all images in it
labelme data_annotated/ --labels labels.txt  # specify label list with a file

Command Line Arguments

Run labelme --help for the full list.

FAQ

Examples

How to build standalone executable

LABELME_PATH=./labelme
OSAM_PATH=$(python -c 'import os, osam; print(os.path.dirname(osam.__file__))')
pyinstaller labelme/labelme/__main__.py \
  --name=Labelme \
  --windowed \
  --noconfirm \
  --specpath=build \
  --add-data=$(OSAM_PATH)/_models/yoloworld/clip/bpe_simple_vocab_16e6.txt.gz:osam/_models/yoloworld/clip \
  --add-data=$(LABELME_PATH)/_config/default_config.yaml:labelme/_config \
  --add-data=$(LABELME_PATH)/icons/*:labelme/icons \
  --add-data=$(LABELME_PATH)/translate/*:translate \
  --icon=$(LABELME_PATH)/icons/icon-256.png \
  --onedir

Acknowledgement

This repo is the fork of mpitid/pylabelme.

labelme (wkentaro/labelme)

instance-segmentation
Searching Database…

16.2K ·GitHub
What is this?Labelme is a graphical image annotation tool written in Python: you draw polygons, rectangles, circles, lines and points on images to build labeled datasets for computer vision work.
Is it a desktop app or a Python library I import into my code?It is a desktop application, not a library — v7 exposes no stable Python API. The stable interfaces are the command line, the on-disk JSON annotation format, and the ~/.labelmerc config file.
Do I need Python and Qt set up beforehand?For the pip install you need Python 3.12-3.14 on 64-bit macOS, Windows or Linux; v7 runs on Qt6, which pip pulls in automatically as PySide6. The standalone app needs no Python or Qt at all.
I am still on Python 3.11 or an older machine — will it run?Not on v7: it requires 64-bit systems and Python 3.12+. For older OSes or Python 3.10/3.11, pin the v6.3.x maintenance line (Qt5), which gets critical fixes only, on a best-effort basis.
Can the AI models do some of the annotation work for me?Yes. SAM and EfficientSAM turn a clicked point into polygon or mask annotations, and YOLO-world and SAM3 models generate annotations from a text prompt, which can speed up labeling large datasets considerably.
Is the interface available in languages other than English?Yes, it ships in 20 languages, including Japanese, Simplified and Traditional Chinese, Korean, German, French, Spanish and Russian; the language can be switched via the LANG environment variable.
What is the paid standalone app on labelme.io about?It is the same tool packaged as a downloadable executable that needs no Python or Qt installed. It is a one-time payment for lifetime access, and purchases help maintain the project — the pip version stays free.
How do I turn the JSON files into something my training code can use?Read the JSON format directly — it is one of the stable public interfaces. The repo's examples/tutorial shows how to convert annotations to numpy arrays and load label PNGs, with further examples for segmentation, detection and classification.
Creator
wkentaro
Size
61.8 MB
Stars
16.2K
Age
10y
Commits · 90 Days