安装
在本地或云端安装Label Studio。选择最适合您环境的安装方式:
Label Studio 还提供企业版产品,您可以通过免费试用立即体验。
系统要求
您可以在运行Python 3.6或更高版本的Linux、Windows或MacOSX机器上安装Label Studio。
端口要求
Label Studio 默认使用8080端口。如需使用其他端口,请在启动Label Studio时指定。详见Start Label Studio。
服务器要求
根据您计划标注的数据量分配磁盘空间。作为参考,使用SQLite数据库时,100万个标注任务大约占用2.3GB磁盘空间。对于生产环境实例,建议分配50GB磁盘空间。
建议至少使用8GB内存,推荐16GB内存。例如在亚马逊AWS上选择t3.large或t3.xlarge实例类型。
有关大规模使用Label Studio和标注性能的更多信息,请参阅Start Label Studio。
软件需求
PostgreSQL 版本 11.5 或 SQLite 版本 3.35 或更高。
网页浏览器支持
Label Studio已通过最新版Google Chrome浏览器的测试验证。
如果使用其他网页浏览器或受支持浏览器的旧版本,可能会出现意外行为。
安装前提条件
在干净的Python环境中安装Label Studio。我们强烈建议使用虚拟环境(venv或conda)以减少包冲突或缺失包的可能性。
使用pip安装
要通过pip和虚拟环境安装Label Studio,您需要Python 3.8或更高版本。运行以下命令:
python3 -m venv env
source env/bin/activate
python -m pip install label-studio
要通过pip安装Label Studio,您需要Python 3.8或更高版本。运行以下命令:
pip install label-studio
安装Label Studio后,使用以下命令启动服务器:
label-studio
默认的网页浏览器将自动在http://localhost:8080打开Label Studio。更多启动选项请参考start Label Studio。
使用Homebrew安装
要使用Brew安装Label Studio,您的系统需要已安装Brew包管理器。如果尚未安装Brew,请访问brew.sh查看安装说明。
执行以下命令添加Heartexlabs tap:
brew tap humansignal/tap
执行以下命令安装Label Studio:
brew install humansignal/tap/label-studio
安装Label Studio后,使用以下命令启动服务器:
label-studio
默认的网页浏览器将自动在http://localhost:8080打开Label Studio。更多启动选项请参考start Label Studio。
备注
如果您之前从现已弃用的组织名称heartexlabs/tap安装了brew tap,我们有好消息告诉您。您无需立即担心迁移问题。已弃用的tap已被设置为humansignal/tap的镜像,这确保了连续性并将对现有用户的干扰降至最低。
使用Docker安装
Label Studio 也提供 Docker 容器版本。请确保您的机器上已安装 Docker。
在*nix系统上使用Docker安装
要安装并启动Label Studio,访问http://localhost:8080,将所有标注数据存储在./mydata目录中,请运行以下命令:
docker run -it -p 8080:8080 -v $(pwd)/mydata:/label-studio/data heartexlabs/label-studio:latest
重要
由于这是一个非根容器,挂载的文件和目录必须具有UID 1001的适当权限。
在Windows上使用Docker安装
对于Windows系统,您需要修改由-v选项设置的卷路径。
覆盖默认的Docker安装
您可以通过追加新参数来覆盖默认的Docker安装配置。
在Windows命令行(cmd)中:
docker run -it -p 8080:8080 -v %cd%/mydata:/label-studio/data heartexlabs/label-studio:latest label-studio --log-level DEBUG
在PowerShell中:
docker run -it -p 8080:8080 -v ${PWD}/mydata:/label-studio/data heartexlabs/label-studio:latest label-studio --log-level DEBUG
使用Docker构建本地镜像
如果你想构建本地镜像,运行:
docker build -t heartexlabs/label-studio:latest .
使用Docker Compose运行
使用Docker Compose在http://localhost:8080上运行Label Studio。您必须使用Docker Compose 1.25.0或更高版本。
启动 Label Studio:
docker-compose up -d
这将启动Label Studio并使用PostgreSQL作为数据库后端。您也可以在不使用Docker Compose的情况下配置PostgreSQL数据库。详见设置数据库存储。
离线安装Label Studio
下载label-studio的Docker镜像(需要具备互联网访问权限和Docker环境的主机):
docker pull heartexlabs/label-studio:latest
将其导出为tar归档文件:
docker save heartexlabs/label-studio:latest | gzip > label_studio_latest.tar.gz
将其转移到另一台虚拟机:
scp label_studio_latest.tar.gz <ANOTHER_HOST>:/tmp
SSH 登录到 并导入存档:
docker image import /tmp/label_studio_latest.tar.gz
按照安装和升级以运行LS的步骤操作。
在Ubuntu上安装
要在Ubuntu上安装Label Studio并在虚拟环境中运行,请执行以下命令:
python3 -m venv env
source env/bin/activate
sudo apt install python3.9-dev
python -m pip install label-studio
从源码安装
如果想使用夜间构建版本或扩展功能,可以考虑通过Git下载源代码并在本地运行Label Studio:
git clone https://github.com/HumanSignal/label-studio.git
# install dependencies
cd label-studio
pip install poetry
poetry install
# run db migrations
poetry run python label_studio/manage.py migrate
# collect static files
poetry run python label_studio/manage.py collectstatic
# start the server in development mode at http://localhost:8080
poetry run python label_studio/manage.py runserver
通过Anaconda安装
conda create --name label-studio
conda activate label-studio
conda install psycopg2 # required for LS 1.7.2 only
pip install label-studio
升级 Label Studio
要升级到Label Studio的最新版本,请使用pip重新安装或升级。
pip install --upgrade label-studio
当您从0.9.1或更早版本升级到1.0.0版本时,迁移脚本会自动运行。
为确保现有项目完成迁移,当您启动Label Studio时,请运行以下命令:
label-studio start path/to/old/project
最重要的变更需要注意是将"completions"重命名为"annotations"。请参阅已完成任务的更新JSON格式。
如果您自定义了Label Studio前端,请参阅前端参考指南以了解保持与1.0.0版本兼容所需的更新。