Hugging Face's logo

qualcomm
/
Shufflenet-v2

Image Classification
PyTorch
TF Lite
ONNX
android
Model card Files Community
Shufflenet-v2 / README.md
qaihm-bot's picture
qaihm-bot
Upload README.md with huggingface_hub
b8da0bc verified
preview code
|
raw
history blame contribute delete
11.7 kB
metadata
library_name: pytorch
license: bsd-3-clause
pipeline_tag: image-classification
tags:
  - android

Shufflenet-v2: Optimized for Mobile Deployment

Imagenet classifier and general purpose backbone

ShufflenetV2 is a machine learning model that can classify images from the Imagenet dataset. It can also be used as a backbone in building more complex models for specific use cases.

This model is an implementation of Shufflenet-v2 found here.

This repository provides scripts to run Shufflenet-v2 on Qualcomm® devices. More details on model performance across various devices, can be found here.

Model Details

  • Model Type: Image classification
  • Model Stats:
    • Model checkpoint: Imagenet
    • Input resolution: 224x224
    • Number of parameters: 1.36M
    • Model size: 5.25 MB
Model Device Chipset Target Runtime Inference Time (ms) Peak Memory Range (MB) Precision Primary Compute Unit Target Model
Shufflenet-v2 Samsung Galaxy S23 Snapdragon® 8 Gen 2 TFLITE 1.208 ms 0 - 15 MB FP16 NPU Shufflenet-v2.tflite
Shufflenet-v2 Samsung Galaxy S23 Snapdragon® 8 Gen 2 QNN 0.774 ms 0 - 5 MB FP16 NPU Shufflenet-v2.so
Shufflenet-v2 Samsung Galaxy S23 Snapdragon® 8 Gen 2 ONNX 1.117 ms 1 - 2 MB FP16 NPU Shufflenet-v2.onnx
Shufflenet-v2 Samsung Galaxy S24 Snapdragon® 8 Gen 3 TFLITE 0.791 ms 0 - 12 MB FP16 NPU Shufflenet-v2.tflite
Shufflenet-v2 Samsung Galaxy S24 Snapdragon® 8 Gen 3 QNN 0.514 ms 0 - 17 MB FP16 NPU Shufflenet-v2.so
Shufflenet-v2 Samsung Galaxy S24 Snapdragon® 8 Gen 3 ONNX 0.731 ms 0 - 41 MB FP16 NPU Shufflenet-v2.onnx
Shufflenet-v2 Snapdragon 8 Elite QRD Snapdragon® 8 Elite TFLITE 0.666 ms 1 - 11 MB FP16 NPU Shufflenet-v2.tflite
Shufflenet-v2 Snapdragon 8 Elite QRD Snapdragon® 8 Elite QNN 0.413 ms 0 - 13 MB FP16 NPU Use Export Script
Shufflenet-v2 Snapdragon 8 Elite QRD Snapdragon® 8 Elite ONNX 0.787 ms 0 - 23 MB FP16 NPU Shufflenet-v2.onnx
Shufflenet-v2 QCS8550 (Proxy) QCS8550 Proxy TFLITE 1.21 ms 0 - 15 MB FP16 NPU Shufflenet-v2.tflite
Shufflenet-v2 QCS8550 (Proxy) QCS8550 Proxy QNN 0.73 ms 1 - 2 MB FP16 NPU Use Export Script
Shufflenet-v2 SA7255P ADP SA7255P TFLITE 5.107 ms 0 - 14 MB FP16 NPU Shufflenet-v2.tflite
Shufflenet-v2 SA7255P ADP SA7255P QNN 4.549 ms 1 - 11 MB FP16 NPU Use Export Script
Shufflenet-v2 SA8255 (Proxy) SA8255P Proxy TFLITE 1.209 ms 0 - 5 MB FP16 NPU Shufflenet-v2.tflite
Shufflenet-v2 SA8255 (Proxy) SA8255P Proxy QNN 0.739 ms 1 - 2 MB FP16 NPU Use Export Script
Shufflenet-v2 SA8295P ADP SA8295P TFLITE 1.759 ms 0 - 9 MB FP16 NPU Shufflenet-v2.tflite
Shufflenet-v2 SA8295P ADP SA8295P QNN 1.334 ms 1 - 6 MB FP16 NPU Use Export Script
Shufflenet-v2 SA8650 (Proxy) SA8650P Proxy TFLITE 1.212 ms 0 - 25 MB FP16 NPU Shufflenet-v2.tflite
Shufflenet-v2 SA8650 (Proxy) SA8650P Proxy QNN 0.739 ms 2 - 4 MB FP16 NPU Use Export Script
Shufflenet-v2 SA8775P ADP SA8775P TFLITE 1.817 ms 0 - 15 MB FP16 NPU Shufflenet-v2.tflite
Shufflenet-v2 SA8775P ADP SA8775P QNN 1.4 ms 1 - 7 MB FP16 NPU Use Export Script
Shufflenet-v2 QCS8450 (Proxy) QCS8450 Proxy TFLITE 1.326 ms 0 - 19 MB FP16 NPU Shufflenet-v2.tflite
Shufflenet-v2 QCS8450 (Proxy) QCS8450 Proxy QNN 0.87 ms 1 - 15 MB FP16 NPU Use Export Script
Shufflenet-v2 Snapdragon X Elite CRD Snapdragon® X Elite QNN 0.892 ms 1 - 1 MB FP16 NPU Use Export Script
Shufflenet-v2 Snapdragon X Elite CRD Snapdragon® X Elite ONNX 1.112 ms 4 - 4 MB FP16 NPU Shufflenet-v2.onnx

Installation

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

pip install qai-hub-models

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.shufflenet_v2.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.shufflenet_v2.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.shufflenet_v2.export

Profiling Results
------------------------------------------------------------
Shufflenet-v2
Device                          : Samsung Galaxy S23 (13)
Runtime                         : TFLITE                 
Estimated inference time (ms)   : 1.2                    
Estimated peak memory usage (MB): [0, 15]                
Total # Ops                     : 204                    
Compute Unit(s)                 : NPU (204 ops)

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.shufflenet_v2 import Model

# Load the model
torch_model = Model.from_pretrained()

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

Run demo on a cloud-hosted device

You can also run the demo on-device.

python -m qai_hub_models.models.shufflenet_v2.demo --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.shufflenet_v2.demo -- --on-device

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 Shufflenet-v2's performance across various devices here. Explore all available models on Qualcomm® AI Hub

License

  • The license for the original implementation of Shufflenet-v2 can be found here.
  • The license for the compiled assets for on-device deployment can be found here

References

Community