ml-pipes-supervision 0.1.2rc2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,39 @@
1
+ # Python bytecode and environments
2
+ __pycache__/
3
+ *.py[cod]
4
+ *.so
5
+ .venv/
6
+ venv/
7
+ ENV/
8
+
9
+ # Test, type-check, and coverage artifacts
10
+ .pytest_cache/
11
+ .mypy_cache/
12
+ .ruff_cache/
13
+ .tox/
14
+ .coverage
15
+ coverage.xml
16
+ htmlcov/
17
+
18
+ # Packaging artifacts
19
+ build/
20
+ dist/
21
+ *.egg-info/
22
+
23
+ # Documentation builds
24
+ site/
25
+
26
+ # Downloaded example assets and model weights
27
+ examples/.example_assets/
28
+ *.pt
29
+ *.pth
30
+ *.ckpt
31
+ *.onnx
32
+ *.engine
33
+ *.tflite
34
+ *.safetensors
35
+
36
+ # Editors and operating-system files
37
+ .idea/
38
+ .vscode/
39
+ .DS_Store
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,192 @@
1
+ Metadata-Version: 2.5
2
+ Name: ml-pipes-supervision
3
+ Version: 0.1.2rc2
4
+ Summary: Roboflow Supervision and Inference compatibility wrappers for ml-pipes
5
+ Project-URL: Homepage, https://trained-by-humans.github.io/ml-pipes-supervision/
6
+ Project-URL: Documentation, https://trained-by-humans.github.io/ml-pipes-supervision/
7
+ Project-URL: Repository, https://github.com/trained-by-humans/ml-pipes-supervision
8
+ Project-URL: Issues, https://github.com/trained-by-humans/ml-pipes-supervision/issues
9
+ Project-URL: Changelog, https://github.com/trained-by-humans/ml-pipes-supervision/releases
10
+ License-Expression: Apache-2.0
11
+ License-File: LICENSE
12
+ Keywords: annotation,computer-vision,pipelines,supervision,tracking
13
+ Classifier: Development Status :: 3 - Alpha
14
+ Classifier: Intended Audience :: Developers
15
+ Classifier: License :: OSI Approved :: Apache Software License
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3.10
18
+ Classifier: Programming Language :: Python :: 3.11
19
+ Classifier: Programming Language :: Python :: 3.12
20
+ Classifier: Programming Language :: Python :: 3.13
21
+ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
22
+ Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
23
+ Requires-Python: >=3.10
24
+ Requires-Dist: ml-pipes-core==0.1.2rc1
25
+ Requires-Dist: ml-pipes-vision==0.1.2rc1
26
+ Requires-Dist: supervision<0.31,>=0.29
27
+ Requires-Dist: trackers
28
+ Provides-Extra: docs
29
+ Requires-Dist: mike>=2.1; extra == 'docs'
30
+ Requires-Dist: mkdocs-material>=9.6; extra == 'docs'
31
+ Provides-Extra: inference
32
+ Requires-Dist: inference==1.3.8; (python_version < '3.13') and extra == 'inference'
33
+ Requires-Dist: inference==1.7.1; (python_version >= '3.13') and extra == 'inference'
34
+ Provides-Extra: test
35
+ Requires-Dist: inference==1.3.8; (python_version < '3.13') and extra == 'test'
36
+ Requires-Dist: inference==1.7.1; (python_version >= '3.13') and extra == 'test'
37
+ Requires-Dist: pytest>=8; extra == 'test'
38
+ Description-Content-Type: text/markdown
39
+
40
+ ![python-version](https://img.shields.io/pypi/pyversions/supervision)
41
+ [![Supervision Coverage](https://img.shields.io/badge/supervision-0.30.0-purple)](./docs/coverage.md)
42
+
43
+ # ml-pipes-supervision
44
+
45
+ > [!IMPORTANT]
46
+ > `ml-pipes-supervision` remains a community-maintained operator package
47
+ > within the [ml-pipes](https://github.com/trained-by-humans) ecosystem. The
48
+ > project has its own maintainers and development roadmap, while benefiting
49
+ > from ml-pipes' verified publishing and distribution process.
50
+ >
51
+ > For contributions, issues, and project decisions, use this repository's
52
+ > maintainers and issue tracker.
53
+
54
+ ## Hello
55
+
56
+ [Supervision](https://github.com/roboflow/supervision) is your essential toolkit for computer vision. From data loading to real-time zone counting, it provides the building blocks so you can focus on building applications around your models.
57
+ `ml-pipes-supervision` provides `Supervision`
58
+ capabilities as composable operators in [ml-pipes](https://github.com/trained-by-humans/ml-pipes).
59
+
60
+ ## Coverage
61
+
62
+ | Task | Status |
63
+ |-----------------------------|-------------|
64
+ | Classification | Not covered |
65
+ | Detection | Covered |
66
+ | Segmentation | Covered |
67
+ | Keypoints | Not covered |
68
+ | Tracking | Covered |
69
+ | Tools (Zones, Slicer, etc.) | Covered |
70
+ | Dataset | Not covered |
71
+ | Evaluation | Not covered |
72
+ | Vision-language models | Not covered |
73
+
74
+ See [coverage](./docs/coverage.md) for role definitions and the detailed API
75
+ compatibility matrix.
76
+
77
+ ## Install
78
+
79
+ Install from PyPI in a [Python >=3.10](https://www.python.org/) environment:
80
+
81
+ ```bash
82
+ python -m pip install ml-pipes-supervision
83
+ ```
84
+
85
+ This also installs the required `ml-pipes` packages, including
86
+ `ml-pipes-core` and `ml-pipes-vision`, plus the Supervision and tracker runtime
87
+ dependencies.
88
+
89
+ To use `RoboflowInference` or run the inference-based examples, install the
90
+ optional Inference integration:
91
+
92
+ ```bash
93
+ python -m pip install "ml-pipes-supervision[inference]"
94
+ ```
95
+
96
+ The public operators are available from `ml_pipes.supervision`. Roboflow
97
+ Inference and external tracker boundaries are available from
98
+ `ml_pipes.supervision.inference` and `ml_pipes.supervision.trackers`.
99
+
100
+ To use the integration from another project's `pyproject.toml`, add the PyPI
101
+ package:
102
+
103
+ ```toml
104
+ dependencies = [
105
+ "ml-pipes-supervision[inference]",
106
+ ]
107
+ ```
108
+
109
+ ## Quickstart
110
+
111
+ Build the usual detection-and-annotation flow as one pipeline. The operators
112
+ below are the same thin boundaries used by the runnable examples.
113
+
114
+ ```python
115
+ from ml_pipes.core import Pipeline
116
+ from ml_pipes.standard import Recall, Select, Store
117
+ from ml_pipes.vision import Decode, LoadFile
118
+ from ml_pipes.supervision import BoxAnnotator, Detections, ImageToArray, LabelAnnotator, PlotImage
119
+ from ml_pipes.supervision.inference import RoboflowInference
120
+
121
+ pipeline = Pipeline(
122
+ [
123
+ LoadFile(),
124
+ Decode(),
125
+ ImageToArray(),
126
+ Store("source_image"),
127
+ RoboflowInference(model_id="rfdetr-small"),
128
+ Select(0),
129
+ Detections.FromInference(),
130
+ Recall("source_image", prepend=True),
131
+ BoxAnnotator(),
132
+ LabelAnnotator(),
133
+ PlotImage(),
134
+ ]
135
+ )
136
+ ```
137
+
138
+ For model integrations that produce an `ml_pipes.tensor.TensorRegistry`, use
139
+ `Detections.FromTensorRegistry()` before Supervision annotators, trackers,
140
+ zones, or sinks. This is the explicit boundary from tensor post-processing to
141
+ Supervision data.
142
+
143
+ ## Why Supervision with ml-pipes?
144
+
145
+ Supervision provides the computer-vision building blocks; ml-pipes makes the
146
+ boundaries between those blocks explicit, composable, and inspectable. A
147
+ pipeline can validate its contracts before execution and capture the value at
148
+ each operator boundary with `Pipeline.inspect()`. That makes complex flows
149
+ easier to understand and debug without adding ad-hoc logging to every step.
150
+
151
+ The Detect Small Objects pipeline is a good example: it tiles the input image,
152
+ runs inference on each tile, gathers the results, stitches detections back into
153
+ the source coordinate system, merges overlaps, and annotates the final image.
154
+ The inspection report shows every boundary in that flow.
155
+
156
+ [![Detect Small Objects pipeline inspection](docs/assets/detect_small_objects/inspection.png)](docs/assets/detect_small_objects/inspection.html)
157
+
158
+ *Click the image to open the interactive inspection report.*
159
+
160
+ ## Built with Supervision x ml-pipes
161
+
162
+ <details>
163
+ <summary>View supported Supervision example pipelines</summary>
164
+
165
+ | Example | Upstream Source | Section | Note |
166
+ |---|---|---|---|
167
+ | [`run_detect_and_annotate.py`](./examples/run_detect_and_annotate.py) | [`Detect and Annotate` (`0.30.0`)](https://supervision.roboflow.com/0.30.0/how_to/detect_and_annotate/) | `Run Detection`, `Annotate Image with Detections`, `Display Custom Labels` | Runs object detection, then draws bounding boxes and available class labels on the image. |
168
+ | [`run_filter_detections.py`](./examples/run_filter_detections.py) | [`Filter Detections` (`0.30.0`)](https://supervision.roboflow.com/0.30.0/how_to/filter_detections/) | `Filter Detections` | Keeps detections by class, confidence, and relative bounding-box area before annotation. |
169
+ | [`run_segment_and_annotate.py`](./examples/run_segment_and_annotate.py) | [`Detect and Annotate` (`0.30.0`)](https://supervision.roboflow.com/0.30.0/how_to/detect_and_annotate/) | `Run Detection`, `Annotate Image with Segmentations` | Runs instance segmentation and draws masks and labels on the image. |
170
+ | [`run_detection_video.py`](./examples/run_detection_video.py) | [`Annotate Video with Detections`](https://supervision.roboflow.com/0.30.0/notebooks/annotate-video-with-detections/) | `Run Detection` | Detects and annotates objects on each video frame, with an FPS overlay. |
171
+ | [`run_save_detections.py`](./examples/run_save_detections.py) | [`Save Detections`](https://supervision.roboflow.com/latest/how_to/save_detections/) | `Save Detections` | Runs detection on each video frame and writes the results to CSV. |
172
+ | [`run_track_objects.py`](./examples/run_track_objects.py) | [`Track Objects` (`0.30.0`)](https://supervision.roboflow.com/0.30.0/how_to/track_objects/) | `Track Objects`, `Annotate Tracking IDs`, `Annotate Traces`, `Smooth Tracked Detections` | Assigns persistent IDs, smooths tracked boxes, and draws IDs, classes, and motion paths. |
173
+ | [`run_count_in_zone.py`](./examples/run_count_in_zone.py) | [`Count Objects in Zone` (`0.30.0`)](https://supervision.roboflow.com/0.30.0/how_to/count_in_zone/) | `Count Objects in Zone` | Counts and annotates detections inside each configured polygon zone. |
174
+ | [`run_traffic_analysis.py`](./examples/run_traffic_analysis.py) | [`Traffic Analysis`](https://github.com/roboflow/supervision/tree/develop/examples/traffic_analysis) | `Track Zone Visits` | Records ordered vehicle visits between configured zones and displays unique origin-to-destination totals. |
175
+ | [`run_time_in_zone.py`](./examples/run_time_in_zone.py) | [`Time in Zone`](https://github.com/roboflow/supervision/tree/develop/examples/time_in_zone) | `Process Video` | Tracks each object and displays its continuous dwell time within each configured polygon zone. |
176
+ | [`run_count_objects_crossing_line.py`](./examples/run_count_objects_crossing_line.py) | [`Count Objects Crossing the Line`](https://supervision.roboflow.com/latest/notebooks/count-objects-crossing-the-line/#process-video) | `Process Video` | Tracks objects and counts their crossings in each direction over a line. |
177
+ | [`run_detect_small_objects.py`](./examples/run_detect_small_objects.py) | [`Detect Small Objects` (`0.30.0`)](https://supervision.roboflow.com/0.30.0/how_to/detect_small_objects/) | `Use InferenceSlicer` | Splits an image into overlapping tiles, detects objects per tile, and merges the results. |
178
+ | [`run_zero_shot_object_detection.py`](./examples/run_zero_shot_object_detection.py) | [`Zero-Shot Object Detection with YOLO-World` (`0.30.0`)](https://supervision.roboflow.com/0.30.0/notebooks/zero-shot-object-detection-with-yolo-world/) | `Process Video` | Detects objects matching a supplied text prompt and filters duplicate or oversized predictions. |
179
+ | [`run_oriented_bounding_boxes.py`](./examples/run_oriented_bounding_boxes.py) | [`Oriented Bounding Boxes` (`0.30.0`)](https://supervision.roboflow.com/0.30.0/notebooks/oriented-bounding-boxes/) | `Oriented Box Annotation` | Detects ships and draws their rotated bounding boxes. |
180
+ | [`run_blur_faces.py`](./examples/run_blur_faces.py) | [`Blurring Faces`](https://github.com/roboflow/supervision/blob/develop/docs/notebooks/blurring_faces.ipynb) | `Detecting Faces`, `Blurring the Face` | Detects faces in MediaPipe's sample image locally, then blurs them. |
181
+
182
+ </details>
183
+
184
+ ## Tutorials
185
+
186
+ Want to learn how to use Supervision with `ml-pipes`? Explore our
187
+ [how-to guides](https://trained-by-humans.github.io/ml-pipes-supervision/tutorials/detect_and_annotate/)
188
+ and [end-to-end examples](./examples/)!
189
+
190
+ The GitHub Pages tutorials preserve the corresponding Supervision guides and
191
+ add their `ml-pipes` counterparts, so you can compare both approaches side by
192
+ side.
@@ -0,0 +1,153 @@
1
+ ![python-version](https://img.shields.io/pypi/pyversions/supervision)
2
+ [![Supervision Coverage](https://img.shields.io/badge/supervision-0.30.0-purple)](./docs/coverage.md)
3
+
4
+ # ml-pipes-supervision
5
+
6
+ > [!IMPORTANT]
7
+ > `ml-pipes-supervision` remains a community-maintained operator package
8
+ > within the [ml-pipes](https://github.com/trained-by-humans) ecosystem. The
9
+ > project has its own maintainers and development roadmap, while benefiting
10
+ > from ml-pipes' verified publishing and distribution process.
11
+ >
12
+ > For contributions, issues, and project decisions, use this repository's
13
+ > maintainers and issue tracker.
14
+
15
+ ## Hello
16
+
17
+ [Supervision](https://github.com/roboflow/supervision) is your essential toolkit for computer vision. From data loading to real-time zone counting, it provides the building blocks so you can focus on building applications around your models.
18
+ `ml-pipes-supervision` provides `Supervision`
19
+ capabilities as composable operators in [ml-pipes](https://github.com/trained-by-humans/ml-pipes).
20
+
21
+ ## Coverage
22
+
23
+ | Task | Status |
24
+ |-----------------------------|-------------|
25
+ | Classification | Not covered |
26
+ | Detection | Covered |
27
+ | Segmentation | Covered |
28
+ | Keypoints | Not covered |
29
+ | Tracking | Covered |
30
+ | Tools (Zones, Slicer, etc.) | Covered |
31
+ | Dataset | Not covered |
32
+ | Evaluation | Not covered |
33
+ | Vision-language models | Not covered |
34
+
35
+ See [coverage](./docs/coverage.md) for role definitions and the detailed API
36
+ compatibility matrix.
37
+
38
+ ## Install
39
+
40
+ Install from PyPI in a [Python >=3.10](https://www.python.org/) environment:
41
+
42
+ ```bash
43
+ python -m pip install ml-pipes-supervision
44
+ ```
45
+
46
+ This also installs the required `ml-pipes` packages, including
47
+ `ml-pipes-core` and `ml-pipes-vision`, plus the Supervision and tracker runtime
48
+ dependencies.
49
+
50
+ To use `RoboflowInference` or run the inference-based examples, install the
51
+ optional Inference integration:
52
+
53
+ ```bash
54
+ python -m pip install "ml-pipes-supervision[inference]"
55
+ ```
56
+
57
+ The public operators are available from `ml_pipes.supervision`. Roboflow
58
+ Inference and external tracker boundaries are available from
59
+ `ml_pipes.supervision.inference` and `ml_pipes.supervision.trackers`.
60
+
61
+ To use the integration from another project's `pyproject.toml`, add the PyPI
62
+ package:
63
+
64
+ ```toml
65
+ dependencies = [
66
+ "ml-pipes-supervision[inference]",
67
+ ]
68
+ ```
69
+
70
+ ## Quickstart
71
+
72
+ Build the usual detection-and-annotation flow as one pipeline. The operators
73
+ below are the same thin boundaries used by the runnable examples.
74
+
75
+ ```python
76
+ from ml_pipes.core import Pipeline
77
+ from ml_pipes.standard import Recall, Select, Store
78
+ from ml_pipes.vision import Decode, LoadFile
79
+ from ml_pipes.supervision import BoxAnnotator, Detections, ImageToArray, LabelAnnotator, PlotImage
80
+ from ml_pipes.supervision.inference import RoboflowInference
81
+
82
+ pipeline = Pipeline(
83
+ [
84
+ LoadFile(),
85
+ Decode(),
86
+ ImageToArray(),
87
+ Store("source_image"),
88
+ RoboflowInference(model_id="rfdetr-small"),
89
+ Select(0),
90
+ Detections.FromInference(),
91
+ Recall("source_image", prepend=True),
92
+ BoxAnnotator(),
93
+ LabelAnnotator(),
94
+ PlotImage(),
95
+ ]
96
+ )
97
+ ```
98
+
99
+ For model integrations that produce an `ml_pipes.tensor.TensorRegistry`, use
100
+ `Detections.FromTensorRegistry()` before Supervision annotators, trackers,
101
+ zones, or sinks. This is the explicit boundary from tensor post-processing to
102
+ Supervision data.
103
+
104
+ ## Why Supervision with ml-pipes?
105
+
106
+ Supervision provides the computer-vision building blocks; ml-pipes makes the
107
+ boundaries between those blocks explicit, composable, and inspectable. A
108
+ pipeline can validate its contracts before execution and capture the value at
109
+ each operator boundary with `Pipeline.inspect()`. That makes complex flows
110
+ easier to understand and debug without adding ad-hoc logging to every step.
111
+
112
+ The Detect Small Objects pipeline is a good example: it tiles the input image,
113
+ runs inference on each tile, gathers the results, stitches detections back into
114
+ the source coordinate system, merges overlaps, and annotates the final image.
115
+ The inspection report shows every boundary in that flow.
116
+
117
+ [![Detect Small Objects pipeline inspection](docs/assets/detect_small_objects/inspection.png)](docs/assets/detect_small_objects/inspection.html)
118
+
119
+ *Click the image to open the interactive inspection report.*
120
+
121
+ ## Built with Supervision x ml-pipes
122
+
123
+ <details>
124
+ <summary>View supported Supervision example pipelines</summary>
125
+
126
+ | Example | Upstream Source | Section | Note |
127
+ |---|---|---|---|
128
+ | [`run_detect_and_annotate.py`](./examples/run_detect_and_annotate.py) | [`Detect and Annotate` (`0.30.0`)](https://supervision.roboflow.com/0.30.0/how_to/detect_and_annotate/) | `Run Detection`, `Annotate Image with Detections`, `Display Custom Labels` | Runs object detection, then draws bounding boxes and available class labels on the image. |
129
+ | [`run_filter_detections.py`](./examples/run_filter_detections.py) | [`Filter Detections` (`0.30.0`)](https://supervision.roboflow.com/0.30.0/how_to/filter_detections/) | `Filter Detections` | Keeps detections by class, confidence, and relative bounding-box area before annotation. |
130
+ | [`run_segment_and_annotate.py`](./examples/run_segment_and_annotate.py) | [`Detect and Annotate` (`0.30.0`)](https://supervision.roboflow.com/0.30.0/how_to/detect_and_annotate/) | `Run Detection`, `Annotate Image with Segmentations` | Runs instance segmentation and draws masks and labels on the image. |
131
+ | [`run_detection_video.py`](./examples/run_detection_video.py) | [`Annotate Video with Detections`](https://supervision.roboflow.com/0.30.0/notebooks/annotate-video-with-detections/) | `Run Detection` | Detects and annotates objects on each video frame, with an FPS overlay. |
132
+ | [`run_save_detections.py`](./examples/run_save_detections.py) | [`Save Detections`](https://supervision.roboflow.com/latest/how_to/save_detections/) | `Save Detections` | Runs detection on each video frame and writes the results to CSV. |
133
+ | [`run_track_objects.py`](./examples/run_track_objects.py) | [`Track Objects` (`0.30.0`)](https://supervision.roboflow.com/0.30.0/how_to/track_objects/) | `Track Objects`, `Annotate Tracking IDs`, `Annotate Traces`, `Smooth Tracked Detections` | Assigns persistent IDs, smooths tracked boxes, and draws IDs, classes, and motion paths. |
134
+ | [`run_count_in_zone.py`](./examples/run_count_in_zone.py) | [`Count Objects in Zone` (`0.30.0`)](https://supervision.roboflow.com/0.30.0/how_to/count_in_zone/) | `Count Objects in Zone` | Counts and annotates detections inside each configured polygon zone. |
135
+ | [`run_traffic_analysis.py`](./examples/run_traffic_analysis.py) | [`Traffic Analysis`](https://github.com/roboflow/supervision/tree/develop/examples/traffic_analysis) | `Track Zone Visits` | Records ordered vehicle visits between configured zones and displays unique origin-to-destination totals. |
136
+ | [`run_time_in_zone.py`](./examples/run_time_in_zone.py) | [`Time in Zone`](https://github.com/roboflow/supervision/tree/develop/examples/time_in_zone) | `Process Video` | Tracks each object and displays its continuous dwell time within each configured polygon zone. |
137
+ | [`run_count_objects_crossing_line.py`](./examples/run_count_objects_crossing_line.py) | [`Count Objects Crossing the Line`](https://supervision.roboflow.com/latest/notebooks/count-objects-crossing-the-line/#process-video) | `Process Video` | Tracks objects and counts their crossings in each direction over a line. |
138
+ | [`run_detect_small_objects.py`](./examples/run_detect_small_objects.py) | [`Detect Small Objects` (`0.30.0`)](https://supervision.roboflow.com/0.30.0/how_to/detect_small_objects/) | `Use InferenceSlicer` | Splits an image into overlapping tiles, detects objects per tile, and merges the results. |
139
+ | [`run_zero_shot_object_detection.py`](./examples/run_zero_shot_object_detection.py) | [`Zero-Shot Object Detection with YOLO-World` (`0.30.0`)](https://supervision.roboflow.com/0.30.0/notebooks/zero-shot-object-detection-with-yolo-world/) | `Process Video` | Detects objects matching a supplied text prompt and filters duplicate or oversized predictions. |
140
+ | [`run_oriented_bounding_boxes.py`](./examples/run_oriented_bounding_boxes.py) | [`Oriented Bounding Boxes` (`0.30.0`)](https://supervision.roboflow.com/0.30.0/notebooks/oriented-bounding-boxes/) | `Oriented Box Annotation` | Detects ships and draws their rotated bounding boxes. |
141
+ | [`run_blur_faces.py`](./examples/run_blur_faces.py) | [`Blurring Faces`](https://github.com/roboflow/supervision/blob/develop/docs/notebooks/blurring_faces.ipynb) | `Detecting Faces`, `Blurring the Face` | Detects faces in MediaPipe's sample image locally, then blurs them. |
142
+
143
+ </details>
144
+
145
+ ## Tutorials
146
+
147
+ Want to learn how to use Supervision with `ml-pipes`? Explore our
148
+ [how-to guides](https://trained-by-humans.github.io/ml-pipes-supervision/tutorials/detect_and_annotate/)
149
+ and [end-to-end examples](./examples/)!
150
+
151
+ The GitHub Pages tutorials preserve the corresponding Supervision guides and
152
+ add their `ml-pipes` counterparts, so you can compare both approaches side by
153
+ side.
@@ -0,0 +1,72 @@
1
+ [build-system]
2
+ requires = ["hatchling>=1.27"]
3
+ build-backend = "hatchling.build"
4
+
5
+ [project]
6
+ name = "ml-pipes-supervision"
7
+ version = "0.1.2rc2"
8
+ description = "Roboflow Supervision and Inference compatibility wrappers for ml-pipes"
9
+ readme = "README.md"
10
+ license = "Apache-2.0"
11
+ license-files = ["LICENSE"]
12
+ keywords = [
13
+ "annotation",
14
+ "computer-vision",
15
+ "pipelines",
16
+ "supervision",
17
+ "tracking",
18
+ ]
19
+ classifiers = [
20
+ "Development Status :: 3 - Alpha",
21
+ "Intended Audience :: Developers",
22
+ "License :: OSI Approved :: Apache Software License",
23
+ "Programming Language :: Python :: 3",
24
+ "Programming Language :: Python :: 3.10",
25
+ "Programming Language :: Python :: 3.11",
26
+ "Programming Language :: Python :: 3.12",
27
+ "Programming Language :: Python :: 3.13",
28
+ "Topic :: Scientific/Engineering :: Artificial Intelligence",
29
+ "Topic :: Software Development :: Libraries :: Application Frameworks",
30
+ ]
31
+ requires-python = ">=3.10"
32
+ dependencies = [
33
+ "ml-pipes-core==0.1.2rc1",
34
+ "ml-pipes-vision==0.1.2rc1",
35
+ "supervision>=0.29,<0.31",
36
+ "trackers",
37
+ ]
38
+
39
+ [project.urls]
40
+ Homepage = "https://trained-by-humans.github.io/ml-pipes-supervision/"
41
+ Documentation = "https://trained-by-humans.github.io/ml-pipes-supervision/"
42
+ Repository = "https://github.com/trained-by-humans/ml-pipes-supervision"
43
+ Issues = "https://github.com/trained-by-humans/ml-pipes-supervision/issues"
44
+ Changelog = "https://github.com/trained-by-humans/ml-pipes-supervision/releases"
45
+
46
+ [project.optional-dependencies]
47
+ inference = [
48
+ # Inference 1.3.8 is the last Python <3.13 release that supports
49
+ # Supervision 0.30; Python 3.13 requires Inference 1.7.
50
+ "inference==1.3.8; python_version < '3.13'",
51
+ "inference==1.7.1; python_version >= '3.13'",
52
+ ]
53
+ test = [
54
+ "pytest>=8",
55
+ "inference==1.3.8; python_version < '3.13'",
56
+ "inference==1.7.1; python_version >= '3.13'",
57
+ ]
58
+ docs = [
59
+ "mike>=2.1",
60
+ "mkdocs-material>=9.6",
61
+ ]
62
+
63
+ [tool.hatch.build.targets.wheel]
64
+ packages = ["src/ml_pipes"]
65
+
66
+ [tool.hatch.build.targets.sdist]
67
+ include = [
68
+ "LICENSE",
69
+ "README.md",
70
+ "pyproject.toml",
71
+ "src/ml_pipes",
72
+ ]