<img src="https://user-images.githubusercontent.com/12534576/192582340-4c9e4401-1fe6-4dbb-95bb-fdbba5493f61.png"/>
  
[Website](https://labelstud.io/) • [Docs](https://labelstud.io/guide/) • [Twitter](https://twitter.com/labelstudiohq) • [Join Slack Community <img src="https://app.heartex.ai/docs/images/slack-mini.png" width="18px"/>](https://slack.labelstud.io/?source=github-1)
## What is Label Studio?
<!-- <a href="https://labelstud.io/blog/release-130.html"><img src="https://github.com/heartexlabs/label-studio/raw/master/docs/themes/htx/source/images/release-130/LS-Hits-v1.3.png" align="right" /></a> -->
Label Studio is an open source data labeling tool. It lets you label data types like audio, text, images, videos, and time series with a simple and straightforward UI and export to various model formats. It can be used to prepare raw data or improve existing training data to get more accurate ML models.
- [Try out Label Studio](#try-out-label-studio)
- [What you get from Label Studio](#what-you-get-from-label-studio)
- [Included templates for labeling data in Label Studio](#included-templates-for-labeling-data-in-label-studio)
- [Set up machine learning models with Label Studio](#set-up-machine-learning-models-with-Label-Studio)
- [Integrate Label Studio with your existing tools](#integrate-label-studio-with-your-existing-tools)
Have a custom dataset? You can customize Label Studio to fit your needs. Read an [introductory blog post](https://towardsdatascience.com/introducing-label-studio-a-swiss-army-knife-of-data-labeling-140c1be92881) to learn more.
## Try out Label Studio
Install Label Studio locally, or deploy it in a cloud instance. [Or, sign up for a free trial of our Enterprise edition.](https://heartex.com/free-trial).
- [Install locally with Docker](#install-locally-with-docker)
- [Run with Docker Compose (Label Studio + Nginx + PostgreSQL)](#run-with-docker-compose)
- [Install locally with pip](#install-locally-with-pip)
- [Install locally with Anaconda](#install-locally-with-anaconda)
- [Install for local development](#install-for-local-development)
- [Deploy in a cloud instance](#deploy-in-a-cloud-instance)
### Install locally with Docker
Official Label Studio docker image is [here](https://hub.docker.com/r/heartexlabs/label-studio) and it can be downloaded with `docker pull`.
Run Label Studio in a Docker container and access it at `http://localhost:8080`.
```bash
docker pull heartexlabs/label-studio:latest
docker run -it -p 8080:8080 -v $(pwd)/mydata:/label-studio/data heartexlabs/label-studio:latest
```
You can find all the generated assets, including SQLite3 database storage `label_studio.sqlite3` and uploaded files, in the `./mydata` directory.
#### Override default Docker install
You can override the default launch command by appending the new arguments:
```bash
docker run -it -p 8080:8080 -v $(pwd)/mydata:/label-studio/data heartexlabs/label-studio:latest label-studio --log-level DEBUG
```
#### Build a local image with Docker
If you want to build a local image, run:
```bash
docker build -t heartexlabs/label-studio:latest .
```
### Run with Docker Compose
Docker Compose script provides production-ready stack consisting of the following components:
- Label Studio
- [Nginx](https://www.nginx.com/) - proxy web server used to load various static data, including uploaded audio, images, etc.
- [PostgreSQL](https://www.postgresql.org/) - production-ready database that replaces less performant SQLite3.
To start using the app from `http://localhost` run this command:
```bash
docker-compose up
```
### Run with Docker Compose + MinIO
You can also run it with an additional MinIO server for local S3 storage. This is particularly useful when you want to
test the behavior with S3 storage on your local system. To start Label Studio in this way, you need to run the following command:
````bash
# Add sudo on Linux if you are not a member of the docker group
docker compose -f docker-compose.yml -f docker-compose.minio.yml up -d
````
If you do not have a static IP address, you must create an entry in your hosts file so that both Label Studio and your
browser can access the MinIO server. For more detailed instructions, please refer to [our guide on storing data](docs/source/guide/storedata.md).
### Install locally with pip
```bash
# Requires Python >=3.8
pip install label-studio
# Start the server at http://localhost:8080
label-studio
```
### Install locally with Anaconda
```bash
conda create --name label-studio
conda activate label-studio
conda install psycopg2
pip install label-studio
```
### Install for local development
You can run the latest Label Studio version locally without installing the package with pip.
```bash
# Install all package dependencies
pip install -e .
# Run database migrations
python label_studio/manage.py migrate
python label_studio/manage.py collectstatic
# Start the server in development mode at http://localhost:8080
python label_studio/manage.py runserver
```
### Deploy in a cloud instance
You can deploy Label Studio with one click in Heroku, Microsoft Azure, or Google Cloud Platform:
[<img src="https://www.herokucdn.com/deploy/button.svg" height="30px">](https://heroku.com/deploy?template=https://github.com/heartexlabs/label-studio/tree/heroku-persistent-pg)
[<img src="https://aka.ms/deploytoazurebutton" height="30px">](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fheartexlabs%2Flabel-studio%2Fmaster%2Fazuredeploy.json)
[<img src="https://deploy.cloud.run/button.svg" height="30px">](https://deploy.cloud.run)
#### Apply frontend changes
For information about updating the frontend, see [label-studio/web/README.md](https://github.com/HumanSignal/label-studio/blob/develop/web/README.md#usage-instructions).
### Troubleshoot installation
If you see any errors during installation, try to rerun the installation
```bash
pip install --ignore-installed label-studio
```
#### Install dependencies on Windows
To run Label Studio on Windows, download and install the following wheel packages from [Gohlke builds](https://www.lfd.uci.edu/~gohlke/pythonlibs) to ensure you're using the correct version of Python:
- [lxml](https://www.lfd.uci.edu/~gohlke/pythonlibs/#lxml)
```bash
# Upgrade pip
pip install -U pip
# If you're running Win64 with Python 3.8, install the packages downloaded from Gohlke:
pip install lxml‑4.5.0‑cp38‑cp38‑win_amd64.whl
# Install label studio
pip install label-studio
```
### Run test suite
To add the tests' dependencies to your local install:
```bash
pip install -r deploy/requirements-test.txt
```
Alternatively, it is possible to run the unit tests from a Docker container in which the test dependencies are installed:
```bash
make build-testing-image
make docker-testing-shell
```
In either case, to run the unit tests:
```bash
cd label_studio
# sqlite3
DJANGO_DB=sqlite DJANGO_SETTINGS_MODULE=core.settings.label_studio pytest -vv
# postgres (assumes default postgres user,db,pass. Will not work in Docker
# testing container without additional configuration)
DJANGO_DB=default DJANGO_SETTINGS_MODULE=core.settings.label_studio pytest -vv
```
## What you get from Label Studio
- **Multi-user labeling** sign up and login, when you create an annotation it's tied to your account.
- **Multiple projects** to work on all your datasets in one instance.
- **Streamlined design** helps you focus on your task, not how to use the software.
- **Configurable label formats** let you customize the visual interface to meet your specific labeling needs.
- **Support for multiple data types** including images, audio, text, HTML, time-series, and video.
- **Import from files or from cloud storage** in Amazon AWS S3, Google Cloud Storage, or JSON, CSV, TSV, RAR, and ZIP archives.
- **Integration with machine learning models** so that you can visualize and compare predictions from different models and perform pre-labeling.
- **Embed it in your data pipeline** REST API makes it easy to make it a part of your pipeline
## Included templates for labeling data in Label Studio
Label Studio includes a variety of templates to help you label your data, or you can create your own using specifically designed configuration language. The most common templates and use cases for labeling include the following cases:
<img src="https://raw.githubusercontent.com/heartexlabs/label-studio/master/images/templates-categories.jpg" />
## Set up machine learning models with Label Studio
Connect your favorite machine learning model using the Label Studio Machine Learning SDK. Follow these steps:
1. Start your own machine learning backend server. See [more detailed instructions](https://github.com/heartexlabs/label-studio-ml-backend).
2. Connect Label Studio to the server on the model page found in project settings.
This lets you:
- **Pre-label** your data using model predictions.
- Do **online learning** and retrain your model while new annotations are being created.
- Do **active learning** by labeling only the most complex examples in your data.
## Integrate Label Studio with your existing tools
You can use Label Studio as an independent part of your machine learning workflow or integrate the frontend or backend into your existing tools.
## Ecosystem
| Project | Description |
|-|-|
| label-studio | Server, distributed as a pip package |
| [Frontend library](web/libs/editor/) | The Label Studio frontend library. This uses React to build the UI and mobx-state-tree for state management. |
| [Data Manager library](web/libs/datamanager/) | A library for the Data Manager, our data exploration tool. |
| [label-studio-converter](https://github.com/heartexlabs/label-studio-converter) | Encode labels in the format of your favorite machine learning library |
| [label-studio-transformers](https://github.com/heartexlabs/label-studio-transformers) | Transformers library connected and configured for use with Label Studio |
## Roadmap
Want to use **The Coolest Feature X** but Label Studio doesn't support it? Check out [our public roadmap](roadmap.md)!
## Citation
```tex
@misc{Label Studio,
title={{Label Studio}: Data labeling software},
url={https://github.com/heartexlabs/label-studio},
note={Open source software available from https://github.com/heartexlabs/label-studio},
author={
Maxim Tkachenko and
Mikhail Malyuk and
Andrey Holmanyuk and
Nikolai Liubimov},
year={2020-2022},
}
```
## License
This software is licensed under the [Apache 2.0 LICENSE](/LICENSE) © [Heartex](https://www.heartex.com/). 2020-2022
<img src="https://user-images.githubusercontent.com/12534576/192582529-cf628f58-abc5-479b-a0d4-8a3542a4b35e.png" title="Hey everyone!" width="180" />
Raw data
{
"_id": null,
"home_page": "https://github.com/heartexlabs/label-studio",
"name": "label-studio",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Heartex",
"author_email": "hello@heartex.ai",
"download_url": "https://files.pythonhosted.org/packages/99/53/13d27fbfa7e220e2346445cb0ff8611646192ea7b4dab1b90d8ac944a806/label_studio-1.12.0.post0.tar.gz",
"platform": null,
"description": "<img src=\"https://user-images.githubusercontent.com/12534576/192582340-4c9e4401-1fe6-4dbb-95bb-fdbba5493f61.png\"/>\n\n  \n\n[Website](https://labelstud.io/) \u2022 [Docs](https://labelstud.io/guide/) \u2022 [Twitter](https://twitter.com/labelstudiohq) \u2022 [Join Slack Community <img src=\"https://app.heartex.ai/docs/images/slack-mini.png\" width=\"18px\"/>](https://slack.labelstud.io/?source=github-1)\n\n\n## What is Label Studio?\n\n<!-- <a href=\"https://labelstud.io/blog/release-130.html\"><img src=\"https://github.com/heartexlabs/label-studio/raw/master/docs/themes/htx/source/images/release-130/LS-Hits-v1.3.png\" align=\"right\" /></a> -->\n\nLabel Studio is an open source data labeling tool. It lets you label data types like audio, text, images, videos, and time series with a simple and straightforward UI and export to various model formats. It can be used to prepare raw data or improve existing training data to get more accurate ML models.\n\n- [Try out Label Studio](#try-out-label-studio)\n- [What you get from Label Studio](#what-you-get-from-label-studio)\n- [Included templates for labeling data in Label Studio](#included-templates-for-labeling-data-in-label-studio)\n- [Set up machine learning models with Label Studio](#set-up-machine-learning-models-with-Label-Studio)\n- [Integrate Label Studio with your existing tools](#integrate-label-studio-with-your-existing-tools)\n\n\n\nHave a custom dataset? You can customize Label Studio to fit your needs. Read an [introductory blog post](https://towardsdatascience.com/introducing-label-studio-a-swiss-army-knife-of-data-labeling-140c1be92881) to learn more. \n\n## Try out Label Studio\n\nInstall Label Studio locally, or deploy it in a cloud instance. [Or, sign up for a free trial of our Enterprise edition.](https://heartex.com/free-trial).\n\n- [Install locally with Docker](#install-locally-with-docker)\n- [Run with Docker Compose (Label Studio + Nginx + PostgreSQL)](#run-with-docker-compose)\n- [Install locally with pip](#install-locally-with-pip)\n- [Install locally with Anaconda](#install-locally-with-anaconda)\n- [Install for local development](#install-for-local-development)\n- [Deploy in a cloud instance](#deploy-in-a-cloud-instance)\n\n### Install locally with Docker\nOfficial Label Studio docker image is [here](https://hub.docker.com/r/heartexlabs/label-studio) and it can be downloaded with `docker pull`. \nRun Label Studio in a Docker container and access it at `http://localhost:8080`.\n\n\n```bash\ndocker pull heartexlabs/label-studio:latest\ndocker run -it -p 8080:8080 -v $(pwd)/mydata:/label-studio/data heartexlabs/label-studio:latest\n```\nYou can find all the generated assets, including SQLite3 database storage `label_studio.sqlite3` and uploaded files, in the `./mydata` directory.\n\n#### Override default Docker install\nYou can override the default launch command by appending the new arguments:\n```bash\ndocker run -it -p 8080:8080 -v $(pwd)/mydata:/label-studio/data heartexlabs/label-studio:latest label-studio --log-level DEBUG\n```\n\n#### Build a local image with Docker\nIf you want to build a local image, run:\n```bash\ndocker build -t heartexlabs/label-studio:latest .\n```\n\n### Run with Docker Compose\nDocker Compose script provides production-ready stack consisting of the following components:\n\n- Label Studio\n- [Nginx](https://www.nginx.com/) - proxy web server used to load various static data, including uploaded audio, images, etc.\n- [PostgreSQL](https://www.postgresql.org/) - production-ready database that replaces less performant SQLite3.\n\nTo start using the app from `http://localhost` run this command:\n```bash\ndocker-compose up\n```\n\n### Run with Docker Compose + MinIO\nYou can also run it with an additional MinIO server for local S3 storage. This is particularly useful when you want to \ntest the behavior with S3 storage on your local system. To start Label Studio in this way, you need to run the following command:\n````bash\n# Add sudo on Linux if you are not a member of the docker group\ndocker compose -f docker-compose.yml -f docker-compose.minio.yml up -d\n````\nIf you do not have a static IP address, you must create an entry in your hosts file so that both Label Studio and your \nbrowser can access the MinIO server. For more detailed instructions, please refer to [our guide on storing data](docs/source/guide/storedata.md).\n\n\n### Install locally with pip\n\n```bash\n# Requires Python >=3.8\npip install label-studio\n\n# Start the server at http://localhost:8080\nlabel-studio\n```\n\n### Install locally with Anaconda\n\n```bash\nconda create --name label-studio\nconda activate label-studio\nconda install psycopg2\npip install label-studio\n```\n\n### Install for local development\n\nYou can run the latest Label Studio version locally without installing the package with pip. \n\n```bash\n# Install all package dependencies\npip install -e .\n# Run database migrations\npython label_studio/manage.py migrate\npython label_studio/manage.py collectstatic\n# Start the server in development mode at http://localhost:8080\npython label_studio/manage.py runserver\n```\n\n### Deploy in a cloud instance\n\nYou can deploy Label Studio with one click in Heroku, Microsoft Azure, or Google Cloud Platform: \n\n[<img src=\"https://www.herokucdn.com/deploy/button.svg\" height=\"30px\">](https://heroku.com/deploy?template=https://github.com/heartexlabs/label-studio/tree/heroku-persistent-pg)\n[<img src=\"https://aka.ms/deploytoazurebutton\" height=\"30px\">](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fheartexlabs%2Flabel-studio%2Fmaster%2Fazuredeploy.json)\n[<img src=\"https://deploy.cloud.run/button.svg\" height=\"30px\">](https://deploy.cloud.run)\n\n\n#### Apply frontend changes\n\nFor information about updating the frontend, see [label-studio/web/README.md](https://github.com/HumanSignal/label-studio/blob/develop/web/README.md#usage-instructions).\n\n### Troubleshoot installation\nIf you see any errors during installation, try to rerun the installation\n\n```bash\npip install --ignore-installed label-studio\n```\n\n#### Install dependencies on Windows \nTo run Label Studio on Windows, download and install the following wheel packages from [Gohlke builds](https://www.lfd.uci.edu/~gohlke/pythonlibs) to ensure you're using the correct version of Python:\n- [lxml](https://www.lfd.uci.edu/~gohlke/pythonlibs/#lxml)\n\n```bash\n# Upgrade pip \npip install -U pip\n\n# If you're running Win64 with Python 3.8, install the packages downloaded from Gohlke:\npip install lxml\u20114.5.0\u2011cp38\u2011cp38\u2011win_amd64.whl\n\n# Install label studio\npip install label-studio\n```\n\n### Run test suite\nTo add the tests' dependencies to your local install:\n\n```bash\npip install -r deploy/requirements-test.txt\n```\n\nAlternatively, it is possible to run the unit tests from a Docker container in which the test dependencies are installed:\n\n\n```bash\nmake build-testing-image\nmake docker-testing-shell\n```\n\nIn either case, to run the unit tests:\n\n```bash\ncd label_studio\n\n# sqlite3\nDJANGO_DB=sqlite DJANGO_SETTINGS_MODULE=core.settings.label_studio pytest -vv\n\n# postgres (assumes default postgres user,db,pass. Will not work in Docker\n# testing container without additional configuration)\nDJANGO_DB=default DJANGO_SETTINGS_MODULE=core.settings.label_studio pytest -vv\n```\n\n\n## What you get from Label Studio\n\n\n\n- **Multi-user labeling** sign up and login, when you create an annotation it's tied to your account.\n- **Multiple projects** to work on all your datasets in one instance.\n- **Streamlined design** helps you focus on your task, not how to use the software.\n- **Configurable label formats** let you customize the visual interface to meet your specific labeling needs.\n- **Support for multiple data types** including images, audio, text, HTML, time-series, and video. \n- **Import from files or from cloud storage** in Amazon AWS S3, Google Cloud Storage, or JSON, CSV, TSV, RAR, and ZIP archives. \n- **Integration with machine learning models** so that you can visualize and compare predictions from different models and perform pre-labeling.\n- **Embed it in your data pipeline** REST API makes it easy to make it a part of your pipeline\n\n## Included templates for labeling data in Label Studio \n\nLabel Studio includes a variety of templates to help you label your data, or you can create your own using specifically designed configuration language. The most common templates and use cases for labeling include the following cases:\n\n<img src=\"https://raw.githubusercontent.com/heartexlabs/label-studio/master/images/templates-categories.jpg\" />\n\n## Set up machine learning models with Label Studio\n\nConnect your favorite machine learning model using the Label Studio Machine Learning SDK. Follow these steps:\n\n1. Start your own machine learning backend server. See [more detailed instructions](https://github.com/heartexlabs/label-studio-ml-backend).\n2. Connect Label Studio to the server on the model page found in project settings.\n\nThis lets you:\n\n- **Pre-label** your data using model predictions. \n- Do **online learning** and retrain your model while new annotations are being created. \n- Do **active learning** by labeling only the most complex examples in your data.\n\n## Integrate Label Studio with your existing tools\n\nYou can use Label Studio as an independent part of your machine learning workflow or integrate the frontend or backend into your existing tools. \n\n## Ecosystem\n\n| Project | Description |\n|-|-|\n| label-studio | Server, distributed as a pip package |\n| [Frontend library](web/libs/editor/) | The Label Studio frontend library. This uses React to build the UI and mobx-state-tree for state management. | \n| [Data Manager library](web/libs/datamanager/) | A library for the Data Manager, our data exploration tool. | \n| [label-studio-converter](https://github.com/heartexlabs/label-studio-converter) | Encode labels in the format of your favorite machine learning library | \n| [label-studio-transformers](https://github.com/heartexlabs/label-studio-transformers) | Transformers library connected and configured for use with Label Studio |\n\n\n## Roadmap\n\nWant to use **The Coolest Feature X** but Label Studio doesn't support it? Check out [our public roadmap](roadmap.md)!\n\n## Citation\n\n```tex\n@misc{Label Studio,\n title={{Label Studio}: Data labeling software},\n url={https://github.com/heartexlabs/label-studio},\n note={Open source software available from https://github.com/heartexlabs/label-studio},\n author={\n Maxim Tkachenko and\n Mikhail Malyuk and\n Andrey Holmanyuk and\n Nikolai Liubimov},\n year={2020-2022},\n}\n```\n\n## License\n\nThis software is licensed under the [Apache 2.0 LICENSE](/LICENSE) \u00a9 [Heartex](https://www.heartex.com/). 2020-2022\n\n<img src=\"https://user-images.githubusercontent.com/12534576/192582529-cf628f58-abc5-479b-a0d4-8a3542a4b35e.png\" title=\"Hey everyone!\" width=\"180\" />\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Label Studio annotation tool",
"version": "1.12.0.post0",
"project_urls": {
"Homepage": "https://github.com/heartexlabs/label-studio"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a18a867117bd3da45302568be5251da2742c62dc5a55d08635f568798809db3d",
"md5": "2569d63c90d356b3dda2cc7e7ccfd52e",
"sha256": "36b2f71f237378638b5e4f315a1a7868fe8eb26e7bee74f5546394077425c5bb"
},
"downloads": -1,
"filename": "label_studio-1.12.0.post0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2569d63c90d356b3dda2cc7e7ccfd52e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 81473819,
"upload_time": "2024-05-06T19:31:38",
"upload_time_iso_8601": "2024-05-06T19:31:38.237431Z",
"url": "https://files.pythonhosted.org/packages/a1/8a/867117bd3da45302568be5251da2742c62dc5a55d08635f568798809db3d/label_studio-1.12.0.post0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "995313d27fbfa7e220e2346445cb0ff8611646192ea7b4dab1b90d8ac944a806",
"md5": "57176d1baf39dca2f4d342f80145cac8",
"sha256": "5d218a62e3a1f2bc8f5c1c5c23a3aa46043c6bf629000aad838463b6cf1b177c"
},
"downloads": -1,
"filename": "label_studio-1.12.0.post0.tar.gz",
"has_sig": false,
"md5_digest": "57176d1baf39dca2f4d342f80145cac8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 80069247,
"upload_time": "2024-05-06T19:31:45",
"upload_time_iso_8601": "2024-05-06T19:31:45.296162Z",
"url": "https://files.pythonhosted.org/packages/99/53/13d27fbfa7e220e2346445cb0ff8611646192ea7b4dab1b90d8ac944a806/label_studio-1.12.0.post0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-06 19:31:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "heartexlabs",
"github_project": "label-studio",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "label-studio"
}
JSON
