v0.37.0

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

.gitattributes

@@ -33,3 +33,5 @@ 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
+Sequencer2D_float.dlc 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/facebookresearch/LeViT?tab=Apache-2.0-1-ov-file.
+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,262 @@
+---
+library_name: pytorch
+license: other
+tags:
+- android
+pipeline_tag: image-classification
+
+---
+
+![](https://qaihub-public-assets.s3.us-west-2.amazonaws.com/qai-hub-models/models/sequencer2d/web-assets/model_demo.png)
+
+# Sequencer2D: Optimized for Mobile Deployment
+## Imagenet classifier and general purpose backbone
+
+
+sequencer2d is a vision transformer model that can classify images from the Imagenet dataset.
+
+This model is an implementation of Sequencer2D found [here](https://github.com/okojoalg/sequencer).
+
+
+This repository provides scripts to run Sequencer2D on Qualcomm® devices.
+More details on model performance across various devices, can be found
+[here](https://aihub.qualcomm.com/models/sequencer2d).
+
+
+
+### Model Details
+
+- **Model Type:** Model_use_case.image_classification
+- **Model Stats:**
+  - Model checkpoint: sequencer2d_s
+  - Input resolution: 224x224
+  - Number of parameters: 27.6M
+  - Model size (float): 106 MB
+  - Model size (w8a16): 69.1 MB
+
+| Model | Precision | Device | Chipset | Target Runtime | Inference Time (ms) | Peak Memory Range (MB) | Primary Compute Unit | Target Model
+|---|---|---|---|---|---|---|---|---|
+| Sequencer2D | float | QCS8275 (Proxy) | Qualcomm® QCS8275 (Proxy) | TFLITE | 116.219 ms | 0 - 538 MB | NPU | [Sequencer2D.tflite](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D.tflite) |
+| Sequencer2D | float | QCS8275 (Proxy) | Qualcomm® QCS8275 (Proxy) | QNN_DLC | 89.881 ms | 1 - 594 MB | NPU | [Sequencer2D.dlc](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D.dlc) |
+| Sequencer2D | float | QCS8450 (Proxy) | Qualcomm® QCS8450 (Proxy) | TFLITE | 57.652 ms | 0 - 416 MB | NPU | [Sequencer2D.tflite](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D.tflite) |
+| Sequencer2D | float | QCS8450 (Proxy) | Qualcomm® QCS8450 (Proxy) | QNN_DLC | 68.099 ms | 0 - 433 MB | NPU | [Sequencer2D.dlc](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D.dlc) |
+| Sequencer2D | float | QCS8550 (Proxy) | Qualcomm® QCS8550 (Proxy) | TFLITE | 59.971 ms | 0 - 80 MB | NPU | [Sequencer2D.tflite](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D.tflite) |
+| Sequencer2D | float | QCS8550 (Proxy) | Qualcomm® QCS8550 (Proxy) | QNN_DLC | 42.334 ms | 0 - 89 MB | NPU | [Sequencer2D.dlc](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D.dlc) |
+| Sequencer2D | float | QCS8550 (Proxy) | Qualcomm® QCS8550 (Proxy) | ONNX | 61.945 ms | 0 - 50 MB | NPU | [Sequencer2D.onnx.zip](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D.onnx.zip) |
+| Sequencer2D | float | QCS9075 (Proxy) | Qualcomm® QCS9075 (Proxy) | TFLITE | 61.928 ms | 0 - 539 MB | NPU | [Sequencer2D.tflite](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D.tflite) |
+| Sequencer2D | float | QCS9075 (Proxy) | Qualcomm® QCS9075 (Proxy) | QNN_DLC | 44.001 ms | 0 - 587 MB | NPU | [Sequencer2D.dlc](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D.dlc) |
+| Sequencer2D | float | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 Mobile | TFLITE | 60.11 ms | 0 - 76 MB | NPU | [Sequencer2D.tflite](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D.tflite) |
+| Sequencer2D | float | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 Mobile | QNN_DLC | 41.816 ms | 0 - 87 MB | NPU | [Sequencer2D.dlc](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D.dlc) |
+| Sequencer2D | float | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 Mobile | ONNX | 63.251 ms | 0 - 38 MB | NPU | [Sequencer2D.onnx.zip](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D.onnx.zip) |
+| Sequencer2D | float | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | TFLITE | 44.179 ms | 0 - 544 MB | NPU | [Sequencer2D.tflite](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D.tflite) |
+| Sequencer2D | float | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | QNN_DLC | 30.463 ms | 1 - 1026 MB | NPU | [Sequencer2D.dlc](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D.dlc) |
+| Sequencer2D | float | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | ONNX | 53.55 ms | 7 - 32 MB | NPU | [Sequencer2D.onnx.zip](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D.onnx.zip) |
+| Sequencer2D | float | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite Mobile | TFLITE | 45.568 ms | 0 - 547 MB | NPU | [Sequencer2D.tflite](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D.tflite) |
+| Sequencer2D | float | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite Mobile | QNN_DLC | 22.335 ms | 1 - 582 MB | NPU | [Sequencer2D.dlc](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D.dlc) |
+| Sequencer2D | float | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite Mobile | ONNX | 54.391 ms | 8 - 32 MB | NPU | [Sequencer2D.onnx.zip](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D.onnx.zip) |
+| Sequencer2D | float | Snapdragon X Elite CRD | Snapdragon® X Elite | QNN_DLC | 44.533 ms | 469 - 469 MB | NPU | [Sequencer2D.dlc](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D.dlc) |
+| Sequencer2D | float | Snapdragon X Elite CRD | Snapdragon® X Elite | ONNX | 25.592 ms | 3 - 3 MB | NPU | [Sequencer2D.onnx.zip](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D.onnx.zip) |
+| Sequencer2D | w8a8 | QCS8275 (Proxy) | Qualcomm® QCS8275 (Proxy) | TFLITE | 82.161 ms | 0 - 491 MB | NPU | [Sequencer2D.tflite](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D_w8a8.tflite) |
+| Sequencer2D | w8a8 | QCS8450 (Proxy) | Qualcomm® QCS8450 (Proxy) | TFLITE | 40.075 ms | 0 - 387 MB | NPU | [Sequencer2D.tflite](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D_w8a8.tflite) |
+| Sequencer2D | w8a8 | QCS8550 (Proxy) | Qualcomm® QCS8550 (Proxy) | TFLITE | 43.482 ms | 0 - 65 MB | NPU | [Sequencer2D.tflite](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D_w8a8.tflite) |
+| Sequencer2D | w8a8 | QCS8550 (Proxy) | Qualcomm® QCS8550 (Proxy) | ONNX | 62.202 ms | 127 - 255 MB | NPU | [Sequencer2D.onnx.zip](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D_w8a8.onnx.zip) |
+| Sequencer2D | w8a8 | QCS9075 (Proxy) | Qualcomm® QCS9075 (Proxy) | TFLITE | 45.82 ms | 0 - 489 MB | NPU | [Sequencer2D.tflite](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D_w8a8.tflite) |
+| Sequencer2D | w8a8 | RB3 Gen 2 (Proxy) | Qualcomm® QCS6490 (Proxy) | ONNX | 261.522 ms | 19 - 40 MB | CPU | [Sequencer2D.onnx.zip](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D_w8a8.onnx.zip) |
+| Sequencer2D | w8a8 | RB5 (Proxy) | Qualcomm® QCS8250 (Proxy) | ONNX | 271.335 ms | 16 - 48 MB | CPU | [Sequencer2D.onnx.zip](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D_w8a8.onnx.zip) |
+| Sequencer2D | w8a8 | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 Mobile | TFLITE | 43.548 ms | 0 - 63 MB | NPU | [Sequencer2D.tflite](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D_w8a8.tflite) |
+| Sequencer2D | w8a8 | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 Mobile | ONNX | 57.675 ms | 123 - 254 MB | NPU | [Sequencer2D.onnx.zip](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D_w8a8.onnx.zip) |
+| Sequencer2D | w8a8 | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | TFLITE | 32.596 ms | 0 - 497 MB | NPU | [Sequencer2D.tflite](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D_w8a8.tflite) |
+| Sequencer2D | w8a8 | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | ONNX | 55.021 ms | 161 - 2609 MB | NPU | [Sequencer2D.onnx.zip](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D_w8a8.onnx.zip) |
+| Sequencer2D | w8a8 | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite Mobile | TFLITE | 31.918 ms | 0 - 487 MB | NPU | [Sequencer2D.tflite](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D_w8a8.tflite) |
+| Sequencer2D | w8a8 | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite Mobile | ONNX | 36.684 ms | 163 - 1165 MB | NPU | [Sequencer2D.onnx.zip](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D_w8a8.onnx.zip) |
+| Sequencer2D | w8a8 | Snapdragon X Elite CRD | Snapdragon® X Elite | ONNX | 52.765 ms | 232 - 232 MB | NPU | [Sequencer2D.onnx.zip](https://huggingface.co/qualcomm/Sequencer2D/blob/main/Sequencer2D_w8a8.onnx.zip) |
+
+
+
+
+## Installation
+
+
+Install the package via pip:
+```bash
+pip install "qai-hub-models[sequencer2d]"
+```
+
+
+## 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.sequencer2d.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.sequencer2d.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.sequencer2d.export
+```
+
+
+
+## How does this work?
+
+This [export script](https://aihub.qualcomm.com/models/sequencer2d/qai_hub_models/models/Sequencer2D/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.sequencer2d 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.sequencer2d.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.sequencer2d.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 Sequencer2D's performance across various devices [here](https://aihub.qualcomm.com/models/sequencer2d).
+Explore all available models on [Qualcomm® AI Hub](https://aihub.qualcomm.com/)
+
+
+## License
+* The license for the original implementation of Sequencer2D can be found
+  [here](https://github.com/facebookresearch/LeViT?tab=Apache-2.0-1-ov-file).
+* 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
+* [Sequencer: Deep LSTM for Image Classification](https://arxiv.org/abs/2205.01972)
+* [Source Model Implementation](https://github.com/okojoalg/sequencer)
+
+
+
+## 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).
+
+

Sequencer2D_float.dlc

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

Sequencer2D_float.onnx.zip

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

Sequencer2D_float.tflite

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

Sequencer2D_w8a8.onnx.zip

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

Sequencer2D_w8a8.tflite

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

precompiled/qualcomm-snapdragon-x-elite/Sequencer2D_float.bin

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

precompiled/qualcomm-snapdragon-x-elite/Sequencer2D_float.onnx.zip

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

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

@@ -0,0 +1,3 @@
+tool_versions:
+  precompiled_qnn_onnx:
+    qairt: 2.36.4.250725200057_123280

tool-versions.yaml

@@ -0,0 +1,4 @@
+tool_versions:
+  onnx:
+    qairt: 2.36.4.250725200057_123280
+    onnx_runtime: 1.22.2