计算机视觉平台, 开放的应用生态系统, Python SDK

官网: https://supervisely.com

Supervisely 生态系统: https://ecosystem.supervisely.com

开发者文档: https://developer.supervisely.com

Python SDK 源代码: https://github.com/supervisely/supervisely

Supervisely 生态系统 GitHub 仓库: https://github.com/supervisely-ecosystem

YouTube 完整视频课程: 什么是 Supervisely？

目录

• YouTube 完整视频课程：什么是 Supervisely？
• 目录
• 简介
  • Supervisely 平台 🔥
  • Supervisely 生态系统 🎉
• 开发 🧑‍💻
  • 开发者能做什么
    • 第 1 级：HTTP REST API
    • 第 2 级：用于自动化和集成的 Python 脚本
    • 第 3 级：无界面应用（Headless）
    • 第 4 级：带有交互式 UI 的应用
    • 第 5 级：UI 集成到标注工具中的应用
  • 原则 🧭
• 核心功能 💎
  • 一分钟上手
  • 神奇简单的 API
  • 随处可定制
  • 交互式 GUI 是变革性因素
  • 使用现成的 UI 组件快速开发
  • 便捷调试
  • 应用可以是私有的，也可以是公有的
  • 一键部署
  • 可靠的版本控制——发布与分支
  • 同时支持 GitHub 和 GitLab
  • 应用本质上就是一个 Web 服务器，你可以使用任何你喜欢的技术
  • 内置云开发环境（即将推出）
  • 受到财富 500 强企业的信赖，全球已有 65,000 名研究人员、开发者和公司正在使用
• 社区 🌎
  • 有想法或需要帮助吗？
• 贡献 👏
• 合作伙伴关系 🤝
• 引用本项目

简介

每一家公司都希望确保其当前及未来的 AI 任务能够被解决。

市场上大多数解决方案的主要问题在于，它们是以产品形式构建的。这就像一个黑盒，由某个你无法真正影响的公司开发。一旦你的需求超出了所提供的基本功能，想要自定义体验、添加一些不符合软件所有者开发计划或对其他客户没有益处的功能时，你就很难如愿了。

这就是为什么 Supervisely 构建的是一个平台，而不是一款产品。

Supervisely 平台 🔥

你可以把 Supervisely 看作是一个通过网页浏览器访问的操作系统，旨在帮助你解决计算机视觉任务。其理念是将所有相关的工具统一在一个 生态系统 中，包括应用程序、工具、UI 组件和服务，以尽可能简化并加速 AI 开发流程。

更具体地说，Supervisely 包含以下功能：

• 图像、视频、3D 点云以及医学体积图像（DICOM）的数据标注
• 数据可视化与质量控制
• 用于分割、检测、分类等任务的最先进深度学习模型
• 用于分析模型性能的交互式工具
• 专门用于加速数据标注的深度学习模型（即 AI 辅助标注）
• 合成数据生成工具
• 便于数据科学家、数据标注员、领域专家和软件工程师协作的工具

Supervisely 生态系统 🎉

创建 Supervisely 应用的简便性已经催生了数百个应用，只需在网页浏览器中点击一下即可运行，轻松完成任务。

标记数据、进行质量保证、检查数据的各个方面、轻松协作、训练并应用最先进的神经网络、集成自定义模型、自动化日常任务等等——就像真正的 AppStore 一样，几乎每项需求都有相应的应用。

开发 🧑‍💻

Supervisely 提供了集成、定制、开发和运行计算机视觉应用的基础，以满足您的特定需求——就像操作系统一样，比如 Windows 或 macOS。

开发者可以做什么

集成、定制和自动化有不同的层次：

1. HTTP REST API
2. 用于自动化和集成的 Python 脚本
3. 无界面应用（无 UI）
4. 带有交互式 UI 的应用
5. 与标注工具集成的 UI 应用

第 1 层：HTTP REST API

Supervisely 拥有丰富的 HTTP REST API，几乎涵盖了您手动执行的每一个操作。您可以使用任何编程语言和任何开发环境来扩展和定制您的 Supervisely 使用体验。

ℹ️ 对于 Python 开发者，我们推荐使用我们的 Python SDK，因为它封装了所有 API 方法，并通过内置的错误处理、网络重连、响应验证、请求分页等功能，能够为您节省大量时间。

curl -H "x-api-key: <your-token-here>" https://app.supervisely.com/public/api/v3/projects.list

第 2 层：用于自动化和集成的 Python 脚本

Supervisely 的 Python SDK 专为加速开发、减少样板代码而设计，让您只需几行 Python 代码就能完成各种操作，例如处理 Supervisely 标注 JSON 格式、与平台通信、导入和导出数据、管理成员、上传模型预测结果等。

import supervisely as sly

# 使用个人 API 令牌进行身份验证
api = sly.Api.from_env()

# 创建项目和数据集
project = api.project.create(workspace_id=123, name="demo project")
dataset = api.dataset.create(project.id, "dataset-01")

# 上传数据
image_info = api.image.upload_path(dataset.id, "img.png", "/Users/max/img.png")
api.annotation.upload_path(image_info.id, "/Users/max/ann.json")

# 下载数据
img = api.image.download_np(image_info.id)
ann = api.annotation.download_json(image_info.id)

第3级：无界面应用（无UI）

创建Python应用程序来自动化常规和重复性任务，在组织内部共享，并为没有编程背景的最终用户提供一种简单的使用方式。无界面的应用程序只是可以从上下文菜单中运行的Python脚本。

这种方法简单，适用于最基础的任务和用例，例如：

• 以自定义格式导入和导出（示例1，示例2，示例3，示例4）
• 资产转换（示例1，示例2，示例3，示例4）
• 用户管理（示例1，示例2，示例3）
• 部署用于AI辅助标注的专用模型（示例1，示例2，示例3）

第4级：具有交互式UI的应用程序

交互式界面和可视化是构建与改进AI解决方案的关键：从自定义数据标注到模型训练。这类应用为定制Supervisely平台以适应任何计算机视觉任务、实现符合组织需求的数据和模型工作流，甚至在其基础上构建特定行业的垂直解决方案提供了机会。

以下是一些示例：

• 带有AI辅助的自定义标注界面，适用于图像和视频
• 交互式模型性能分析
• 交互式NN训练仪表板
• 数据探索和可视化应用
• 垂直解决方案用于零售业货架上产品的标注
• 推理界面在标注工具中；适用于图像，视频和点云；也适用于模型集成

第5级：UI集成到标注工具中的应用程序

不存在一种适用于所有任务的通用标注工具。为了高效完成工作，标注工具必须针对特定任务进行设计和定制。Supervisely应用程序可以无缝集成到标注工具中，从而提供卓越的用户体验（包括多租户支持）和标注效率。

以下是一些示例：

• 专为自定义标注流程设计的应用程序（示例1，示例2）
• 将NN推理集成用于标注自动化和模型预测分析（示例）
• 行业特定的标注工具：借助AI辅助对货架上的数千种产品类型进行标注（零售系列，标注应用）

原则 🧭

Supervisely 的开发基于以下五项原则：

• 全部使用 纯 Python，并构建在您喜爱的库之上（如 OpenCV、Requests、FastAPI、PyTorch、imgaug 等）——这使得 Python 开发者和数据科学家能够轻松地构建应用，并与团队成员及机器学习社区共享。
• 无需前端开发经验——通过使用全面且开箱即用的 UI 组件库，您可以构建 强大 且 交互式 的 Web GUI 应用程序。
• 易于学习、快速编码，并且 可直接投入生产。SDK 提供简单直观的 API，将复杂性封装在底层。只需几行代码即可完成任何操作。您只需专注于自己的任务，Supervisely 将负责处理其余的一切：界面、数据库、权限、安全、云端或自托管部署、网络、数据存储等。Supervisely 拥有完善的测试、文档和支持体系。
• 一切皆可 定制——从标注界面到神经网络。平台需要根据您的具体任务和需求进行定制和扩展，而不是反过来。我们的 应用生态系统 中提供了数百个示例，覆盖各种场景。
• 应用可以是 开源的或私有的。Supervisely 团队开发的所有应用都是 开源的。您可以将其作为示例，直接 fork 并按需修改。同时，客户和社区用户也可以开发私有应用，以保护其知识产权。

主要特性 💎

• YouTube 完整视频课程：什么是 Supervisely？
• 目录
• 简介
  • Supervisely 平台 🔥
  • Supervisely 生态系统 🎉
• 开发 🧑‍💻
  • 开发者能做什么
    • Level 1. HTTP REST API
    • Level 2. 用于自动化和集成的 Python 脚本
    • Level 3. 无 UI 的 Headless 应用
    • Level 4. 带交互式 UI 的应用
    • Level 5. 集成到标注工具中的带 UI 的应用
  • 原则 🧭
• 主要特性 💎
  • 一分钟内开始
  • 神奇简单的 API
  • 无处不在的定制化
  • 交互式 GUI 是游戏规则改变者
  • 使用现成的 UI 组件快速开发
  • 便捷的调试
  • 应用可以是私有的也可以是公有的
  • 一键部署
  • 可靠的版本控制——发布与分支
  • 同时支持 GitHub 和 GitLab
  • 应用只是一个 Web 服务器，您可以使用任何喜欢的技术
  • 内置云开发环境（即将推出）
  • 受财富 500 强企业信赖，全球已有 65,000 名研究人员、开发者和公司使用
• 社区 🌎
  • 有想法或需要帮助吗？
• 贡献 👏
• 合作 🤝
• 引用本项目

一分钟内开始

Supervisely 的开源 SDK 和应用框架非常容易上手。您只需执行以下命令：

pip install supervisely

神奇简单的 API

Supervisely Python SDK 简单直观，能够为您节省大量时间。减少样板代码，只需几行代码即可构建自定义集成。从 Python 中与平台通信从未如此简单。

# 使用个人 API 令牌进行身份验证
api = sly.Api.from_env()

# 创建项目和数据集
project = api.project.create(workspace_id=123, name="demo project")
dataset = api.dataset.create(project.id, "dataset-01")

# 上传数据
image_info = api.image.upload_path(dataset.id, "img.png", "/Users/max/img.png")
api.annotation.upload_path(image_info.id, "/Users/max/ann.json")

# 下载数据
img = api.image.download_np(image_info.id)
ann = api.annotation.download_json(image_info.id)

自定义无处不在

在计算机视觉领域，只有通过自定义才能满足所有任务需求。Supervisely 允许您自定义从标注界面、上下文菜单到训练仪表盘和推理界面的一切。请查看我们的 应用生态系统，从中获取灵感和示例，为您的下一个机器学习工具提供参考。

交互式 GUI 是游戏规则改变者

大多数 Python 程序都是基于命令行的。虽然经验丰富的程序员对此游刃有余，但其他技术人员和最终用户却常常感到困难。这就造成了数字鸿沟，即“GUI 缺失”。而带有图形用户界面（GUI）的应用则更容易被更广泛的受众接受和使用。此外，有些任务如果没有 GUI 根本无法完成。

试想一下，如果所有的机器学习工具和代码仓库都配备一个带有“运行”按钮 ▶️ 的交互式 GUI，那该有多好！这样，您只需几分钟就能开始使用顶级深度学习框架，而不用再花费数周时间来针对自己的数据进行训练。

🎯 我们的宏伟目标就是实现这一点。

快速开发：即用型UI组件

我们为您准备了数百个交互式UI组件和控件。只需将其添加到您的程序中，并填充数据即可。Python开发者无需具备前端开发经验；在我们的开发者门户中，您将找到所需的指南、示例和教程。我们支持以下UI组件：

1. Supervisely打造的组件，专为计算机视觉任务设计，例如渲染带有标注的图像画廊、带标签的视频正反向播放、交互式混淆矩阵、表格、图表等。
2. Element UI组件——基于Vue 2.0的组件库。
3. Plotly Python绘图库。
4. 开发您自己的自定义组件。

Supervisely团队将其大部分应用公开发布在GitHub上。您可以将其作为未来应用的示例：fork、修改并复制粘贴代码片段。

方便的调试功能

Supervisely由数据科学家为数据科学家打造，致力于降低开发门槛，提供友好的开发环境。我们尤其重视调试这一关键环节。

即使在复杂场景下，例如开发集成于标注工具中的GUI应用，我们也保持简单易用——您可以在自己喜欢的IDE中设置断点来捕获回调函数，逐步执行程序，并实时查看更新，而无需刷新页面。就是这么简单！Supervisely会处理其余一切——WebSocket、身份验证、Redis、RabbitMQ、Postgres等。

请观看下方视频，了解我们如何调试一款将神经网络直接应用于标注界面的应用程序：链接。

应用可私有也可公开

Supervisely团队开发的所有应用均为开源。您可以将其作为示例：在GitHub上查找、fork并按需修改。同时，客户和社区用户也可以开发私有应用，以保护其知识产权。

一键部署

Supervisely应用本质上就是一个Git仓库。您只需提供Git仓库的链接，Supervisely便会处理其余一切。现在，您只需点击应用前的“运行”按钮，即可在任何安装了Supervisely Agent的计算机上启动该应用。

可靠的版本管理——发布与分支

用户始终运行的是最新稳定版，而您可以并行开发和测试新功能——只需使用Git的发布和分支功能。Supervisely会自动从Git拉取更新，即便新版本的应用存在bug，也无需担心——用户可以一键选择并运行之前的版本。

同时支持GitHub和GitLab

由于Supervisely应用只是一个Git仓库，因此我们支持来自全球最受欢迎的托管平台——GitHub和GitLab——的公共及私有仓库。

应用即Web服务器，可使用任何您喜爱的技术

Supervisely的Python SDK为Python开发者和数据科学家提供了构建任意复杂度交互式GUI应用的最简单方式。Python是开发Supervisely应用的推荐语言，但并非唯一选择。您可以使用任何您喜爱的语言或技术，任何Web服务器都可以部署在该平台上。

例如，即使是适用于Web的Visual Studio Code，也可以作为应用运行（见下方视频）。

内置云开发环境（即将推出）

除了在您本地电脑或笔记本上的常用IDE中进行开发之外，云开发支持也将集成到Supervisely中，并将在不久的将来发布，以加速开发、标准化开发环境并降低初学者的门槛。具体操作方式如下：只需将您的电脑连接到Supervisely实例，运行IDE应用（如JupyterLab和适用于Web的Visual Studio Code），即可在一分钟内开始编码。我们将提供大量涵盖最常见用例的模板应用。

财富500强信赖之选，全球6.5万名研究人员、开发者和企业正在使用

Supervisely帮助全球企业和研究人员在自动驾驶、农业、医疗等多个行业构建计算机视觉解决方案。加入我们的Community Edition，或为贵组织申请Enterprise Edition。

社区 🌎

加入不断壮大的Supervisely社区，目前已有超过6.5万名用户。

您有想法或需要帮助吗？

如果您有任何问题、想法或反馈，请：

1. 提交功能建议或创意，或提供技术反馈。
2. 加入我们的Slack。
3. 联系我们。

您的反馈对我们帮助巨大，我们深表感谢！

贡献 👏

希望助力计算机视觉研发更上一层楼吗？我们诚邀您参与并加速数千名研究人员的工作，方法包括：

• 与我们一起构建并扩展Supervisely生态系统。
• 将您的ML工具和研究成果集成到Supervisely中，与整个ML社区共享。

合作伙伴 🤝

我们非常乐意与更多技术合作伙伴、研究人员、开发者以及增值经销商携手合作，共同拓展并提升Supervisely生态系统的价值。

如果您拥有以下资源，请随时联系我们：

• ML服务或产品。
• 独特的专业领域知识。
• 行业垂直解决方案。
• 解决特定任务的宝贵代码库和工具。
• 自定义的NN模型和数据集。

让我们探讨合作方式，尤其是在双方具有共同兴趣、技术和客户的情况下。

引用本项目

如果您在研究中使用本项目，请使用以下 BibTeX 格式进行引用：

@misc{ supervisely,
    title = { 监控精灵计算机视觉平台 },
    type = { 计算机视觉工具 },
    author = { 监控精灵 },
    howpublished = { \url{ https://supervisely.com } },
    url = { https://supervisely.com },
    journal = { 监控精灵生态系统 },
    publisher = { 监控精灵 },
    year = { 2023 },
    month = { jul },
    note = { 访问日期：2023年7月20日 },
}

Supervisely 快速上手指南

Supervisely 是一个基于浏览器的计算机视觉操作系统平台，提供数据标注、模型训练、可视化及自动化生态应用。本指南帮助开发者快速搭建环境并运行第一个示例。

环境准备

在开始之前，请确保满足以下系统要求和前置依赖：

• 操作系统：Linux (推荐 Ubuntu 20.04+), macOS, 或 Windows (建议使用 WSL2)。
• Python 版本：Python 3.8 - 3.11。
• 包管理器：已安装 pip。
• 账号与令牌：
  • 拥有一个 Supervisely 账号（可使用社区版或企业版）。
  • 获取个人 API Token：登录平台后，点击右上角头像 -> "My Profile" -> "Access Tokens" 生成或复制现有 Token。
• 网络环境：确保能访问 app.supervisely.com (社区版) 或您的私有部署地址。

国内加速提示：如果下载 pip 包速度较慢，建议使用国内镜像源（如清华源或阿里源）进行安装。

安装步骤

1. 安装 Python SDK

使用 pip 安装 Supervisely 核心开发包。

标准安装命令：

pip install supervisely

推荐使用国内镜像源加速安装：

pip install supervisely -i https://pypi.tuna.tsinghua.edu.cn/simple

2. 配置 API Token

为了在代码中自动认证，建议将 API Token 设置为环境变量。

Linux / macOS:

export SUPERVISELY_API_TOKEN=<your-token-here>

Windows (PowerShell):

$env:SUPERVISELY_API_TOKEN="<your-token-here>"

(请将 <your-token-here> 替换为您实际复制的 Token 字符串)

基本使用

以下是最简单的 Python 脚本示例，演示如何连接平台、创建项目、上传图像及标注数据。

最小化代码示例

创建一个名为 quick_start.py 的文件，填入以下内容：

import supervisely as sly

# 1. 初始化 API 客户端
# 自动读取环境变量 SUPERVISELY_API_TOKEN 进行认证
api = sly.Api.from_env()

# 2. 获取工作空间 ID (请在平台上查看您的 Workspace ID，或硬编码此处)
# 注意：如果是首次使用，请替换为您实际的工作空间 ID
workspace_id = 123 

# 3. 创建项目和数据集
project = api.project.create(workspace_id=workspace_id, name="demo_project_quickstart")
dataset = api.dataset.create(project.id, "dataset_01")

# 4. 准备本地文件路径 (请替换为您本地的实际图片路径)
image_path = "/path/to/your/image.png"
annotation_path = "/path/to/your/annotation.json" 

# 5. 上传图像
# 返回图像信息对象，包含 image_info.id
image_info = api.image.upload_path(dataset.id, "img.png", image_path)

# 6. 上传标注 (可选)
# 假设您有一个对应的 JSON 标注文件
if os.path.exists(annotation_path):
    api.annotation.upload_path(image_info.id, annotation_path)

# 7. 下载验证 (可选)
# 将图像下载为 numpy 数组
img_np = api.image.download_np(image_info.id)
print(f"成功上传图像: {image_info.name}, 形状: {img_np.shape}")

运行脚本

在终端执行：

python quick_start.py

如果脚本运行无报错，请登录 Supervisely 网页端，即可在对应工作空间中看到新建的 demo_project_quickstart 项目及其中的数据。

进阶：运行无界面应用 (Headless Apps)

除了编写脚本，您还可以将 Python 脚本封装为“无界面应用”，通过平台右键菜单直接运行，无需编写前端代码。只需按照上述 SDK 逻辑编写脚本，并通过 Supervisely Agent 部署即可实现自动化任务（如格式转换、批量重命名、模型推理等）。