<picture> </picture>

Pipeless

Easily create, deploy and run computer vision applications.

Pipeless is an open-source computer vision framework to create and deploy applications without the complexity of building and maintaining multimedia pipelines. It ships everything you need to create and deploy efficient computer vision applications that work in real-time in just minutes.

Pipeless is inspired by modern serverless technologies. It provides the development experience of serverless frameworks applied to computer vision. You provide some functions that are executed for new video frames and Pipeless takes care of everything else.

You can easily use industry-standard models, such as YOLO, or load your custom model in one of the supported inference runtimes. Pipeless ships some of the most popular inference runtimes, such as the ONNX Runtime, allowing you to run inference with high performance on CPU or GPU out-of-the-box.

You can deploy your Pipeless application to edge and IoT devices or the cloud. We provide several tools for the deployment, including container images.

The following is a non-exhaustive set of relevant features:

• Multi-stream support: process several streams at the same time.
• Dynamic stream configuration: add, edit, and remove streams on the fly via a CLI or REST API (more adapters to come).
• Multi-language support: you can Write your hooks in several languages, including Python.
• Dynamic processing steps: you can add any number of steps to your stream processing, and even modify those steps dynamically.
• Highly parallelized: do not worry about multi-threading and/or multi-processing, Pipeless takes care of that for you.
• Several inference runtimes supported: Provide a model and select one of the supported inference runtimes to run it out-of-the-box in CPU or GPUs. We support CUDA, TensorRT, OpenVINO, CoreML, and more to come.
• Well-defined project structure and highly reusable code: Pipeless uses the file system structure to load processing stages and hooks, helping you organize the code in highly reusable boxes. Each stage is a directory, each hook is defined on its own file.

Join our community and contribute to making the lives of computer vision developers easier!

Requirements ☝️

• Python. Pre-built binaries are linked to Python 3.11 in Linux and 3.12 in macOS. Just provide the --build flag to the install script if you have a different version (or update your version and use a pre-built binary).
• Gstreamer 1.20.3. Verify with gst-launch-1.0 --gst-version. Installation instructions here

Installation 🛠️

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

Find more information and installation options here.

Using docker

Instead of installing locally, you can alternatively use docker and save the time of installing dependencies:

docker run miguelaeh/pipeless --help

Find the whole container documentation here.

Getting Started 🚀

Init a project:

pipeless init my_project --template scaffold
cd my_project

Start Pipeless:

pipeless start --stages-dir .

Provide a stream:

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

Check the complete getting started guide or plunge into the complete documentation.

Examples 🌟

You can find some examples under the examples directory. Just copy those folders inside your project and play with them.

Find here the whole list of examples and step by step guides.

Benchmark 📈

We deployed Pipeless to several different devices so you can have a general idea of its performance. Find the results at the benchmark section of the docs.

Notable Changes

Notable changes indicate important changes between versions. Please check the whole list of notable changes.

Contributing 🤝

Thanks for your interest in contributing! Contributions are welcome and encouraged. While we're working on creating detailed contributing guidelines, here are a few general steps to get started:

1. Fork this repository.
2. Create a new branch: git checkout -b feature-branch.
3. Make your changes and commit them: git commit -m 'Add new feature'.
4. Push your changes to your fork: git push origin feature-branch.
5. Open a GitHub pull request describing your changes.

We appreciate your help in making this project better!

Please note that for major changes or new features, it's a good idea to discuss them in an issue first so we can coordinate efforts.

License 📄

This project is licensed under the Apache License 2.0.

Apache License 2.0 Summary

The Apache License 2.0 is a permissive open-source license that allows you to use, modify, and distribute this software for personal or commercial purposes. It comes with certain obligations, including providing attribution to the original authors and including the original license text in your distributions.

For the full license text, please refer to the Apache License 2.0.