v0.46.1

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

README.md

@@ -10,207 +10,61 @@ pipeline_tag: other
 
 ![](https://qaihub-public-assets.s3.us-west-2.amazonaws.com/qai-hub-models/models/statetransformer/web-assets/model_demo.png)
 
-# StateTransformer: Optimized for Mobile Deployment
-## Multi-agent trajectory prediction model for autonomous driving
+# StateTransformer: Optimized for Qualcomm Devices
 
 StateTransformer is a transformer-based model designed for trajectory prediction in self-driving scenarios. It integrates rasterized map data, agent context, and temporal dynamics to generate accurate future trajectories.
 
-This repository provides scripts to run StateTransformer on Qualcomm® devices.
-More details on model performance across various devices, can be found
-[here](https://aihub.qualcomm.com/models/statetransformer).
+This repository contains pre-exported model files optimized for Qualcomm® devices. You can use the [Qualcomm® AI Hub Models](https://github.com/quic/ai-hub-models/blob/main/qai_hub_models/models/statetransformer) library to export with custom configurations. More details on model performance across various devices, can be found [here](#performance-summary).
 
+Qualcomm AI Hub Models uses [Qualcomm AI Hub Workbench](https://workbench.aihub.qualcomm.com) to compile, profile, and evaluate this model. [Sign up](https://myaccount.qualcomm.com/signup) to run these models on a hosted Qualcomm® device.
 
+## Getting Started
+There are two ways to deploy this model on your device:
 
-### Model Details
+### Option 1: Download Pre-Exported Models
 
-- **Model Type:** Model_use_case.driver_assistance
-- **Model Stats:**
-  - Model checkpoint: pretrained-mixtral-small
-  - Input resolution: 1x224x224x58, 1x224x224x58, 1x4x7
-  - Number of parameters: 90.7M
-  - Model size (float): 348 MB
+Below are pre-exported model assets ready for deployment.
 
-| Model | Precision | Device | Chipset | Target Runtime | Inference Time (ms) | Peak Memory Range (MB) | Primary Compute Unit | Target Model
-|---|---|---|---|---|---|---|---|---|
-| StateTransformer | float | QCS8275 (Proxy) | Qualcomm® QCS8275 (Proxy) | TFLITE | 945.244 ms | 222 - 238 MB | CPU | [StateTransformer.tflite](https://huggingface.co/qualcomm/StateTransformer/blob/main/StateTransformer.tflite) |
-| StateTransformer | float | QCS8450 (Proxy) | Qualcomm® QCS8450 (Proxy) | TFLITE | 783.052 ms | 227 - 255 MB | CPU | [StateTransformer.tflite](https://huggingface.co/qualcomm/StateTransformer/blob/main/StateTransformer.tflite) |
-| StateTransformer | float | QCS8550 (Proxy) | Qualcomm® QCS8550 (Proxy) | TFLITE | 564.388 ms | 217 - 226 MB | CPU | [StateTransformer.tflite](https://huggingface.co/qualcomm/StateTransformer/blob/main/StateTransformer.tflite) |
-| StateTransformer | float | QCS9075 (Proxy) | Qualcomm® QCS9075 (Proxy) | TFLITE | 791.845 ms | 224 - 240 MB | CPU | [StateTransformer.tflite](https://huggingface.co/qualcomm/StateTransformer/blob/main/StateTransformer.tflite) |
-| StateTransformer | float | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | TFLITE | 488.485 ms | 224 - 257 MB | CPU | [StateTransformer.tflite](https://huggingface.co/qualcomm/StateTransformer/blob/main/StateTransformer.tflite) |
-| StateTransformer | float | Samsung Galaxy S25 | Snapdragon® 8 Elite For Galaxy Mobile | TFLITE | 416.152 ms | 226 - 249 MB | CPU | [StateTransformer.tflite](https://huggingface.co/qualcomm/StateTransformer/blob/main/StateTransformer.tflite) |
-| StateTransformer | float | Snapdragon 8 Elite Gen 5 QRD | Snapdragon® 8 Elite Gen 5 Mobile | TFLITE | 353.973 ms | 176 - 197 MB | CPU | [StateTransformer.tflite](https://huggingface.co/qualcomm/StateTransformer/blob/main/StateTransformer.tflite) |
+| Runtime | Precision | Chipset | SDK Versions | Download |
+|---|---|---|---|---|
+| QNN_DLC | float | Universal | QAIRT 2.42 | [Download](https://qaihub-public-assets.s3.us-west-2.amazonaws.com/qai-hub-models/models/statetransformer/releases/v0.46.1/statetransformer-qnn_dlc-float.zip)
+| TFLITE | float | Universal | TFLite 2.17.0 | [Download](https://qaihub-public-assets.s3.us-west-2.amazonaws.com/qai-hub-models/models/statetransformer/releases/v0.46.1/statetransformer-tflite-float.zip)
 
+For more device-specific assets and performance metrics, visit **[StateTransformer on Qualcomm® AI Hub](https://aihub.qualcomm.com/models/statetransformer)**.
 
 
+### Option 2: Export with Custom Configurations
 
-## Installation
+Use the [Qualcomm® AI Hub Models](https://github.com/quic/ai-hub-models/blob/main/qai_hub_models/models/statetransformer) Python library to compile and export the model with your own:
+- Custom weights (e.g., fine-tuned checkpoints)
+- Custom input shapes
+- Target device and runtime configurations
 
+This option is ideal if you need to customize the model beyond the default configuration provided here.
 
-Install the package via pip:
-```bash
-# NOTE: 3.10 <= PYTHON_VERSION < 3.14 is supported.
-pip install "qai-hub-models[statetransformer]" git+https://github.com/motional/nuplan-devkit.git@d60b4cd2071de9bb041509c43f5226dd22f248c0#egg=nuplan_devkit
-```
+See our repository for [StateTransformer on GitHub](https://github.com/quic/ai-hub-models/blob/main/qai_hub_models/models/statetransformer) for usage instructions.
 
+## Model Details
 
-## Configure Qualcomm® AI Hub Workbench to run this model on a cloud-hosted device
+**Model Type:** Model_use_case.driver_assistance
 
-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.statetransformer.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.statetransformer.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.statetransformer.export
-```
-
-
-
-## How does this work?
-
-This [export script](https://aihub.qualcomm.com/models/statetransformer/qai_hub_models/models/StateTransformer/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.statetransformer 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.statetransformer.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.statetransformer.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 StateTransformer's performance across various devices [here](https://aihub.qualcomm.com/models/statetransformer).
-Explore all available models on [Qualcomm® AI Hub](https://aihub.qualcomm.com/)
+**Model Stats:**
+- Model checkpoint: pretrained-mixtral-small
+- Input resolution: 1x224x224x58, 1x224x224x58, 1x4x7
+- Number of parameters: 90.7M
+- Model size (float): 348 MB
 
+## Performance Summary
+| Model | Runtime | Precision | Chipset | Inference Time (ms) | Peak Memory Range (MB) | Primary Compute Unit
+|---|---|---|---|---|---|---
+| StateTransformer | QNN_DLC | float | Snapdragon® X Elite | 4076.132 ms | 22 - 22 MB | NPU
+| StateTransformer | QNN_DLC | float | Snapdragon® 8 Elite For Galaxy Mobile | 3326.654 ms | 11 - 3356 MB | NPU
+| StateTransformer | TFLITE | float | Snapdragon® 8 Gen 3 Mobile | 504.429 ms | 214 - 229 MB | CPU
+| StateTransformer | TFLITE | float | Qualcomm® QCS8275 (Proxy) | 997.127 ms | 224 - 239 MB | CPU
+| StateTransformer | TFLITE | float | Qualcomm® QCS8550 (Proxy) | 576.673 ms | 216 - 514 MB | CPU
+| StateTransformer | TFLITE | float | Qualcomm® QCS8450 (Proxy) | 752.049 ms | 217 - 233 MB | CPU
+| StateTransformer | TFLITE | float | Snapdragon® 8 Elite For Galaxy Mobile | 392.99 ms | 161 - 171 MB | CPU
+| StateTransformer | TFLITE | float | Snapdragon® 8 Elite Gen 5 Mobile | 360.867 ms | 226 - 249 MB | CPU
 
 ## License
 * The license for the original implementation of StateTransformer can be found
@@ -218,9 +72,6 @@ Explore all available models on [Qualcomm® AI Hub](https://aihub.qualcomm.com/)
 
 
 
-
 ## 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).
-
-

StateTransformer_float.tflite

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

tool-versions.yaml

@@ -1,3 +0,0 @@
-tool_versions:
-  tflite:
-    tflite: 2.17.0