Sinapsis Supervision
Templates for multi-object tracking using the ByteTrack model
🐍 Installation • 🚀 Features • 📙 Documentation • 🔍 License
The sinapsis-supervision module offers a powerful and flexible implementation for multi-object tracking using the ByteTrack algorithm. It allows users to easily configure and run tracking pipelines for video input processing, object detection, and tracking tasks.
🐍 Installation
Install using your package manager of choice. We encourage the use of uv
Example with uv:
uv pip install sinapsis-supervision --extra-index-url https://pypi.sinapsis.tech
or with raw pip:
pip install sinapsis-supervision --extra-index-url https://pypi.sinapsis.tech
🚀 Features
Templates Supported
The Sinapsis ByteTrack module provides a template for multi-object tracking using the ByteTrack algorithm. Currently, the package includes the following template:
- ByteTrack: A template for tracking objects across video frames, with customizable parameters for track activation, matching thresholds, and occlusion handling.
For example, for ByteTrack use sinapsis info --example-template-config ByteTrack to produce the following example config:
agent:
name: my_test_agent
templates:
- template_name: InputTemplate
class_name: InputTemplate
attributes: {}
- template_name: ByteTrack
class_name: ByteTrack
template_input: InputTemplate
attributes:
track_activation_threshold: 0.2
lost_track_buffer: 30
minimum_matching_threshold: 0.7
frame_rate: 30
minimum_consecutive_frames: 1
📚 Example Usage
Below is an example YAML configuration for processing a video file and visualizing tracking results using the Sinapsis Supervision template. This configuration loads a video with the VideoReaderCV2, performs object detection and real-time tracking with the UltralyticsPredict and ByteTrack templates, draws bounding boxes around detected objects with the BBoxDrawer, and saves the output as a new video file using the VideoWriterCV2.
Config
agent:
name: cotracker_agent
templates:
- template_name: InputTemplate
class_name: InputTemplate
attributes: {}
- template_name : VideoReaderCV2
class_name: VideoReaderCV2
template_input: InputTemplate
attributes:
video_file_path : "artifacts/palace.mp4"
batch_size: 16
- template_name: CoTrackerOnline
class_name: CoTrackerOnline
template_input: VideoReaderCV2
attributes:
model_variant: baseline
device: cuda
grid_size: 15
- template_name: CoTrackerVisualizer
class_name: CoTrackerVisualizer
template_input: CoTrackerOnline
attributes:
device : cuda
linewidth: 3
overwrite: true
- template_name: VideoWriterCV2
class_name: VideoWriterCV2
template_input: CoTrackerVisualizer
attributes:
destination_path: "artifacts/result.mp4"
height: -1
width: -1
fps: 30
This configuration defines an agent and a sequence of templates for video processing, object detection, real-time tracking, and visualization.
IMPORTANT: The VideoReaderCV2, BBoxDrawer, and VideoWriterCV2 templates are part of the sinapsis-data-readers, sinapsis-data-visualization, and sinapsis-data-writers packages, respectively. To use this example, ensure that you have installed these packages.
To run the config, use the CLI:
sinapsis run name_of_config.yml
📙 Documentation
Documentation for this and other sinapsis packages is available on the sinapsis website
Tutorials for different projects within sinapsis are available at sinapsis tutorials page
🔍 License
This project is licensed under the AGPLv3 license, which encourages open collaboration and sharing. For more details, please refer to the LICENSE file.
For commercial use, please refer to our official Sinapsis website for information on obtaining a commercial license.
Metadata
Release files for sinapsis-supervision 0.1.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sinapsis_supervision-0.1.7.tar.gz | 20.4 kB | Without provenance | Details for sinapsis_supervision-0.1.7.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sinapsis_supervision-0.1.7-py3-none-any.whl | Python 3 | none | any | Details for sinapsis_supervision-0.1.7-py3-none-any.whl |
Total release size: 39.1 kB
Release files / sinapsis_supervision-0.1.7.tar.gz
| Download URL | sinapsis_supervision-0.1.7.tar.gz |
|---|---|
| Size | 20.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e806841ff5da65a9b57b1408aacaa4080444d60e9a402a505f965a5495f2169e
|
|
BLAKE2b-256 checksum How to use checksums |
6a9238e01b83042de500e6a91a481987cccd39dc442c2b802ad505b64ad454ea
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.5.16
|
Release files / sinapsis_supervision-0.1.7-py3-none-any.whl
| Download URL | sinapsis_supervision-0.1.7-py3-none-any.whl |
|---|---|
| Size | 18.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
13bbd64f932c8e0310550fd9a45e790c34cacd8e9c2b53292094e6724cd3f629
|
|
BLAKE2b-256 checksum How to use checksums |
a8d57332bdfbb60be90ad46f761afa52e1f8a3687dd48ec20d766d01903b41bb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.5.16
|
Security for sinapsis-supervision 0.1.7
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.