Hugging Face's logo

qualcomm
/
Whisper-Small-En

Automatic Speech Recognition
PyTorch
TF Lite
ONNX
foundation
android
Model card Files Community
Whisper-Small-En / README.md
qaihm-bot's picture
qaihm-bot
Upload README.md with huggingface_hub
08282ee verified
preview code
|
raw
history blame
8.69 kB
metadata
library_name: pytorch
license: mit
pipeline_tag: automatic-speech-recognition
tags:
  - foundation
  - android

Whisper-Small-En: Optimized for Mobile Deployment

Automatic speech recognition (ASR) model for English transcription as well as translation

OpenAI’s Whisper ASR (Automatic Speech Recognition) model is a state-of-the-art system designed for transcribing spoken language into written text. It exhibits robust performance in realistic, noisy environments, making it highly reliable for real-world applications. Specifically, it excels in long-form transcription, capable of accurately transcribing audio clips up to 30 seconds long. Time to the first token is the encoder's latency, while time to each additional token is decoder's latency, where we assume a mean decoded length specified below.

This model is an implementation of Whisper-Small-En found here. This repository provides scripts to run Whisper-Small-En on Qualcomm® devices. More details on model performance across various devices, can be found here.

Model Details

  • Model Type: Speech recognition
  • Model Stats:
    • Model checkpoint: small.en
    • Input resolution: 80x3000 (30 seconds audio)
    • Mean decoded sequence length: 112 tokens
    • Number of parameters (WhisperEncoder): 102M
    • Model size (WhisperEncoder): 390 MB
    • Number of parameters (WhisperDecoder): 139M
    • Model size (WhisperDecoder): 531 MB
Device Chipset Target Runtime Inference Time (ms) Peak Memory Range (MB) Precision Primary Compute Unit Target Model
Samsung Galaxy S23 Ultra (Android 13) Snapdragon® 8 Gen 2 TFLite 610.635 ms 8 - 417 MB FP16 GPU WhisperEncoder.tflite
Samsung Galaxy S23 Ultra (Android 13) Snapdragon® 8 Gen 2 TFLite 26.644 ms 16 - 20 MB FP16 NPU WhisperDecoder.tflite
Samsung Galaxy S23 Ultra (Android 13) Snapdragon® 8 Gen 2 QNN Model Library 1969.063 ms 1 - 216 MB FP16 NPU WhisperEncoder.so
Samsung Galaxy S23 Ultra (Android 13) Snapdragon® 8 Gen 2 QNN Model Library 24.731 ms 118 - 191 MB FP16 NPU WhisperDecoder.so

Installation

This model can be installed as a Python package via pip.

pip install "qai-hub-models[whisper_small_en]"

Configure Qualcomm® AI Hub to run this model on a cloud-hosted device

Sign-in to Qualcomm® AI Hub 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.

qai-hub configure --api_token API_TOKEN

Navigate to 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.

python -m qai_hub_models.models.whisper_small_en.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.whisper_small_en.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.
python -m qai_hub_models.models.whisper_small_en.export

Profile Job summary of WhisperEncoder
--------------------------------------------------
Device: Snapdragon X Elite CRD (11)
Estimated Inference Time: 1682.16 ms
Estimated Peak Memory Range: 0.92-0.92 MB
Compute Units: NPU (1473) | Total (1473)

Profile Job summary of WhisperDecoder
--------------------------------------------------
Device: Snapdragon X Elite CRD (11)
Estimated Inference Time: 20.40 ms
Estimated Peak Memory Range: 121.48-121.48 MB
Compute Units: NPU (2255) | Total (2255)

How does this work?

This export script leverages Qualcomm® AI Hub 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.

import torch

import qai_hub as hub
from qai_hub_models.models.whisper_small_en import Model

# Load the model
torch_model = Model.from_pretrained()
torch_model.eval()

# Device
device = hub.Device("Samsung Galaxy S23")

# 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.

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.

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.

Deploying compiled model to Android

The models can be deployed using multiple runtimes:

  • TensorFlow Lite (.tflite export): This tutorial provides a guide to deploy the .tflite model in an Android application.

  • QNN (.so export ): This sample app provides instructions on how to use the .so shared library in an Android application.

View on Qualcomm® AI Hub

Get more details on Whisper-Small-En's performance across various devices here. Explore all available models on Qualcomm® AI Hub

License

  • The license for the original implementation of Whisper-Small-En can be found here.
  • The license for the compiled assets for on-device deployment can be found here

References

Community