v0.34.0

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

README.md

@@ -19,7 +19,11 @@ YoloV3 is a machine learning model that predicts bounding boxes and classes of o
 This model is an implementation of Yolo-v3 found [here](https://github.com/ultralytics/yolov3/tree/v8).
 
 
- More details on model performance across various devices, can be found [here](https://aihub.qualcomm.com/models/yolov3).
+This repository provides scripts to run Yolo-v3 on Qualcomm® devices.
+More details on model performance across various devices, can be found
+[here](https://aihub.qualcomm.com/models/yolov3).
+
+**WARNING**: The model assets are not readily available for download due to licensing restrictions.
 
 ### Model Details
 
@@ -33,40 +37,208 @@ This model is an implementation of Yolo-v3 found [here](https://github.com/ultra
 
 | Model | Precision | Device | Chipset | Target Runtime | Inference Time (ms) | Peak Memory Range (MB) | Primary Compute Unit | Target Model
 |---|---|---|---|---|---|---|---|---|
-| Yolo-v3 | float | QCS8275 (Proxy) | Qualcomm® QCS8275 (Proxy) | TFLITE | 31.683 ms | 0 - 76 MB | NPU | -- |
-| Yolo-v3 | float | QCS8275 (Proxy) | Qualcomm® QCS8275 (Proxy) | QNN_DLC | 21.753 ms | 4 - 94 MB | NPU | -- |
-| Yolo-v3 | float | QCS8450 (Proxy) | Qualcomm® QCS8450 (Proxy) | TFLITE | 17.902 ms | 0 - 88 MB | NPU | -- |
-| Yolo-v3 | float | QCS8450 (Proxy) | Qualcomm® QCS8450 (Proxy) | QNN_DLC | 12.001 ms | 4 - 75 MB | NPU | -- |
-| Yolo-v3 | float | QCS8550 (Proxy) | Qualcomm® QCS8550 (Proxy) | TFLITE | 16.371 ms | 0 - 14 MB | NPU | -- |
-| Yolo-v3 | float | QCS8550 (Proxy) | Qualcomm® QCS8550 (Proxy) | QNN_DLC | 8.133 ms | 5 - 21 MB | NPU | -- |
-| Yolo-v3 | float | QCS9075 (Proxy) | Qualcomm® QCS9075 (Proxy) | TFLITE | 17.753 ms | 0 - 76 MB | NPU | -- |
-| Yolo-v3 | float | QCS9075 (Proxy) | Qualcomm® QCS9075 (Proxy) | QNN_DLC | 9.735 ms | 2 - 87 MB | NPU | -- |
-| Yolo-v3 | float | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 Mobile | TFLITE | 16.53 ms | 0 - 12 MB | NPU | -- |
-| Yolo-v3 | float | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 Mobile | QNN_DLC | 8.129 ms | 5 - 22 MB | NPU | -- |
-| Yolo-v3 | float | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 Mobile | ONNX | 9.178 ms | 0 - 79 MB | NPU | -- |
-| Yolo-v3 | float | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | TFLITE | 10.757 ms | 0 - 99 MB | NPU | -- |
-| Yolo-v3 | float | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | QNN_DLC | 5.872 ms | 5 - 100 MB | NPU | -- |
-| Yolo-v3 | float | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | ONNX | 6.757 ms | 5 - 114 MB | NPU | -- |
-| Yolo-v3 | float | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite Mobile | TFLITE | 8.081 ms | 0 - 79 MB | NPU | -- |
-| Yolo-v3 | float | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite Mobile | QNN_DLC | 6.046 ms | 5 - 102 MB | NPU | -- |
-| Yolo-v3 | float | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite Mobile | ONNX | 6.684 ms | 5 - 93 MB | NPU | -- |
-| Yolo-v3 | float | Snapdragon X Elite CRD | Snapdragon® X Elite | QNN_DLC | 9.061 ms | 0 - 0 MB | NPU | -- |
-| Yolo-v3 | float | Snapdragon X Elite CRD | Snapdragon® X Elite | ONNX | 9.226 ms | 21 - 21 MB | NPU | -- |
-| Yolo-v3 | w8a16 | QCS8275 (Proxy) | Qualcomm® QCS8275 (Proxy) | QNN_DLC | 13.726 ms | 2 - 68 MB | NPU | -- |
-| Yolo-v3 | w8a16 | QCS8450 (Proxy) | Qualcomm® QCS8450 (Proxy) | QNN_DLC | 8.413 ms | 2 - 92 MB | NPU | -- |
-| Yolo-v3 | w8a16 | QCS8550 (Proxy) | Qualcomm® QCS8550 (Proxy) | QNN_DLC | 6.258 ms | 2 - 28 MB | NPU | -- |
-| Yolo-v3 | w8a16 | QCS9075 (Proxy) | Qualcomm® QCS9075 (Proxy) | QNN_DLC | 6.696 ms | 2 - 69 MB | NPU | -- |
-| Yolo-v3 | w8a16 | RB3 Gen 2 (Proxy) | Qualcomm® QCS6490 (Proxy) | QNN_DLC | 19.487 ms | 2 - 79 MB | NPU | -- |
-| Yolo-v3 | w8a16 | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 Mobile | QNN_DLC | 6.278 ms | 2 - 19 MB | NPU | -- |
-| Yolo-v3 | w8a16 | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 Mobile | ONNX | 8.787 ms | 0 - 41 MB | NPU | -- |
-| Yolo-v3 | w8a16 | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | QNN_DLC | 4.545 ms | 2 - 93 MB | NPU | -- |
-| Yolo-v3 | w8a16 | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | ONNX | 5.98 ms | 2 - 103 MB | NPU | -- |
-| Yolo-v3 | w8a16 | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite Mobile | QNN_DLC | 4.834 ms | 2 - 76 MB | NPU | -- |
-| Yolo-v3 | w8a16 | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite Mobile | ONNX | 6.218 ms | 2 - 100 MB | NPU | -- |
-| Yolo-v3 | w8a16 | Snapdragon X Elite CRD | Snapdragon® X Elite | QNN_DLC | 7.428 ms | 83 - 83 MB | NPU | -- |
-| Yolo-v3 | w8a16 | Snapdragon X Elite CRD | Snapdragon® X Elite | ONNX | 9.078 ms | 15 - 15 MB | NPU | -- |
+| Yolo-v3 | float | QCS8275 (Proxy) | Qualcomm® QCS8275 (Proxy) | TFLITE | 31.64 ms | 0 - 77 MB | NPU | -- |
+| Yolo-v3 | float | QCS8275 (Proxy) | Qualcomm® QCS8275 (Proxy) | QNN_DLC | 21.753 ms | 1 - 90 MB | NPU | -- |
+| Yolo-v3 | float | QCS8450 (Proxy) | Qualcomm® QCS8450 (Proxy) | TFLITE | 18.564 ms | 0 - 88 MB | NPU | -- |
+| Yolo-v3 | float | QCS8450 (Proxy) | Qualcomm® QCS8450 (Proxy) | QNN_DLC | 11.953 ms | 5 - 79 MB | NPU | -- |
+| Yolo-v3 | float | QCS8550 (Proxy) | Qualcomm® QCS8550 (Proxy) | TFLITE | 16.595 ms | 0 - 9 MB | NPU | -- |
+| Yolo-v3 | float | QCS8550 (Proxy) | Qualcomm® QCS8550 (Proxy) | QNN_DLC | 8.149 ms | 5 - 23 MB | NPU | -- |
+| Yolo-v3 | float | QCS9075 (Proxy) | Qualcomm® QCS9075 (Proxy) | TFLITE | 17.628 ms | 0 - 76 MB | NPU | -- |
+| Yolo-v3 | float | QCS9075 (Proxy) | Qualcomm® QCS9075 (Proxy) | QNN_DLC | 9.719 ms | 1 - 88 MB | NPU | -- |
+| Yolo-v3 | float | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 Mobile | TFLITE | 16.536 ms | 0 - 14 MB | NPU | -- |
+| Yolo-v3 | float | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 Mobile | QNN_DLC | 8.138 ms | 5 - 22 MB | NPU | -- |
+| Yolo-v3 | float | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 Mobile | ONNX | 9.136 ms | 0 - 66 MB | NPU | -- |
+| Yolo-v3 | float | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | TFLITE | 10.72 ms | 0 - 99 MB | NPU | -- |
+| Yolo-v3 | float | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | QNN_DLC | 5.873 ms | 5 - 96 MB | NPU | -- |
+| Yolo-v3 | float | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | ONNX | 6.764 ms | 5 - 113 MB | NPU | -- |
+| Yolo-v3 | float | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite Mobile | TFLITE | 8.098 ms | 0 - 80 MB | NPU | -- |
+| Yolo-v3 | float | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite Mobile | QNN_DLC | 6.025 ms | 5 - 103 MB | NPU | -- |
+| Yolo-v3 | float | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite Mobile | ONNX | 6.989 ms | 5 - 94 MB | NPU | -- |
+| Yolo-v3 | float | Snapdragon X Elite CRD | Snapdragon® X Elite | QNN_DLC | 8.972 ms | 1 - 1 MB | NPU | -- |
+| Yolo-v3 | float | Snapdragon X Elite CRD | Snapdragon® X Elite | ONNX | 9.189 ms | 22 - 22 MB | NPU | -- |
+| Yolo-v3 | w8a16 | QCS8275 (Proxy) | Qualcomm® QCS8275 (Proxy) | QNN_DLC | 13.032 ms | 2 - 68 MB | NPU | -- |
+| Yolo-v3 | w8a16 | QCS8450 (Proxy) | Qualcomm® QCS8450 (Proxy) | QNN_DLC | 8.556 ms | 2 - 88 MB | NPU | -- |
+| Yolo-v3 | w8a16 | QCS8550 (Proxy) | Qualcomm® QCS8550 (Proxy) | QNN_DLC | 5.869 ms | 2 - 25 MB | NPU | -- |
+| Yolo-v3 | w8a16 | QCS9075 (Proxy) | Qualcomm® QCS9075 (Proxy) | QNN_DLC | 6.324 ms | 2 - 71 MB | NPU | -- |
+| Yolo-v3 | w8a16 | RB3 Gen 2 (Proxy) | Qualcomm® QCS6490 (Proxy) | QNN_DLC | 19.682 ms | 2 - 78 MB | NPU | -- |
+| Yolo-v3 | w8a16 | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 Mobile | QNN_DLC | 5.884 ms | 2 - 23 MB | NPU | -- |
+| Yolo-v3 | w8a16 | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 Mobile | ONNX | 9.031 ms | 0 - 58 MB | NPU | -- |
+| Yolo-v3 | w8a16 | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | QNN_DLC | 4.308 ms | 2 - 88 MB | NPU | -- |
+| Yolo-v3 | w8a16 | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | ONNX | 5.998 ms | 2 - 106 MB | NPU | -- |
+| Yolo-v3 | w8a16 | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite Mobile | QNN_DLC | 4.432 ms | 2 - 73 MB | NPU | -- |
+| Yolo-v3 | w8a16 | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite Mobile | ONNX | 6.155 ms | 2 - 99 MB | NPU | -- |
+| Yolo-v3 | w8a16 | Snapdragon X Elite CRD | Snapdragon® X Elite | QNN_DLC | 7.187 ms | 54 - 54 MB | NPU | -- |
+| Yolo-v3 | w8a16 | Snapdragon X Elite CRD | Snapdragon® X Elite | ONNX | 9.102 ms | 15 - 15 MB | NPU | -- |
+
+
+
+
+## Installation
+
+
+Install the package via pip:
+```bash
+pip install "qai-hub-models[yolov3]"
+```
+
+
+## Configure Qualcomm® AI Hub to run this model on a cloud-hosted device
+
+Sign-in to [Qualcomm® AI Hub](https://app.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://app.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.yolov3.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.yolov3.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.yolov3.export
+```
+
+
+
+## How does this work?
+
+This [export script](https://aihub.qualcomm.com/models/yolov3/qai_hub_models/models/Yolo-v3/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.yolov3 import Model
 
+# Load the model
+torch_model = Model.from_pretrained()
+
+# Device
+device = hub.Device("Samsung Galaxy S24")
+
+# 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. [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.yolov3.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.yolov3.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-v3's performance across various devices [here](https://aihub.qualcomm.com/models/yolov3).
+Explore all available models on [Qualcomm® AI Hub](https://aihub.qualcomm.com/)
 
 
 ## License
@@ -83,26 +255,7 @@ This model is an implementation of Yolo-v3 found [here](https://github.com/ultra
 
 
 ## Community
-* Join [our AI Hub Slack community](https://qualcomm-ai-hub.slack.com/join/shared_invite/zt-2d5zsmas3-Sj0Q9TzslueCjS31eXG2UA#/shared-invite/email) to collaborate, post questions and learn more about on-device AI.
+* 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:[email protected]).
 
-## Usage and Limitations
-
-Model may not be used for or in connection with any of the following applications:
-
-- Accessing essential private and public services and benefits;
-- Administration of justice and democratic processes;
-- Assessing or recognizing the emotional state of a person;
-- Biometric and biometrics-based systems, including categorization of persons based on sensitive characteristics;
-- Education and vocational training;
-- Employment and workers management;
-- Exploitation of the vulnerabilities of persons resulting in harmful behavior;
-- General purpose social scoring;
-- Law enforcement;
-- Management and operation of critical infrastructure;
-- Migration, asylum and border control management;
-- Predictive policing;
-- Real-time remote biometric identification in public spaces;
-- Recommender systems of social media platforms;
-- Scraping of facial images (from the internet or otherwise); and/or
-- Subliminal manipulation
+