v0.46.1

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

HuggingFace-WavLM-Base-Plus_float.onnx.zip

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

HuggingFace-WavLM-Base-Plus_float.tflite

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

README.md

@@ -10,234 +10,79 @@ pipeline_tag: automatic-speech-recognition
 
 ![](https://qaihub-public-assets.s3.us-west-2.amazonaws.com/qai-hub-models/models/huggingface_wavlm_base_plus/web-assets/model_demo.png)
 
-# HuggingFace-WavLM-Base-Plus: Optimized for Mobile Deployment
-## Real-time Speech processing
-
+# HuggingFace-WavLM-Base-Plus: Optimized for Qualcomm Devices
 
 HuggingFaceWavLMBasePlus is a real time speech processing backbone based on Microsoft's WavLM model.
 
-This model is an implementation of HuggingFace-WavLM-Base-Plus found [here](https://huggingface.co/patrickvonplaten/wavlm-libri-clean-100h-base-plus/tree/main).
-
-
-This repository provides scripts to run HuggingFace-WavLM-Base-Plus on Qualcomm® devices.
-More details on model performance across various devices, can be found
-[here](https://aihub.qualcomm.com/models/huggingface_wavlm_base_plus).
-
-
-
-### Model Details
-
-- **Model Type:** Model_use_case.speech_recognition
-- **Model Stats:**
-  - Model checkpoint: wavlm-libri-clean-100h-base-plus
-  - Input resolution: 1x320000
-  - Number of parameters: 95.1M
-  - Model size (float): 363 MB
-
-| Model | Precision | Device | Chipset | Target Runtime | Inference Time (ms) | Peak Memory Range (MB) | Primary Compute Unit | Target Model
-|---|---|---|---|---|---|---|---|---|
-| HuggingFace-WavLM-Base-Plus | float | QCS8275 (Proxy) | Qualcomm® QCS8275 (Proxy) | TFLITE | 2850.168 ms | 125 - 967 MB | CPU | [HuggingFace-WavLM-Base-Plus.tflite](https://huggingface.co/qualcomm/HuggingFace-WavLM-Base-Plus/blob/main/HuggingFace-WavLM-Base-Plus.tflite) |
-| HuggingFace-WavLM-Base-Plus | float | QCS8450 (Proxy) | Qualcomm® QCS8450 (Proxy) | TFLITE | 2337.235 ms | 0 - 1268 MB | CPU | [HuggingFace-WavLM-Base-Plus.tflite](https://huggingface.co/qualcomm/HuggingFace-WavLM-Base-Plus/blob/main/HuggingFace-WavLM-Base-Plus.tflite) |
-| HuggingFace-WavLM-Base-Plus | float | QCS8550 (Proxy) | Qualcomm® QCS8550 (Proxy) | TFLITE | 1560.836 ms | 125 - 128 MB | CPU | [HuggingFace-WavLM-Base-Plus.tflite](https://huggingface.co/qualcomm/HuggingFace-WavLM-Base-Plus/blob/main/HuggingFace-WavLM-Base-Plus.tflite) |
-| HuggingFace-WavLM-Base-Plus | float | QCS8550 (Proxy) | Qualcomm® QCS8550 (Proxy) | ONNX | 289.504 ms | 0 - 227 MB | NPU | [HuggingFace-WavLM-Base-Plus.onnx.zip](https://huggingface.co/qualcomm/HuggingFace-WavLM-Base-Plus/blob/main/HuggingFace-WavLM-Base-Plus.onnx.zip) |
-| HuggingFace-WavLM-Base-Plus | float | QCS9075 (Proxy) | Qualcomm® QCS9075 (Proxy) | TFLITE | 2262.782 ms | 126 - 968 MB | CPU | [HuggingFace-WavLM-Base-Plus.tflite](https://huggingface.co/qualcomm/HuggingFace-WavLM-Base-Plus/blob/main/HuggingFace-WavLM-Base-Plus.tflite) |
-| HuggingFace-WavLM-Base-Plus | float | SA7255P ADP | Qualcomm® SA7255P | TFLITE | 2850.168 ms | 125 - 967 MB | CPU | [HuggingFace-WavLM-Base-Plus.tflite](https://huggingface.co/qualcomm/HuggingFace-WavLM-Base-Plus/blob/main/HuggingFace-WavLM-Base-Plus.tflite) |
-| HuggingFace-WavLM-Base-Plus | float | SA8295P ADP | Qualcomm® SA8295P | TFLITE | 2075.065 ms | 125 - 1067 MB | CPU | [HuggingFace-WavLM-Base-Plus.tflite](https://huggingface.co/qualcomm/HuggingFace-WavLM-Base-Plus/blob/main/HuggingFace-WavLM-Base-Plus.tflite) |
-| HuggingFace-WavLM-Base-Plus | float | SA8775P ADP | Qualcomm® SA8775P | TFLITE | 2262.782 ms | 126 - 968 MB | CPU | [HuggingFace-WavLM-Base-Plus.tflite](https://huggingface.co/qualcomm/HuggingFace-WavLM-Base-Plus/blob/main/HuggingFace-WavLM-Base-Plus.tflite) |
-| HuggingFace-WavLM-Base-Plus | float | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | TFLITE | 1380.118 ms | 117 - 1244 MB | CPU | [HuggingFace-WavLM-Base-Plus.tflite](https://huggingface.co/qualcomm/HuggingFace-WavLM-Base-Plus/blob/main/HuggingFace-WavLM-Base-Plus.tflite) |
-| HuggingFace-WavLM-Base-Plus | float | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | ONNX | 216.184 ms | 0 - 1403 MB | NPU | [HuggingFace-WavLM-Base-Plus.onnx.zip](https://huggingface.co/qualcomm/HuggingFace-WavLM-Base-Plus/blob/main/HuggingFace-WavLM-Base-Plus.onnx.zip) |
-| HuggingFace-WavLM-Base-Plus | float | Samsung Galaxy S25 | Snapdragon® 8 Elite For Galaxy Mobile | TFLITE | 1024.104 ms | 125 - 833 MB | CPU | [HuggingFace-WavLM-Base-Plus.tflite](https://huggingface.co/qualcomm/HuggingFace-WavLM-Base-Plus/blob/main/HuggingFace-WavLM-Base-Plus.tflite) |
-| HuggingFace-WavLM-Base-Plus | float | Samsung Galaxy S25 | Snapdragon® 8 Elite For Galaxy Mobile | ONNX | 189.5 ms | 1 - 1008 MB | NPU | [HuggingFace-WavLM-Base-Plus.onnx.zip](https://huggingface.co/qualcomm/HuggingFace-WavLM-Base-Plus/blob/main/HuggingFace-WavLM-Base-Plus.onnx.zip) |
-| HuggingFace-WavLM-Base-Plus | float | Snapdragon 8 Elite Gen 5 QRD | Snapdragon® 8 Elite Gen 5 Mobile | TFLITE | 923.379 ms | 101 - 1107 MB | CPU | [HuggingFace-WavLM-Base-Plus.tflite](https://huggingface.co/qualcomm/HuggingFace-WavLM-Base-Plus/blob/main/HuggingFace-WavLM-Base-Plus.tflite) |
-| HuggingFace-WavLM-Base-Plus | float | Snapdragon 8 Elite Gen 5 QRD | Snapdragon® 8 Elite Gen 5 Mobile | ONNX | 154.769 ms | 1 - 1053 MB | NPU | [HuggingFace-WavLM-Base-Plus.onnx.zip](https://huggingface.co/qualcomm/HuggingFace-WavLM-Base-Plus/blob/main/HuggingFace-WavLM-Base-Plus.onnx.zip) |
-| HuggingFace-WavLM-Base-Plus | float | Snapdragon X Elite CRD | Snapdragon® X Elite | ONNX | 295.114 ms | 202 - 202 MB | NPU | [HuggingFace-WavLM-Base-Plus.onnx.zip](https://huggingface.co/qualcomm/HuggingFace-WavLM-Base-Plus/blob/main/HuggingFace-WavLM-Base-Plus.onnx.zip) |
-
-
-
-
-## Installation
-
-
-Install the package via pip:
-```bash
-# NOTE: 3.10 <= PYTHON_VERSION < 3.14 is supported.
-pip install "qai-hub-models[huggingface-wavlm-base-plus]"
-```
-
-
-## 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.huggingface_wavlm_base_plus.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.huggingface_wavlm_base_plus.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.huggingface_wavlm_base_plus.export
-```
+This is based on the implementation of HuggingFace-WavLM-Base-Plus found [here](https://huggingface.co/patrickvonplaten/wavlm-libri-clean-100h-base-plus/tree/main).
+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/huggingface_wavlm_base_plus) 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:
 
-## How does this work?
+### Option 1: Download Pre-Exported Models
 
-This [export script](https://aihub.qualcomm.com/models/huggingface_wavlm_base_plus/qai_hub_models/models/HuggingFace-WavLM-Base-Plus/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:
+Below are pre-exported model assets ready for deployment.
 
-Step 1: **Compile model for on-device deployment**
+| Runtime | Precision | Chipset | SDK Versions | Download |
+|---|---|---|---|---|
+| ONNX | float | Universal | QAIRT 2.37, ONNX Runtime 1.23.0 | [Download](https://qaihub-public-assets.s3.us-west-2.amazonaws.com/qai-hub-models/models/huggingface_wavlm_base_plus/releases/v0.46.1/huggingface_wavlm_base_plus-onnx-float.zip)
+| TFLITE | float | Universal | TFLite 2.17.0 | [Download](https://qaihub-public-assets.s3.us-west-2.amazonaws.com/qai-hub-models/models/huggingface_wavlm_base_plus/releases/v0.46.1/huggingface_wavlm_base_plus-tflite-float.zip)
 
-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.
+For more device-specific assets and performance metrics, visit **[HuggingFace-WavLM-Base-Plus on Qualcomm® AI Hub](https://aihub.qualcomm.com/models/huggingface_wavlm_base_plus)**.
 
-```python
-import torch
 
-import qai_hub as hub
-from qai_hub_models.models.huggingface_wavlm_base_plus import Model
+### Option 2: Export with Custom Configurations
 
-# Load the model
-torch_model = Model.from_pretrained()
+Use the [Qualcomm® AI Hub Models](https://github.com/quic/ai-hub-models/blob/main/qai_hub_models/models/huggingface_wavlm_base_plus) 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
 
-# Device
-device = hub.Device("Samsung Galaxy S25")
+This option is ideal if you need to customize the model beyond the default configuration provided here.
 
-# Trace model
-input_shape = torch_model.get_input_spec()
-sample_inputs = torch_model.sample_inputs()
+See our repository for [HuggingFace-WavLM-Base-Plus on GitHub](https://github.com/quic/ai-hub-models/blob/main/qai_hub_models/models/huggingface_wavlm_base_plus) for usage instructions.
 
-pt_model = torch.jit.trace(torch_model, [torch.tensor(data[0]) for _, data in sample_inputs.items()])
+## Model Details
 
-# Compile model on a specific device
-compile_job = hub.submit_compile_job(
-    model=pt_model,
-    device=device,
-    input_specs=torch_model.get_input_spec(),
-)
+**Model Type:** Model_use_case.speech_recognition
 
-# 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.huggingface_wavlm_base_plus.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.huggingface_wavlm_base_plus.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 HuggingFace-WavLM-Base-Plus's performance across various devices [here](https://aihub.qualcomm.com/models/huggingface_wavlm_base_plus).
-Explore all available models on [Qualcomm® AI Hub](https://aihub.qualcomm.com/)
+**Model Stats:**
+- Model checkpoint: wavlm-libri-clean-100h-base-plus
+- Input resolution: 1x320000
+- Number of parameters: 95.1M
+- Model size (float): 363 MB
 
+## Performance Summary
+| Model | Runtime | Precision | Chipset | Inference Time (ms) | Peak Memory Range (MB) | Primary Compute Unit
+|---|---|---|---|---|---|---
+| HuggingFace-WavLM-Base-Plus | ONNX | float | Snapdragon® X Elite | 295.294 ms | 202 - 202 MB | NPU
+| HuggingFace-WavLM-Base-Plus | ONNX | float | Snapdragon® 8 Gen 3 Mobile | 219.292 ms | 1 - 1404 MB | NPU
+| HuggingFace-WavLM-Base-Plus | ONNX | float | Qualcomm® QCS8550 (Proxy) | 287.875 ms | 1 - 4 MB | NPU
+| HuggingFace-WavLM-Base-Plus | ONNX | float | Qualcomm® QCS9075 | 280.599 ms | 1 - 4 MB | NPU
+| HuggingFace-WavLM-Base-Plus | ONNX | float | Snapdragon® 8 Elite For Galaxy Mobile | 188.641 ms | 1 - 1006 MB | NPU
+| HuggingFace-WavLM-Base-Plus | ONNX | float | Snapdragon® 8 Elite Gen 5 Mobile | 154.394 ms | 1 - 1057 MB | NPU
+| HuggingFace-WavLM-Base-Plus | TFLITE | float | Snapdragon® 8 Gen 3 Mobile | 1421.172 ms | 117 - 1306 MB | CPU
+| HuggingFace-WavLM-Base-Plus | TFLITE | float | Qualcomm® QCS8275 (Proxy) | 2905.625 ms | 125 - 1049 MB | CPU
+| HuggingFace-WavLM-Base-Plus | TFLITE | float | Qualcomm® QCS8550 (Proxy) | 1557.459 ms | 127 - 756 MB | CPU
+| HuggingFace-WavLM-Base-Plus | TFLITE | float | Qualcomm® SA8775P | 2260.664 ms | 125 - 1048 MB | CPU
+| HuggingFace-WavLM-Base-Plus | TFLITE | float | Qualcomm® QCS9075 | 2287.921 ms | 125 - 710 MB | CPU
+| HuggingFace-WavLM-Base-Plus | TFLITE | float | Qualcomm® QCS8450 (Proxy) | 2070.43 ms | 0 - 1289 MB | CPU
+| HuggingFace-WavLM-Base-Plus | TFLITE | float | Qualcomm® SA7255P | 2905.625 ms | 125 - 1049 MB | CPU
+| HuggingFace-WavLM-Base-Plus | TFLITE | float | Qualcomm® SA8295P | 1998.746 ms | 125 - 1108 MB | CPU
+| HuggingFace-WavLM-Base-Plus | TFLITE | float | Snapdragon® 8 Elite For Galaxy Mobile | 1051.778 ms | 32 - 771 MB | CPU
+| HuggingFace-WavLM-Base-Plus | TFLITE | float | Snapdragon® 8 Elite Gen 5 Mobile | 907.495 ms | 124 - 1277 MB | CPU
 
 ## License
 * The license for the original implementation of HuggingFace-WavLM-Base-Plus can be found
   [here](https://github.com/microsoft/unilm/blob/master/LICENSE).
 
-
-
 ## References
 * [WavLM: Large-Scale Self-Supervised Pre-Training for Full Stack Speech Processing](https://arxiv.org/abs/2110.13900)
 * [Source Model Implementation](https://huggingface.co/patrickvonplaten/wavlm-libri-clean-100h-base-plus/tree/main)
 
-
-
 ## 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).
-
-

tool-versions.yaml

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