v0.41.0

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

.gitattributes

@@ -33,3 +33,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.zip filter=lfs diff=lfs merge=lfs -text
 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text
+DEPLOYMENT_MODEL_LICENSE.pdf filter=lfs diff=lfs merge=lfs -text

DEPLOYMENT_MODEL_LICENSE.pdf

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4409f93b0e82531303b3e10f52f1fdfb56467a25f05b7441c6bbd8bb8a64b42c
+size 109629

LICENSE

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

README.md

@@ -0,0 +1,232 @@
+---
+library_name: pytorch
+license: other
+tags:
+- android
+pipeline_tag: other
+
+---
+
+![](https://qaihub-public-assets.s3.us-west-2.amazonaws.com/qai-hub-models/models/centernet_3d/web-assets/model_demo.png)
+
+# CenterNet-3D: Optimized for Mobile Deployment
+## Construct a bird’s eye view from sensors mounted on a vehicle
+
+
+CenterNet is a machine learning model for generating a birds eye view represenation from the sensors(cameras) mounted on a vehicle.
+
+This model is an implementation of CenterNet-3D found [here](https://github.com/xingyizhou/CenterNet).
+
+
+This repository provides scripts to run CenterNet-3D on Qualcomm® devices.
+More details on model performance across various devices, can be found
+[here](https://aihub.qualcomm.com/models/centernet_3d).
+
+
+
+### Model Details
+
+- **Model Type:** Model_use_case.driver_assistance
+- **Model Stats:**
+  - Model checkpoint: ddd_3dop.pth
+  - Input resolution: 1 x 3 x 384 x 1280
+  - Number of parameters: 20.6M
+  - Model size: 79 MB
+
+| Model | Precision | Device | Chipset | Target Runtime | Inference Time (ms) | Peak Memory Range (MB) | Primary Compute Unit | Target Model
+|---|---|---|---|---|---|---|---|---|
+| CenterNet-3D | float | QCS8550 (Proxy) | Qualcomm® QCS8550 (Proxy) | PRECOMPILED_QNN_ONNX | 898.005 ms | 1 - 77 MB | NPU | Use Export Script |
+| CenterNet-3D | float | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | PRECOMPILED_QNN_ONNX | 682.716 ms | 8 - 24 MB | NPU | Use Export Script |
+| CenterNet-3D | float | Samsung Galaxy S25 | Snapdragon® 8 Elite For Galaxy Mobile | PRECOMPILED_QNN_ONNX | 524.208 ms | 3 - 19 MB | NPU | Use Export Script |
+| CenterNet-3D | float | Snapdragon 8 Elite Gen 5 QRD | Snapdragon® 8 Elite Gen5 Mobile | PRECOMPILED_QNN_ONNX | 506.514 ms | 6 - 17 MB | NPU | Use Export Script |
+| CenterNet-3D | float | Snapdragon X Elite CRD | Snapdragon® X Elite | PRECOMPILED_QNN_ONNX | 863.597 ms | 61 - 61 MB | NPU | Use Export Script |
+
+
+
+
+## Installation
+
+
+Install the package via pip:
+```bash
+pip install qai-hub-models
+```
+
+
+## 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.centernet_3d.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.centernet_3d.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.centernet_3d.export
+```
+
+
+
+## How does this work?
+
+This [export script](https://aihub.qualcomm.com/models/centernet_3d/qai_hub_models/models/CenterNet-3D/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.centernet_3d 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. [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.centernet_3d.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.centernet_3d.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 CenterNet-3D's performance across various devices [here](https://aihub.qualcomm.com/models/centernet_3d).
+Explore all available models on [Qualcomm® AI Hub](https://aihub.qualcomm.com/)
+
+
+## License
+* The license for the original implementation of CenterNet-3D can be found
+  [here](https://github.com/xingyizhou/CenterNet/blob/master/LICENSE).
+* The license for the compiled assets for on-device deployment can be found [here](https://qaihub-public-assets.s3.us-west-2.amazonaws.com/qai-hub-models/Qualcomm+AI+Hub+Proprietary+License.pdf)
+
+
+
+## References
+* [Objects as Points](https://arxiv.org/abs/1904.07850)
+* [Source Model Implementation](https://github.com/xingyizhou/CenterNet)
+
+
+
+## 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:[email protected]).
+
+

precompiled/qualcomm-qcs8550-proxy/CenterNet-3D_float.onnx.zip

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:d985f21001dbb837293cdbe49fda7dab4256f17f98875f9a1dff73e46afbc5a2
+size 45943369

precompiled/qualcomm-qcs8550-proxy/tool-versions.yaml

@@ -0,0 +1,4 @@
+tool_versions:
+  precompiled_qnn_onnx:
+    qairt: 2.37.1.250807093845_124904
+    onnx_runtime: 1.23.0

precompiled/qualcomm-snapdragon-8-elite-for-galaxy/CenterNet-3D_float.onnx.zip

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4306c5958cd46d77dbf610a73df57c71ab4dbd89e1c126d26a2a7a82cb546b6e
+size 47699309

precompiled/qualcomm-snapdragon-8-elite-for-galaxy/tool-versions.yaml

@@ -0,0 +1,4 @@
+tool_versions:
+  precompiled_qnn_onnx:
+    qairt: 2.37.1.250807093845_124904
+    onnx_runtime: 1.23.0

precompiled/qualcomm-snapdragon-8-elite-gen5/CenterNet-3D_float.onnx.zip

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:87fa1174802aa275173a2905b63027d0afee69dda34f190b849cbad67f1bf24a
+size 47152917

precompiled/qualcomm-snapdragon-8-elite-gen5/tool-versions.yaml

@@ -0,0 +1,4 @@
+tool_versions:
+  precompiled_qnn_onnx:
+    qairt: 2.37.1.250807093845_124904
+    onnx_runtime: 1.23.0

precompiled/qualcomm-snapdragon-8gen3/CenterNet-3D_float.onnx.zip

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ff33bd9a87396fb5c66900d109f054502d1ddb9b056289c1032dde7406272fc5
+size 45953253

precompiled/qualcomm-snapdragon-8gen3/tool-versions.yaml

@@ -0,0 +1,4 @@
+tool_versions:
+  precompiled_qnn_onnx:
+    qairt: 2.37.1.250807093845_124904
+    onnx_runtime: 1.23.0

precompiled/qualcomm-snapdragon-x-elite/CenterNet-3D_float.onnx.zip

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:1cb9f01a30e55905bb116983772cb306ebe2353e2a45199b10c3dfff4ca2c4aa
+size 45927934

precompiled/qualcomm-snapdragon-x-elite/tool-versions.yaml

@@ -0,0 +1,4 @@
+tool_versions:
+  precompiled_qnn_onnx:
+    qairt: 2.37.1.250807093845_124904
+    onnx_runtime: 1.23.0