labelme
Image Polygonal Annotation with Python (polygon, rectangle, circle, line, point and image-level flag annotation).
Top Related Projects
LabelImg is now part of the Label Studio community. The popular image annotation tool created by Tzutalin is no longer actively being developed, but you can check out Label Studio, the open source data labeling tool for images, text, hypertext, audio, video and time-series data.
Visual Object Tagging Tool: An electron app for building end to end Object Detection Models from Images and Videos.
Annotate better with CVAT, the industry-leading data engine for machine learning. Used and trusted by teams at any scale, for data of any scale.
Label Studio is a multi-type data labeling and annotation tool with standardized output format
Open source annotation tool for machine learning practitioners.
Quick Overview
Labelme is an image annotation tool inspired by the original LabelMe project. It provides a graphical user interface for annotating images with polygonal, rectangular, circular, line, and point annotations. The tool is designed to be simple, flexible, and supports various image formats.
Pros
- User-friendly interface for easy image annotation
- Supports multiple annotation types (polygons, rectangles, circles, lines, points)
- Cross-platform compatibility (Windows, macOS, Linux)
- Exports annotations in various formats (JSON, YOLO, VOC XML)
Cons
- Limited advanced features compared to some commercial annotation tools
- May experience performance issues with very large datasets
- Requires manual installation of dependencies on some systems
- Limited built-in support for semi-automatic or automatic annotation
Code Examples
- Installing labelme:
pip install labelme
- Running labelme from the command line:
labelme
- Converting labelme JSON to PASCAL VOC format:
import labelme2voc
labelme2voc.convert_dataset(
input_dir="path/to/labelme/json/files",
output_dir="path/to/output/voc/dataset",
labels_file="path/to/labels.txt"
)
- Loading a labelme JSON file in Python:
import json
import labelme.utils
with open("path/to/labelme/json/file.json", "r") as f:
data = json.load(f)
img = labelme.utils.img_b64_to_arr(data["imageData"])
shapes = data["shapes"]
Getting Started
- Install labelme:
pip install labelme
- Launch the labelme GUI:
labelme
-
Open an image and start annotating using the tools provided in the interface.
-
Save your annotations as a JSON file.
-
(Optional) Convert annotations to other formats using provided scripts or custom code.
Competitor Comparisons
LabelImg is now part of the Label Studio community. The popular image annotation tool created by Tzutalin is no longer actively being developed, but you can check out Label Studio, the open source data labeling tool for images, text, hypertext, audio, video and time-series data.
Pros of labelImg
- Simpler interface, focusing primarily on bounding box annotations
- Faster performance for basic labeling tasks
- Supports YOLO format natively
Cons of labelImg
- Limited annotation types (mainly bounding boxes)
- Less extensive documentation and community support
- Fewer advanced features for complex labeling tasks
Code Comparison
labelImg:
def saveFile(self, _value=False):
if self.filePath:
try:
self.saveLabels(self.filePath)
self.setClean()
return True
except:
self.errorMessage(u'Error saving file')
return False
return self.saveFileAs()
labelme:
def save_labels(self, filename):
if self.output_dir:
lblsave(filename, self.canvas.shapes, self.imagePath, self.imageData,
self.lineColor.getRgb(), self.fillColor.getRgb(),
self.otherData)
self.setDirty(False)
labelImg focuses on a straightforward saving process, while labelme incorporates more parameters and flexibility in its save function. This reflects the overall design philosophy of each tool, with labelImg prioritizing simplicity and labelme offering more advanced features and customization options.
Visual Object Tagging Tool: An electron app for building end to end Object Detection Models from Images and Videos.
Pros of VoTT
- More comprehensive UI with a wider range of annotation tools
- Supports multiple export formats, including COCO, Pascal VOC, and TFRecords
- Integrates with cloud storage services like Azure Blob Storage
Cons of VoTT
- Steeper learning curve due to more complex interface
- Requires more system resources, potentially slower on older machines
- Less focus on simplicity and quick setup compared to labelme
Code Comparison
labelme:
import labelme
from labelme import utils
img = utils.img_data_to_arr(img_data)
labels, shapes, _ = labelme.LabelFile.load_image_shapes(json_file)
VoTT:
import { Env } from "vott-react";
import { AssetService } from "vott-react/lib/services/assetService";
const assetService = new AssetService(Env.getAssetServiceUrl());
const assets = await assetService.getAssets(projectId);
Summary
VoTT offers a more feature-rich annotation tool with cloud integration and multiple export formats, making it suitable for larger projects. However, it may be overkill for simpler tasks. labelme provides a straightforward, lightweight solution for quick image annotation, but lacks some advanced features and export options found in VoTT.
Annotate better with CVAT, the industry-leading data engine for machine learning. Used and trusted by teams at any scale, for data of any scale.
Pros of CVAT
- More comprehensive annotation tool with support for various tasks (object detection, segmentation, classification)
- Collaborative features for team-based annotation projects
- Supports video annotation and tracking
Cons of CVAT
- More complex setup and infrastructure requirements
- Steeper learning curve for new users
- Requires more system resources to run
Code Comparison
CVAT (Python):
from cvat_sdk import make_client
from cvat_sdk.core.proxies.tasks import ResourceType
client = make_client("https://your-cvat-server.com")
client.tasks.create(
name="My Task",
labels=[{"name": "car"}, {"name": "person"}],
resource_type=ResourceType.LOCAL,
resources=["path/to/image.jpg"],
)
Labelme (Python):
import labelme
labelme.main()
Summary
CVAT offers a more feature-rich and collaborative annotation platform suitable for larger projects and teams, while Labelme provides a simpler, lightweight solution for basic image annotation tasks. CVAT's setup is more complex but offers greater flexibility, whereas Labelme is easier to get started with but has limited functionality compared to CVAT.
Label Studio is a multi-type data labeling and annotation tool with standardized output format
Pros of Label Studio
- More comprehensive and feature-rich, supporting a wider range of data types and labeling tasks
- Offers a web-based interface, making it easier to collaborate and manage large-scale projects
- Provides advanced project management features and integrations with popular ML frameworks
Cons of Label Studio
- More complex setup and configuration compared to Labelme's simpler approach
- Steeper learning curve for new users due to its extensive feature set
- Requires more system resources to run, especially for larger projects
Code Comparison
Labelme (Python):
import labelme
from labelme import utils
img = utils.img_data_to_arr(img_data)
labels, shapes, _ = labelme.LabelFile.load_image_shapes(json_file)
Label Studio (JavaScript):
import LabelStudio from 'label-studio';
const labelStudio = new LabelStudio('label-studio', {
config: `<View><Image name="img" value="$image"/></View>`,
interfaces: ["panel", "update", "submit"],
task: { annotations: [], predictions: [], data: { image: "url" } }
});
Both projects serve as annotation tools, but Label Studio offers a more comprehensive solution for diverse labeling needs, while Labelme provides a simpler, lightweight option for basic image annotation tasks.
Open source annotation tool for machine learning practitioners.
Pros of doccano
- Supports a wider range of annotation types, including text classification, sequence labeling, and document classification
- Offers a collaborative annotation environment with user management and role-based access control
- Provides a RESTful API for integration with other systems and workflows
Cons of doccano
- Requires more setup and configuration compared to labelme's simpler installation process
- Has a steeper learning curve due to its more complex feature set
- May be overkill for simple image annotation tasks that labelme handles efficiently
Code comparison
labelme:
import labelme
from labelme import utils
img = utils.img_data_to_arr(img_data)
labels, shapes, _ = labelme.LabelFile.load_image_shapes(json_file)
doccano:
from doccano_api_client import DoccanoClient
client = DoccanoClient(base_url='http://localhost:8000')
client.login(username='admin', password='password')
project = client.get_project(project_id=1)
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
labelme
Image Polygonal Annotation with Python
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.
VOC dataset example of instance segmentation.
Other examples (semantic segmentation, bbox detection, and classification).
Various primitives (polygon, rectangle, circle, line, and point).
Features
- Image annotation for polygon, rectangle, circle, line and point. (tutorial)
- Image flag annotation for classification and cleaning. (#166)
- Video annotation. (video annotation)
- GUI customization (predefined labels / flags, auto-saving, label validation, etc). (#144)
- Exporting VOC-format dataset for semantic/instance segmentation. (semantic segmentation, instance segmentation)
- Exporting COCO-format dataset for instance segmentation. (instance segmentation)
Starter Guide
If you're new to Labelme, you can get started with Labelme Starter, which contains:
- Installation guides for all platforms: Windows, macOS, and Linux ð»
- Step-by-step tutorials: first annotation to editing, exporting, and integrating with other programs ð
- A compilation of valuable resources for further exploration ð.
Installation
There are options:
- Platform agnostic installation: Anaconda
- Platform specific installation: Ubuntu, macOS, Windows
- Pre-build binaries from the release section
Anaconda
You need install Anaconda, then run below:
# python3
conda create --name=labelme python=3
source activate labelme
# conda install -c conda-forge pyside2
# conda install pyqt
# pip install pyqt5 # pyqt5 can be installed via pip on python3
pip install labelme
# or you can install everything by conda command
# conda install labelme -c conda-forge
Ubuntu
sudo apt-get install labelme
# or
sudo pip3 install labelme
# or install standalone executable from:
# https://github.com/labelmeai/labelme/releases
# or install from source
pip3 install git+https://github.com/labelmeai/labelme
macOS
brew install pyqt # maybe pyqt5
pip install labelme
# or install standalone executable/app from:
# https://github.com/labelmeai/labelme/releases
# or install from source
pip3 install git+https://github.com/labelmeai/labelme
Windows
Install Anaconda, then in an Anaconda Prompt run:
conda create --name=labelme python=3
conda activate labelme
pip install labelme
# or install standalone executable/app from:
# https://github.com/labelmeai/labelme/releases
# or install from source
pip3 install git+https://github.com/labelmeai/labelme
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 -O apc2016_obj3.json # close window after the save
labelme apc2016_obj3.jpg --nodata # not include image data but relative image path 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
--output
specifies the location that annotations will be written to. If the location ends with .json, a single annotation will be written to this file. Only one image can be annotated if a location is specified with .json. If the location does not end with .json, the program will assume it is a directory. Annotations will be stored in this directory with a name that corresponds to the image that the annotation was made on.- The first time you run labelme, it will create a config file in
~/.labelmerc
. You can edit this file and the changes will be applied the next time that you launch labelme. If you would prefer to use a config file from another location, you can specify this file with the--config
flag. - Without the
--nosortlabels
flag, the program will list labels in alphabetical order. When the program is run with this flag, it will display labels in the order that they are provided. - Flags are assigned to an entire image. Example
- Labels are assigned to a single polygon. Example
FAQ
- How to convert JSON file to numpy array? See examples/tutorial.
- How to load label PNG file? See examples/tutorial.
- How to get annotations for semantic segmentation? See examples/semantic_segmentation.
- How to get annotations for instance segmentation? See examples/instance_segmentation.
Examples
- Image Classification
- Bounding Box Detection
- Semantic Segmentation
- Instance Segmentation
- Video Annotation
How to develop
git clone https://github.com/labelmeai/labelme.git
cd labelme
# Install anaconda3 and labelme
curl -L https://github.com/wkentaro/dotfiles/raw/main/local/bin/install_anaconda3.sh | bash -s .
source .anaconda3/bin/activate
pip install -e .
How to build standalone executable
Below shows how to build the standalone executable on macOS, Linux and Windows.
# Setup conda
conda create --name labelme python=3.9
conda activate labelme
# Build the standalone executable
pip install .
pip install 'matplotlib<3.3'
pip install pyinstaller
pyinstaller labelme.spec
dist/labelme --version
How to contribute
Make sure below test passes on your environment.
See .github/workflows/ci.yml
for more detail.
pip install -r requirements-dev.txt
ruff format --check # `ruff format` to auto-fix
ruff check # `ruff check --fix` to auto-fix
MPLBACKEND='agg' pytest -vsx tests/
Acknowledgement
This repo is the fork of mpitid/pylabelme.
Top Related Projects
LabelImg is now part of the Label Studio community. The popular image annotation tool created by Tzutalin is no longer actively being developed, but you can check out Label Studio, the open source data labeling tool for images, text, hypertext, audio, video and time-series data.
Visual Object Tagging Tool: An electron app for building end to end Object Detection Models from Images and Videos.
Annotate better with CVAT, the industry-leading data engine for machine learning. Used and trusted by teams at any scale, for data of any scale.
Label Studio is a multi-type data labeling and annotation tool with standardized output format
Open source annotation tool for machine learning practitioners.
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot