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)

Searching Database…

16.2K ·GitHub
这是干什么的?Labelme 是一个用 Python 编写的图形化图像标注工具:你可以在图片上绘制多边形、矩形、圆形、直线和点,为计算机视觉工作构建带标签的数据集。
它是一个桌面应用,还是我能在代码里导入的 Python 库?它是一个桌面应用,不是库——v7 没有提供稳定的 Python API。稳定的接口是命令行、磁盘上的 JSON 标注格式,以及 ~/.labelmerc 配置文件。
我需要提前装好 Python 和 Qt 吗?用 pip 安装的话,需要 64 位的 macOS、Windows 或 Linux,且 Python 版本为 3.12-3.14;v7 基于 Qt6 运行,pip 会自动把它作为 PySide6 一并装上。独立版应用则完全不需要 Python 和 Qt。
我还在用 Python 3.11 或更旧的机器——它能跑起来吗?在 v7 上不行:它要求 64 位系统和 Python 3.12 及以上版本。如果是较旧的操作系统或 Python 3.10/3.11,请固定使用 v6.3.x 维护版本(基于 Qt5),它只提供关键修复,且是尽力而为的支持。
AI 模型能帮我完成一部分标注工作吗?可以。SAM 和 EfficientSAM 能把单击的一个点变成多边形或掩膜标注,YOLO-world 和 SAM3 模型则能根据文字提示生成标注,这能大大加快大型数据集的标注速度。
界面有英语以外的语言吗?有,它内置 20 种语言,包括日语、简体中文和繁体中文、韩语、德语、法语、西班牙语和俄语;可以通过 LANG 环境变量切换语言。
labelme.io 上的付费独立版应用是怎么回事?它是同一个工具打包成的可下载可执行文件,无需安装 Python 或 Qt。只需一次性付费即可永久使用,购买也能帮助维护这个项目——pip 版本仍然是免费的。
我怎么把这些 JSON 文件转换成训练代码能用的格式?直接读取 JSON 格式即可——它本身就是稳定的公开接口之一。仓库的 examples/tutorial 展示了如何把标注转换成 numpy 数组以及加载 label PNG,另外还有分割、检测和分类的更多示例。
Creator
wkentaro
Size
61.6 MB
Stars
16.2K
Age
10y
Commits · 90 Days