reid 0.1.0__tar.gz

reid-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

reid-0.1.0/PKG-INFO

@@ -0,0 +1,177 @@
+Metadata-Version: 2.4
+Name: reid
+Version: 0.1.0
+Summary: Re-identification model stack for appearance embeddings
+Author-email: "Roboflow et al." <develop@roboflow.com>
+License-Expression: Apache-2.0
+Keywords: reid,re-identification,tracking,computer-vision,deep-learning
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: opencv-python
+Requires-Dist: supervision>=0.26.1
+Requires-Dist: torch>=2.0
+Requires-Dist: torchvision>=0.15
+Requires-Dist: timm>=1.0
+Requires-Dist: huggingface-hub>=0.20
+Requires-Dist: safetensors>=0.4
+Requires-Dist: Pillow>=10
+Requires-Dist: gdown>=5
+Provides-Extra: dev
+Requires-Dist: pytest>=8.3.3; extra == "dev"
+Requires-Dist: pre-commit>=4.2.0; extra == "dev"
+Dynamic: license-file
+
+<div align="center">
+    <h1>reid</h1>
+    <p>Load and evaluate person re-identification models in Python.</p>
+
+[![version](https://badge.fury.io/py/reid.svg)](https://badge.fury.io/py/reid) [![downloads](https://img.shields.io/pypi/dm/reid)](https://pypistats.org/packages/reid) [![license](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE) [![python-version](https://img.shields.io/pypi/pyversions/reid)](https://badge.fury.io/py/reid) [![discord](https://img.shields.io/discord/1159501506232451173?logo=discord&label=discord&labelColor=fff&color=5865f2&link=https%3A%2F%2Fdiscord.gg%2FGbfgXGJ8Bk)](https://discord.gg/GbfgXGJ8Bk)
+
+</div>
+
+`reid` turns a person crop into an appearance embedding, a vector that is close for crops of the same person and far apart for different people. It loads pretrained OSNet and FastReID checkpoints, embeds `supervision.Detections` from any detector or crops saved on disk, and measures how well a model matches people: across cameras with retrieval on Market-1501 and MSMT17, or over time with re-association on crops cut from MOT-format video. Requires Python 3.10 or newer.
+
+https://github.com/user-attachments/assets/68fe0a58-1414-4776-a4a0-412cbcb68643
+
+Gallery retrieval with `osnet_x1_0_msmt17_combineall`: crops ranked by cosine distance to a query player, closest first. The other [pretrained models](#pretrained-models) work the same way.
+
+Read the [documentation](https://reid.roboflow.com/) for guides and the API reference.
+
+## Install
+
+```bash
+pip install -U reid
+```
+
+<details>
+<summary>Install from source</summary>
+
+```bash
+pip install git+https://github.com/roboflow/re-ID.git
+```
+
+For development, clone the repository and run `uv sync --all-extras` or `pip install -e ".[dev]"`.
+
+</details>
+
+## Quick start
+
+`extract_embeddings` computes one embedding for each bounding box in a frame. Pass the boxes as `sv.Detections`, which you can get from a detector like [RF-DETR](https://github.com/roboflow/rf-detr). Below, two people are boxed in the first frame of a sample video. `from_pretrained` downloads the model you name, here OSNet x1.0 trained on MSMT17.
+
+```python
+import numpy as np
+import supervision as sv
+from supervision.assets import VideoAssets, download_assets
+from reid import ReIDModel
+
+model = ReIDModel.from_pretrained("osnet_x1_0_msmt17_combineall")
+
+frame = next(sv.get_video_frames_generator(download_assets(VideoAssets.PEOPLE_WALKING)))
+detections = sv.Detections(xyxy=np.array([[746, 446, 828, 628], [1136, 502, 1214, 660]], dtype=np.float32))
+embeddings = model.extract_embeddings(detections, frame)
+
+embeddings.shape
+# (2, 512)
+```
+
+Crops already saved as images work the same way:
+
+```python
+embeddings = model.extract_embeddings_from_paths(["crop_1.jpg", "crop_2.jpg"])
+```
+
+For every way to load a model, including saved models, Hugging Face repositories, and weights files, see the [loading guide](docs/guides/loading.md).
+
+There are two ways to build a model: `ReIDModel.from_pretrained("osnet_x1_0_msmt17_combineall")` loads trained weights, and `ReIDModel("osnet_x1_0")` builds the architecture with random weights.
+
+## Evaluate
+
+`model.evaluate` scores a model on benchmark splits or on your own identity folders, one folder of crops per person.
+
+```python
+from reid import ReIDModel, load_identity_folders, load_market1501
+
+model = ReIDModel.from_pretrained("osnet_x1_0_msmt17_combineall")
+
+query, gallery = load_market1501("/path/to/Market-1501")
+result = model.evaluate(query, gallery)
+
+result = model.evaluate(load_identity_folders("/path/to/identity/folders"))
+result.metrics
+# {'map': ..., 'rank1': ..., 'rank5': ..., 'rank10': ..., 'minp': ...}
+```
+
+For crops cut from video, `ReassociationProtocol` asks whether the model recognizes a person a set number of frames later, the way a tracker uses it. See the [evaluation guide](docs/guides/evaluation.md) and the [metric definitions](docs/learn/metrics.md).
+
+## Pretrained models
+
+| Name                           | Architecture             | Trained on                          | Use for                                                                                         |
+| :----------------------------- | :----------------------- | :---------------------------------- | :---------------------------------------------------------------------------------------------- |
+| `osnet_x1_0_msmt17_combineall` | OSNet x1.0               | MSMT17, all splits combined         | General pedestrian embeddings. Not for evaluating on MSMT17, whose test identities it has seen. |
+| `fastreid_mot17_sbs50`         | FastReID SBS, ResNeSt-50 | MOT17 train-half ground-truth crops | MOT17 tracking, as in BoT-SORT                                                                  |
+| `osnet_x1_0_mot17`             | OSNet x1.0               | MOT17 train-half crops              | Tracking pedestrians, as in MOT17                                                               |
+| `osnet_x1_0_sportsmot`         | OSNet x1.0               | SportsMOT train crops               | Tracking basketball, football and volleyball players, as in SportsMOT                           |
+| `osnet_x1_0_dancetrack`        | OSNet x1.0               | DanceTrack train crops              | Tracking dancers in similar outfits, as in DanceTrack                                           |
+| `osnet_x1_0_soccernet`         | OSNet x1.0               | SoccerNet train crops               | Tracking soccer players, as in SoccerNet                                                        |
+
+`list_aliases()` lists these names. Any `timm:<name>` backbone and other OSNet sizes load from a weights file; see the [loading guide](docs/guides/loading.md).
+
+## Tutorials
+
+<p align="left">
+<a href="https://colab.research.google.com/github/roboflow/re-ID/blob/main/docs/cookbooks/how-to-use-reid.ipynb"><img src="docs/assets/tutorials/rank-metrics.jpg" alt="A query player and the first eight crops of the gallery ranked by distance, the same player at ranks 1 to 6" width="300px" align="left" /></a>
+<a href="https://colab.research.google.com/github/roboflow/re-ID/blob/main/docs/cookbooks/how-to-use-reid.ipynb"><strong>How to Use Re-ID</strong></a>
+<br/>Load a model, match the boxes of a MOT17 frame to a later frame with <code>distance_matrix</code>, see identities cluster, and evaluate with retrieval and re-association.
+<br/><br/><a href="https://colab.research.google.com/github/roboflow/re-ID/blob/main/docs/cookbooks/how-to-use-reid.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab" /></a>
+</p>
+<br clear="left"/>
+
+<p align="left">
+<a href="https://colab.research.google.com/github/roboflow/re-ID/blob/main/docs/cookbooks/how-to-benchmark-reid-models.ipynb"><img src="docs/assets/query-gallery.webp" alt="A query player, a gallery of crops, and the gallery ranked by similarity with the matches outlined" width="300px" align="left" /></a>
+<a href="https://colab.research.google.com/github/roboflow/re-ID/blob/main/docs/cookbooks/how-to-benchmark-reid-models.ipynb"><strong>How to Benchmark Re-ID Models</strong></a>
+<br/>Evaluate OSNet x1.0 on Market-1501 and MSMT17 and compare against the torchreid model zoo.
+<br/><br/><a href="https://colab.research.google.com/github/roboflow/re-ID/blob/main/docs/cookbooks/how-to-benchmark-reid-models.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab" /></a>
+</p>
+<br clear="left"/>
+
+## Guides
+
+| Guide                                           | What you will do                                                                                               |
+| :---------------------------------------------- | :------------------------------------------------------------------------------------------------------------- |
+| [Load a model](docs/guides/loading.md)          | Load pretrained names, saved models, Hugging Face repositories, and weights files, and set image preprocessing |
+| [Evaluate a model](docs/guides/evaluation.md)   | Score a model on Market-1501, your own identity folders, or crops cut from video                               |
+| [Understand the metrics](docs/learn/metrics.md) | Read mAP, rank-k, mINP, and MRR, and see why tracking needs re-association                                     |
+
+## Citation
+
+If you use `reid` in academic work, please cite the library:
+
+<details>
+<summary>BibTeX</summary>
+
+```bibtex
+@software{roboflow_reid,
+  author  = {{Roboflow}},
+  title   = {Roboflow Re-ID},
+  url     = {https://github.com/roboflow/re-ID},
+  year    = {2026},
+  license = {Apache-2.0}
+}
+```
+
+</details>
+
+For the models themselves, cite OSNet ([Zhou et al., ICCV 2019](https://arxiv.org/abs/1905.00953)) and FastReID ([He et al., 2020](https://arxiv.org/abs/2006.02631)).
+
+## License
+
+The code is released under the [Apache 2.0 license](LICENSE).

reid-0.1.0/README.md

@@ -0,0 +1,145 @@
+<div align="center">
+    <h1>reid</h1>
+    <p>Load and evaluate person re-identification models in Python.</p>
+
+[![version](https://badge.fury.io/py/reid.svg)](https://badge.fury.io/py/reid) [![downloads](https://img.shields.io/pypi/dm/reid)](https://pypistats.org/packages/reid) [![license](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE) [![python-version](https://img.shields.io/pypi/pyversions/reid)](https://badge.fury.io/py/reid) [![discord](https://img.shields.io/discord/1159501506232451173?logo=discord&label=discord&labelColor=fff&color=5865f2&link=https%3A%2F%2Fdiscord.gg%2FGbfgXGJ8Bk)](https://discord.gg/GbfgXGJ8Bk)
+
+</div>
+
+`reid` turns a person crop into an appearance embedding, a vector that is close for crops of the same person and far apart for different people. It loads pretrained OSNet and FastReID checkpoints, embeds `supervision.Detections` from any detector or crops saved on disk, and measures how well a model matches people: across cameras with retrieval on Market-1501 and MSMT17, or over time with re-association on crops cut from MOT-format video. Requires Python 3.10 or newer.
+
+https://github.com/user-attachments/assets/68fe0a58-1414-4776-a4a0-412cbcb68643
+
+Gallery retrieval with `osnet_x1_0_msmt17_combineall`: crops ranked by cosine distance to a query player, closest first. The other [pretrained models](#pretrained-models) work the same way.
+
+Read the [documentation](https://reid.roboflow.com/) for guides and the API reference.
+
+## Install
+
+```bash
+pip install -U reid
+```
+
+<details>
+<summary>Install from source</summary>
+
+```bash
+pip install git+https://github.com/roboflow/re-ID.git
+```
+
+For development, clone the repository and run `uv sync --all-extras` or `pip install -e ".[dev]"`.
+
+</details>
+
+## Quick start
+
+`extract_embeddings` computes one embedding for each bounding box in a frame. Pass the boxes as `sv.Detections`, which you can get from a detector like [RF-DETR](https://github.com/roboflow/rf-detr). Below, two people are boxed in the first frame of a sample video. `from_pretrained` downloads the model you name, here OSNet x1.0 trained on MSMT17.
+
+```python
+import numpy as np
+import supervision as sv
+from supervision.assets import VideoAssets, download_assets
+from reid import ReIDModel
+
+model = ReIDModel.from_pretrained("osnet_x1_0_msmt17_combineall")
+
+frame = next(sv.get_video_frames_generator(download_assets(VideoAssets.PEOPLE_WALKING)))
+detections = sv.Detections(xyxy=np.array([[746, 446, 828, 628], [1136, 502, 1214, 660]], dtype=np.float32))
+embeddings = model.extract_embeddings(detections, frame)
+
+embeddings.shape
+# (2, 512)
+```
+
+Crops already saved as images work the same way:
+
+```python
+embeddings = model.extract_embeddings_from_paths(["crop_1.jpg", "crop_2.jpg"])
+```
+
+For every way to load a model, including saved models, Hugging Face repositories, and weights files, see the [loading guide](docs/guides/loading.md).
+
+There are two ways to build a model: `ReIDModel.from_pretrained("osnet_x1_0_msmt17_combineall")` loads trained weights, and `ReIDModel("osnet_x1_0")` builds the architecture with random weights.
+
+## Evaluate
+
+`model.evaluate` scores a model on benchmark splits or on your own identity folders, one folder of crops per person.
+
+```python
+from reid import ReIDModel, load_identity_folders, load_market1501
+
+model = ReIDModel.from_pretrained("osnet_x1_0_msmt17_combineall")
+
+query, gallery = load_market1501("/path/to/Market-1501")
+result = model.evaluate(query, gallery)
+
+result = model.evaluate(load_identity_folders("/path/to/identity/folders"))
+result.metrics
+# {'map': ..., 'rank1': ..., 'rank5': ..., 'rank10': ..., 'minp': ...}
+```
+
+For crops cut from video, `ReassociationProtocol` asks whether the model recognizes a person a set number of frames later, the way a tracker uses it. See the [evaluation guide](docs/guides/evaluation.md) and the [metric definitions](docs/learn/metrics.md).
+
+## Pretrained models
+
+| Name                           | Architecture             | Trained on                          | Use for                                                                                         |
+| :----------------------------- | :----------------------- | :---------------------------------- | :---------------------------------------------------------------------------------------------- |
+| `osnet_x1_0_msmt17_combineall` | OSNet x1.0               | MSMT17, all splits combined         | General pedestrian embeddings. Not for evaluating on MSMT17, whose test identities it has seen. |
+| `fastreid_mot17_sbs50`         | FastReID SBS, ResNeSt-50 | MOT17 train-half ground-truth crops | MOT17 tracking, as in BoT-SORT                                                                  |
+| `osnet_x1_0_mot17`             | OSNet x1.0               | MOT17 train-half crops              | Tracking pedestrians, as in MOT17                                                               |
+| `osnet_x1_0_sportsmot`         | OSNet x1.0               | SportsMOT train crops               | Tracking basketball, football and volleyball players, as in SportsMOT                           |
+| `osnet_x1_0_dancetrack`        | OSNet x1.0               | DanceTrack train crops              | Tracking dancers in similar outfits, as in DanceTrack                                           |
+| `osnet_x1_0_soccernet`         | OSNet x1.0               | SoccerNet train crops               | Tracking soccer players, as in SoccerNet                                                        |
+
+`list_aliases()` lists these names. Any `timm:<name>` backbone and other OSNet sizes load from a weights file; see the [loading guide](docs/guides/loading.md).
+
+## Tutorials
+
+<p align="left">
+<a href="https://colab.research.google.com/github/roboflow/re-ID/blob/main/docs/cookbooks/how-to-use-reid.ipynb"><img src="docs/assets/tutorials/rank-metrics.jpg" alt="A query player and the first eight crops of the gallery ranked by distance, the same player at ranks 1 to 6" width="300px" align="left" /></a>
+<a href="https://colab.research.google.com/github/roboflow/re-ID/blob/main/docs/cookbooks/how-to-use-reid.ipynb"><strong>How to Use Re-ID</strong></a>
+<br/>Load a model, match the boxes of a MOT17 frame to a later frame with <code>distance_matrix</code>, see identities cluster, and evaluate with retrieval and re-association.
+<br/><br/><a href="https://colab.research.google.com/github/roboflow/re-ID/blob/main/docs/cookbooks/how-to-use-reid.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab" /></a>
+</p>
+<br clear="left"/>
+
+<p align="left">
+<a href="https://colab.research.google.com/github/roboflow/re-ID/blob/main/docs/cookbooks/how-to-benchmark-reid-models.ipynb"><img src="docs/assets/query-gallery.webp" alt="A query player, a gallery of crops, and the gallery ranked by similarity with the matches outlined" width="300px" align="left" /></a>
+<a href="https://colab.research.google.com/github/roboflow/re-ID/blob/main/docs/cookbooks/how-to-benchmark-reid-models.ipynb"><strong>How to Benchmark Re-ID Models</strong></a>
+<br/>Evaluate OSNet x1.0 on Market-1501 and MSMT17 and compare against the torchreid model zoo.
+<br/><br/><a href="https://colab.research.google.com/github/roboflow/re-ID/blob/main/docs/cookbooks/how-to-benchmark-reid-models.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab" /></a>
+</p>
+<br clear="left"/>
+
+## Guides
+
+| Guide                                           | What you will do                                                                                               |
+| :---------------------------------------------- | :------------------------------------------------------------------------------------------------------------- |
+| [Load a model](docs/guides/loading.md)          | Load pretrained names, saved models, Hugging Face repositories, and weights files, and set image preprocessing |
+| [Evaluate a model](docs/guides/evaluation.md)   | Score a model on Market-1501, your own identity folders, or crops cut from video                               |
+| [Understand the metrics](docs/learn/metrics.md) | Read mAP, rank-k, mINP, and MRR, and see why tracking needs re-association                                     |
+
+## Citation
+
+If you use `reid` in academic work, please cite the library:
+
+<details>
+<summary>BibTeX</summary>
+
+```bibtex
+@software{roboflow_reid,
+  author  = {{Roboflow}},
+  title   = {Roboflow Re-ID},
+  url     = {https://github.com/roboflow/re-ID},
+  year    = {2026},
+  license = {Apache-2.0}
+}
+```
+
+</details>
+
+For the models themselves, cite OSNet ([Zhou et al., ICCV 2019](https://arxiv.org/abs/1905.00953)) and FastReID ([He et al., 2020](https://arxiv.org/abs/2006.02631)).
+
+## License
+
+The code is released under the [Apache 2.0 license](LICENSE).

reid-0.1.0/pyproject.toml

@@ -0,0 +1,83 @@
+[project]
+name = "reid"
+version = "0.1.0"
+description = "Re-identification model stack for appearance embeddings"
+readme = "README.md"
+authors = [
+  { name = "Roboflow et al.", email = "develop@roboflow.com" },
+]
+license = "Apache-2.0"
+requires-python = ">=3.10"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Typing :: Typed",
+]
+keywords = ["reid", "re-identification", "tracking", "computer-vision", "deep-learning"]
+
+dependencies = [
+    "numpy",
+    "opencv-python",
+    "supervision>=0.26.1",
+    "torch>=2.0",
+    "torchvision>=0.15",
+    "timm>=1.0",
+    "huggingface-hub>=0.20",
+    "safetensors>=0.4",
+    "Pillow>=10",
+    "gdown>=5",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.3.3",
+    "pre-commit>=4.2.0",
+]
+
+[dependency-groups]
+docs = [
+    "mkdocs>=1.6.1",
+    "mkdocs-material>=9.6.11",
+    "mkdocstrings-python>=1.10.9,<3.0.0",
+]
+build = [
+    "twine>=5.1.1",
+]
+
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["reid*"]
+
+[tool.setuptools.package-data]
+reid = ["py.typed"]
+
+[tool.pytest.ini_options]
+markers = [
+    "slow: downloads curated weights (network)",
+]
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 120
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP"]
+
+[tool.mypy]
+python_version = "3.10"
+warn_return_any = true
+warn_unused_configs = true
+ignore_missing_imports = true
+
+[tool.codespell]
+skip = "*.pth,*.svg"
+ignore-words-list = "mot"

reid-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

reid-0.1.0/src/reid/__init__.py

@@ -0,0 +1,45 @@
+# ------------------------------------------------------------------------
+# re-ID
+# Copyright (c) 2026 Roboflow. All Rights Reserved.
+# Licensed under the Apache License, Version 2.0 [see LICENSE for details]
+# ------------------------------------------------------------------------
+
+"""re-ID: appearance re-identification models and gallery evaluation.
+
+The public surface is intentionally narrow. Advanced helpers live in
+submodules: checkpoint loading in :mod:`reid.loaders`, the curated alias
+catalog and ``ModelCard`` in :mod:`reid.catalog`, shared dataset types and
+benchmark loaders in :mod:`reid.data`, and architecture dispatch in
+:mod:`reid.architectures`.
+"""
+
+from __future__ import annotations
+
+from reid.architectures import list_architectures
+from reid.catalog import FASTREID_MOT17_SBS50, list_aliases
+from reid.data import ReIDSplit, load_identity_folders, load_market1501, load_msmt17
+from reid.eval import (
+    ReassociationProtocol,
+    ReIDResult,
+    RetrievalProtocol,
+    distance_matrix,
+)
+from reid.model import ReIDModel
+from reid.preprocessing import Interpolation, ReIDPreprocessing
+
+__all__ = [
+    "FASTREID_MOT17_SBS50",
+    "Interpolation",
+    "ReassociationProtocol",
+    "ReIDModel",
+    "ReIDPreprocessing",
+    "ReIDResult",
+    "ReIDSplit",
+    "RetrievalProtocol",
+    "distance_matrix",
+    "list_aliases",
+    "list_architectures",
+    "load_identity_folders",
+    "load_market1501",
+    "load_msmt17",
+]