From eb81c8785cd7e59a13ac377bb4c15cba04611d8b Mon Sep 17 00:00:00 2001 From: Kentaro Wada Date: Thu, 9 Jan 2025 20:43:52 +0900 Subject: [PATCH] Update README.md --- README.md | 85 +++++++++---------------------------------------------- 1 file changed, 13 insertions(+), 72 deletions(-) diff --git a/README.md b/README.md index 549919bea..2a7b1e5a4 100644 --- a/README.md +++ b/README.md @@ -9,15 +9,14 @@
- +
- Starter Guide - | Installation + Installation | Usage | Examples - +
@@ -45,89 +44,31 @@ It is written in Python and uses Qt for its graphical interface. ## Features - [x] Image annotation for polygon, rectangle, circle, line and point. ([tutorial](examples/tutorial)) -- [x] Image flag annotation for classification and cleaning. ([#166](https://github.com/labelmeai/labelme/pull/166)) +- [x] Image flag annotation for classification and cleaning. ([#166](https://github.com/wkentaro/labelme/pull/166)) - [x] Video annotation. ([video annotation](examples/video_annotation)) -- [x] GUI customization (predefined labels / flags, auto-saving, label validation, etc). ([#144](https://github.com/labelmeai/labelme/pull/144)) +- [x] GUI customization (predefined labels / flags, auto-saving, label validation, etc). ([#144](https://github.com/wkentaro/labelme/pull/144)) - [x] Exporting VOC-format dataset for semantic/instance segmentation. ([semantic segmentation](examples/semantic_segmentation), [instance segmentation](examples/instance_segmentation)) - [x] Exporting COCO-format dataset for instance segmentation. ([instance segmentation](examples/instance_segmentation)) -## Starter Guide - -If you're new to Labelme, you can get started with [Labelme Starter](https://labelme.io/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: +There are 2 options to install labelme: -- Platform agnostic installation: [Anaconda](#anaconda) -- Platform specific installation: [Ubuntu](#ubuntu), [macOS](#macos), [Windows](#windows) -- Pre-build binaries from [the release section](https://github.com/labelmeai/labelme/releases) +### Option 1: Using pip -### Anaconda - -You need install [Anaconda](https://www.continuum.io/downloads), then run below: +For more detail, check ["Install Labelme using Pip"](https://www.labelme.io/docs/install-labelme-pip). ```bash -# 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 - -```bash -sudo apt-get install labelme +### Option 2: Using standalone executable (Easiest) -# or -sudo pip3 install labelme +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"](https://www.labelme.io/docs/install-labelme-app). -# or install standalone executable from: -# https://github.com/labelmeai/labelme/releases - -# or install from source -pip3 install git+https://github.com/labelmeai/labelme -``` - -### macOS - -```bash -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](https://www.continuum.io/downloads), then in an Anaconda Prompt run: - -```bash -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 -``` +It's a one-time payment for lifetime access, and it helps us to maintain this project. ## Usage @@ -178,7 +119,7 @@ labelme data_annotated/ --labels labels.txt # specify label list with a file ## How to develop ```bash -git clone https://github.com/labelmeai/labelme.git +git clone https://github.com/wkentaro/labelme.git cd labelme # Install anaconda3 and labelme