Pipeless

Pipeless 是一个开源框架，可在短短几分钟内完成开发和部署计算机视觉应用所需的一切工作。 这包括代码并行化、多媒体管道、内存管理、模型推理、多流管理等。借助 Pipeless，您可以 在几分钟内交付实时运行的应用程序，而无需耗费数周或数月的时间。

Pipeless 的设计理念源自现代无服务器技术。您只需提供一些函数，Pipeless 就会负责为新的视频帧及其相关任务执行这些函数。

使用 Pipeless，您可以创建称为“阶段”的自包含模块。每个阶段都是一个执行特定任务的微型管道。随后，您可以根据不同的流动态组合这些阶段，从而无需更改代码或重启程序即可用不同的管道处理每条流。要创建一个阶段，您只需提供预处理函数、模型和后处理函数即可。

您可以通过提供 URL，加载 行业标准模型（如 YOLO）或 自定义模型，这些模型将运行在支持的推理运行时中。Pipeless 自带一些最流行的推理运行时，例如 ONNX Runtime，使您能够开箱即用地在 CPU 或 GPU 上以高性能进行推理。

您可以将 Pipeless 及其应用程序部署到边缘设备、物联网设备或云端。为此提供了多种工具，包括容器镜像。

以下是 Pipeless 包含的部分相关功能（并不全面）：

• 多流支持：同时处理多个数据流。
• 动态流配置：通过 CLI 或 REST API 动态添加、编辑和移除流（未来还将推出更多适配器）。
• 多语言支持：您可以用多种语言编写钩子函数，包括 Python。
• 动态处理步骤：您可以为流处理添加任意数量的步骤，甚至可以根据每个流的需求动态修改这些步骤。
• 内置重启策略：无需再担心连接错误、摄像头故障等问题。您可以为每个流轻松指定自动处理这些问题的重启策略。
• 高度并行化：无需操心多线程或多进程问题，Pipeless 会为您妥善处理。
• 支持多种推理运行时：只需提供模型并选择支持的推理运行时，即可在 CPU 或 GPU 上直接运行该模型。我们支持 CUDA、TensorRT、OpenVINO、CoreML 等，并将继续增加支持的运行时。
• 清晰的项目结构与高度可重用的代码：Pipeless 使用文件系统结构来加载处理阶段和钩子函数，帮助您将代码组织成高度可重用的模块。每个阶段就是一个目录，每个钩子函数都单独存放在一个文件中。

立即开始吧！

加入我们的 社区，一起让计算机视觉开发者的工作更轻松！

需求 ☝️

• Python。预编译的二进制文件已链接到 Linux amd64 上的 Python 3.10、Linux arm64 上的 Python 3.8 以及 macOS 上的 Python 3.12。如果您使用的是其他版本的 Python，请在安装脚本中添加 --build 标志以从源码构建，这样 Pipeless 就会链接到您已安装的 Python 版本（或者更新您的 Python 版本并使用预编译的二进制文件，后者更为简单）。
• GStreamer 1.20.3。可通过运行 gst-launch-1.0 --gst-version 进行验证。安装说明请参见 这里。

安装 🛠️

curl https://raw.githubusercontent.com/pipeless-ai/pipeless/main/install.sh | bash

更多信息及安装选项请参见 这里。

使用 Docker

您也可以选择使用 Docker 而不是本地安装，从而节省依赖项的安装时间：

docker run miguelaeh/pipeless --help

若需使用 CUDA：

docker run miguelaeh/pipeless:latest-cuda --help

若需使用 TensorRT：

docker run miguelaeh/pipeless:latest-tensorrt --help

完整的容器文档请参见 这里。

开始使用 🚀

初始化一个项目：

pipeless init my_project --template scaffold
cd my_project

启动 Pipeless：

pipeless start --stages-dir .

提供一个流：

pipeless add stream --input-uri "https://pipeless-public.s3.eu-west-3.amazonaws.com/cats.mp4" --output-uri "screen" --frame-path "my-stage"

生成的代码是一个空模板，用于搭建一个阶段，因此目前不会执行任何操作。请前往 示例 完成该阶段。

你也可以使用交互式 Shell 来创建项目：

查看完整的入门指南或深入阅读完整文档。

示例 🌟

你可以在 examples 目录下找到一些示例。只需将这些文件夹复制到你的项目中，即可进行尝试。

完整的示例列表和逐步指南请参见这里。

基准测试 📈

我们已将 Pipeless 部署到多种不同的设备上，以便你对其性能有一个大致的了解。测试结果可在文档的基准测试部分中找到。

重要变更

重要变更指版本之间的重大更新。请查看所有重要变更列表。

贡献 🤝

感谢你对贡献的兴趣！我们欢迎并鼓励大家参与贡献。虽然我们正在制定详细的贡献指南，但以下是一些入门的通用步骤：

1. 克隆本仓库。
2. 创建新分支：git checkout -b feature-branch。
3. 进行修改并提交：git commit -m '添加新功能'。
4. 将更改推送到你的分支：git push origin feature-branch。
5. 在 GitHub 上打开一个描述你更改的拉取请求。

我们非常感谢你为改进该项目所做的努力！

请注意，对于重大更改或新功能，建议先在问题中讨论，以便我们协调工作。

许可证 📄

本项目采用Apache License 2.0 许可证。

Apache License 2.0 摘要

Apache License 2.0 是一种宽松的开源许可证，允许你出于个人或商业目的使用、修改和分发本软件。它附带一些义务，包括向原始作者致谢，并在你的分发版本中包含原始许可证文本。

如需完整的许可证文本，请参阅Apache License 2.0。

Pipeless 快速上手指南

Pipeless 是一个开源框架，旨在帮助开发者在几分钟内创建、部署和运行计算机视觉应用。它自动处理代码并行化、多媒体管道、内存管理、模型推理及多流管理等复杂任务，支持实时应用开发。

环境准备

在开始之前，请确保您的系统满足以下要求：

• 操作系统：Linux (amd64/arm64) 或 macOS。
• Python：
  • Linux amd64: Python 3.10
  • Linux arm64: Python 3.8
  • macOS: Python 3.12
  • 注：若使用其他版本，安装时需添加 --build 参数从源码构建。
• GStreamer：版本需为 1.20.3。
  • 验证版本命令：gst-launch-1.0 --gst-version
  • 安装参考：GStreamer 官方安装指南

安装步骤

方式一：本地安装（推荐）

运行以下脚本一键安装：

curl https://raw.githubusercontent.com/pipeless-ai/pipeless/main/install.sh | bash

提示：如果您的 Python 版本与预编译二进制文件不匹配，请在上述命令后追加 --build 标志以从源码构建。

方式二：使用 Docker

如果您希望避免配置本地依赖，可以直接使用 Docker 镜像：

• 通用版本：

  docker run miguelaeh/pipeless --help
  

• CUDA 加速版本：

  docker run miguelaeh/pipeless:latest-cuda --help
  

• TensorRT 加速版本：

  docker run miguelaeh/pipeless:latest-tensorrt --help
  

基本使用

以下是从零开始创建一个简单项目的流程：

1. 初始化项目

使用脚手架模板创建一个新项目：

pipeless init my_project --template scaffold
cd my_project

2. 启动服务

在当前目录下启动 Pipeless 服务，加载处理阶段（stages）：

pipeless start --stages-dir .

3. 添加视频流

向正在运行的服务添加一个视频流。以下示例使用一个公开的测试视频，并将输出显示在屏幕上：

pipeless add stream --input-uri "https://pipeless-public.s3.eu-west-3.amazonaws.com/cats.mp4" --output-uri "screen" --frame-path "my-stage"

说明：初始生成的模板是一个空的处理阶段，不会执行任何实际操作。您可以访问 官方示例库 获取完整的代码示例（如目标检测、姿态估计等），将其复制到项目中即可立即生效。

您也可以通过交互式 Shell 引导完成上述步骤：

pipeless