v0.43.0

See https://github.com/quic/ai-hub-models/releases/v0.43.0 for changelog.

LICENSE

@@ -0,0 +1,2 @@
+The license of the original trained model can be found at https://github.com/WongKinYiu/yolor/blob/main/LICENSE.
+The license for the deployable model files (.tflite, .onnx, .dlc, .bin, etc.) can be found at https://github.com/WongKinYiu/yolor/blob/main/LICENSE.

README.md

@@ -0,0 +1,258 @@
+---
+library_name: pytorch
+license: other
+tags:
+- real_time
+- android
+pipeline_tag: object-detection
+
+---
+
+![](https://qaihub-public-assets.s3.us-west-2.amazonaws.com/qai-hub-models/models/yolor/web-assets/model_demo.png)
+
+# Yolo-R: Optimized for Mobile Deployment
+## Real-time object detection optimized for mobile and edge
+
+
+YoloR is a machine learning model that predicts bounding boxes and classes of objects in an image.
+
+This model is an implementation of Yolo-R found [here](https://github.com/WongKinYiu/yolor.git).
+
+
+This repository provides scripts to run Yolo-R on Qualcomm® devices.
+More details on model performance across various devices, can be found
+[here](https://aihub.qualcomm.com/models/yolor).
+
+**WARNING**: The model assets are not readily available for download due to licensing restrictions.
+
+### Model Details
+
+- **Model Type:** Model_use_case.object_detection
+- **Model Stats:**
+  - Model checkpoint: yolor_p6
+  - Input resolution: 640x640
+  - Number of parameters: 4.68M
+  - Model size (float): 17.9 MB
+
+| Model | Precision | Device | Chipset | Target Runtime | Inference Time (ms) | Peak Memory Range (MB) | Primary Compute Unit | Target Model
+|---|---|---|---|---|---|---|---|---|
+| Yolo-R | float | QCS8275 (Proxy) | Qualcomm® QCS8275 (Proxy) | TFLITE | 129.679 ms | 0 - 109 MB | NPU | -- |
+| Yolo-R | float | QCS8275 (Proxy) | Qualcomm® QCS8275 (Proxy) | QNN_DLC | 96.176 ms | 4 - 165 MB | NPU | -- |
+| Yolo-R | float | QCS8450 (Proxy) | Qualcomm® QCS8450 (Proxy) | TFLITE | 77.424 ms | 0 - 141 MB | NPU | -- |
+| Yolo-R | float | QCS8450 (Proxy) | Qualcomm® QCS8450 (Proxy) | QNN_DLC | 58.444 ms | 5 - 116 MB | NPU | -- |
+| Yolo-R | float | QCS8550 (Proxy) | Qualcomm® QCS8550 (Proxy) | TFLITE | 47.158 ms | 0 - 27 MB | NPU | -- |
+| Yolo-R | float | QCS8550 (Proxy) | Qualcomm® QCS8550 (Proxy) | QNN_DLC | 27.084 ms | 5 - 45 MB | NPU | -- |
+| Yolo-R | float | QCS8550 (Proxy) | Qualcomm® QCS8550 (Proxy) | ONNX | 46.573 ms | 0 - 171 MB | NPU | -- |
+| Yolo-R | float | QCS9075 (Proxy) | Qualcomm® QCS9075 (Proxy) | TFLITE | 54.495 ms | 1 - 109 MB | NPU | -- |
+| Yolo-R | float | QCS9075 (Proxy) | Qualcomm® QCS9075 (Proxy) | QNN_DLC | 32.618 ms | 3 - 168 MB | NPU | -- |
+| Yolo-R | float | SA7255P ADP | Qualcomm® SA7255P | TFLITE | 129.679 ms | 0 - 109 MB | NPU | -- |
+| Yolo-R | float | SA7255P ADP | Qualcomm® SA7255P | QNN_DLC | 96.176 ms | 4 - 165 MB | NPU | -- |
+| Yolo-R | float | SA8255 (Proxy) | Qualcomm® SA8255P (Proxy) | TFLITE | 48.673 ms | 0 - 32 MB | NPU | -- |
+| Yolo-R | float | SA8255 (Proxy) | Qualcomm® SA8255P (Proxy) | QNN_DLC | 27.325 ms | 4 - 48 MB | NPU | -- |
+| Yolo-R | float | SA8295P ADP | Qualcomm® SA8295P | TFLITE | 85.322 ms | 1 - 89 MB | NPU | -- |
+| Yolo-R | float | SA8295P ADP | Qualcomm® SA8295P | QNN_DLC | 40.305 ms | 5 - 117 MB | NPU | -- |
+| Yolo-R | float | SA8650 (Proxy) | Qualcomm® SA8650P (Proxy) | TFLITE | 48.864 ms | 1 - 24 MB | NPU | -- |
+| Yolo-R | float | SA8650 (Proxy) | Qualcomm® SA8650P (Proxy) | QNN_DLC | 27.385 ms | 5 - 48 MB | NPU | -- |
+| Yolo-R | float | SA8775P ADP | Qualcomm® SA8775P | TFLITE | 54.495 ms | 1 - 109 MB | NPU | -- |
+| Yolo-R | float | SA8775P ADP | Qualcomm® SA8775P | QNN_DLC | 32.618 ms | 3 - 168 MB | NPU | -- |
+| Yolo-R | float | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | TFLITE | 35.582 ms | 0 - 162 MB | NPU | -- |
+| Yolo-R | float | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | QNN_DLC | 20.63 ms | 5 - 219 MB | NPU | -- |
+| Yolo-R | float | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | ONNX | 36.224 ms | 7 - 269 MB | NPU | -- |
+| Yolo-R | float | Samsung Galaxy S25 | Snapdragon® 8 Elite For Galaxy Mobile | TFLITE | 32.197 ms | 1 - 112 MB | NPU | -- |
+| Yolo-R | float | Samsung Galaxy S25 | Snapdragon® 8 Elite For Galaxy Mobile | QNN_DLC | 16.138 ms | 5 - 151 MB | NPU | -- |
+| Yolo-R | float | Samsung Galaxy S25 | Snapdragon® 8 Elite For Galaxy Mobile | ONNX | 24.839 ms | 2 - 133 MB | NPU | -- |
+| Yolo-R | float | Snapdragon 8 Elite Gen 5 QRD | Snapdragon® 8 Elite Gen5 Mobile | TFLITE | 27.294 ms | 1 - 112 MB | NPU | -- |
+| Yolo-R | float | Snapdragon 8 Elite Gen 5 QRD | Snapdragon® 8 Elite Gen5 Mobile | QNN_DLC | 12.526 ms | 5 - 194 MB | NPU | -- |
+| Yolo-R | float | Snapdragon 8 Elite Gen 5 QRD | Snapdragon® 8 Elite Gen5 Mobile | ONNX | 23.82 ms | 5 - 194 MB | NPU | -- |
+| Yolo-R | float | Snapdragon X Elite CRD | Snapdragon® X Elite | QNN_DLC | 26.911 ms | 100 - 100 MB | NPU | -- |
+| Yolo-R | float | Snapdragon X Elite CRD | Snapdragon® X Elite | ONNX | 45.6 ms | 75 - 75 MB | NPU | -- |
+
+
+
+
+## Installation
+
+
+Install the package via pip:
+```bash
+pip install qai-hub-models
+```
+
+
+## Configure Qualcomm® AI Hub Workbench to run this model on a cloud-hosted device
+
+Sign-in to [Qualcomm® AI Hub Workbench](https://workbench.aihub.qualcomm.com/) with your
+Qualcomm® ID. Once signed in navigate to `Account -> Settings -> API Token`.
+
+With this API token, you can configure your client to run models on the cloud
+hosted devices.
+```bash
+qai-hub configure --api_token API_TOKEN
+```
+Navigate to [docs](https://workbench.aihub.qualcomm.com/docs/) for more information.
+
+
+
+## Demo off target
+
+The package contains a simple end-to-end demo that downloads pre-trained
+weights and runs this model on a sample input.
+
+```bash
+python -m qai_hub_models.models.yolor.demo
+```
+
+The above demo runs a reference implementation of pre-processing, model
+inference, and post processing.
+
+**NOTE**: If you want running in a Jupyter Notebook or Google Colab like
+environment, please add the following to your cell (instead of the above).
+```
+%run -m qai_hub_models.models.yolor.demo
+```
+
+
+### Run model on a cloud-hosted device
+
+In addition to the demo, you can also run the model on a cloud-hosted Qualcomm®
+device. This script does the following:
+* Performance check on-device on a cloud-hosted device
+* Downloads compiled assets that can be deployed on-device for Android.
+* Accuracy check between PyTorch and on-device outputs.
+
+```bash
+python -m qai_hub_models.models.yolor.export
+```
+
+
+
+## How does this work?
+
+This [export script](https://aihub.qualcomm.com/models/yolor/qai_hub_models/models/Yolo-R/export.py)
+leverages [Qualcomm® AI Hub](https://aihub.qualcomm.com/) to optimize, validate, and deploy this model
+on-device. Lets go through each step below in detail:
+
+Step 1: **Compile model for on-device deployment**
+
+To compile a PyTorch model for on-device deployment, we first trace the model
+in memory using the `jit.trace` and then call the `submit_compile_job` API.
+
+```python
+import torch
+
+import qai_hub as hub
+from qai_hub_models.models.yolor import Model
+
+# Load the model
+torch_model = Model.from_pretrained()
+
+# Device
+device = hub.Device("Samsung Galaxy S25")
+
+# Trace model
+input_shape = torch_model.get_input_spec()
+sample_inputs = torch_model.sample_inputs()
+
+pt_model = torch.jit.trace(torch_model, [torch.tensor(data[0]) for _, data in sample_inputs.items()])
+
+# Compile model on a specific device
+compile_job = hub.submit_compile_job(
+    model=pt_model,
+    device=device,
+    input_specs=torch_model.get_input_spec(),
+)
+
+# Get target model to run on-device
+target_model = compile_job.get_target_model()
+
+```
+
+
+Step 2: **Performance profiling on cloud-hosted device**
+
+After compiling models from step 1. Models can be profiled model on-device using the
+`target_model`. Note that this scripts runs the model on a device automatically
+provisioned in the cloud.  Once the job is submitted, you can navigate to a
+provided job URL to view a variety of on-device performance metrics.
+```python
+profile_job = hub.submit_profile_job(
+    model=target_model,
+    device=device,
+)
+        
+```
+
+Step 3: **Verify on-device accuracy**
+
+To verify the accuracy of the model on-device, you can run on-device inference
+on sample input data on the same cloud hosted device.
+```python
+input_data = torch_model.sample_inputs()
+inference_job = hub.submit_inference_job(
+    model=target_model,
+    device=device,
+    inputs=input_data,
+)
+    on_device_output = inference_job.download_output_data()
+
+```
+With the output of the model, you can compute like PSNR, relative errors or
+spot check the output with expected output.
+
+**Note**: This on-device profiling and inference requires access to Qualcomm®
+AI Hub Workbench. [Sign up for access](https://myaccount.qualcomm.com/signup).
+
+
+
+## Run demo on a cloud-hosted device
+
+You can also run the demo on-device.
+
+```bash
+python -m qai_hub_models.models.yolor.demo --eval-mode on-device
+```
+
+**NOTE**: If you want running in a Jupyter Notebook or Google Colab like
+environment, please add the following to your cell (instead of the above).
+```
+%run -m qai_hub_models.models.yolor.demo -- --eval-mode on-device
+```
+
+
+## Deploying compiled model to Android
+
+
+The models can be deployed using multiple runtimes:
+- TensorFlow Lite (`.tflite` export): [This
+  tutorial](https://www.tensorflow.org/lite/android/quickstart) provides a
+  guide to deploy the .tflite model in an Android application.
+
+
+- QNN (`.so` export ): This [sample
+  app](https://docs.qualcomm.com/bundle/publicresource/topics/80-63442-50/sample_app.html)
+provides instructions on how to use the `.so` shared library  in an Android application.
+
+
+## View on Qualcomm® AI Hub
+Get more details on Yolo-R's performance across various devices [here](https://aihub.qualcomm.com/models/yolor).
+Explore all available models on [Qualcomm® AI Hub](https://aihub.qualcomm.com/)
+
+
+## License
+* The license for the original implementation of Yolo-R can be found
+  [here](https://github.com/WongKinYiu/yolor/blob/main/LICENSE).
+* The license for the compiled assets for on-device deployment can be found [here](https://github.com/WongKinYiu/yolor/blob/main/LICENSE)
+
+
+
+## References
+* [You Only Learn One Representation: Unified Network for Multiple Tasks](https://arxiv.org/abs/2105.04206)
+* [Source Model Implementation](https://github.com/WongKinYiu/yolor.git)
+
+
+
+## Community
+* Join [our AI Hub Slack community](https://aihub.qualcomm.com/community/slack) to collaborate, post questions and learn more about on-device AI.
+* For questions or feedback please [reach out to us](mailto:ai-hub-support@qti.qualcomm.com).
+
+