File size: 12,314 Bytes
f2a7149 45f670c f2a7149 b65fee9 f2a7149 f4421e7 b65fee9 f2a7149 26532bf 20cd4f2 f2a7149 f05c850 f2a7149 26532bf f2a7149 26532bf 20cd4f2 26532bf f2a7149 26532bf acba725 26532bf acba725 26532bf f2a7149 26532bf f2a7149 26532bf f2a7149 26532bf f2a7149 26532bf f2a7149 1e73491 f2a7149 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 |
---
library_name: pytorch
license: bsd-3-clause
pipeline_tag: image-classification
tags:
- quantized
- android
---
# Shufflenet-v2Quantized: 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-v2Quantized found [here](https://github.com/pytorch/vision/blob/main/torchvision/models/shufflenetv2.py).
This repository provides scripts to run Shufflenet-v2Quantized on Qualcomm® devices.
More details on model performance across various devices, can be found
[here](https://aihub.qualcomm.com/models/shufflenet_v2_quantized).
### Model Details
- **Model Type:** Image classification
- **Model Stats:**
- Model checkpoint: Imagenet
- Input resolution: 224x224
- Number of parameters: 1.37M
- Model size: 4.42 MB
| Model | Device | Chipset | Target Runtime | Inference Time (ms) | Peak Memory Range (MB) | Precision | Primary Compute Unit | Target Model
|---|---|---|---|---|---|---|---|---|
| Shufflenet-v2Quantized | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 | TFLITE | 0.613 ms | 0 - 2 MB | INT8 | NPU | [Shufflenet-v2Quantized.tflite](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.tflite) |
| Shufflenet-v2Quantized | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 | QNN | 0.612 ms | 0 - 4 MB | INT8 | NPU | [Shufflenet-v2Quantized.so](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.so) |
| Shufflenet-v2Quantized | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 | ONNX | 13.636 ms | 2 - 8 MB | INT8 | NPU | [Shufflenet-v2Quantized.onnx](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.onnx) |
| Shufflenet-v2Quantized | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 | TFLITE | 0.425 ms | 0 - 27 MB | INT8 | NPU | [Shufflenet-v2Quantized.tflite](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.tflite) |
| Shufflenet-v2Quantized | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 | QNN | 0.437 ms | 0 - 13 MB | INT8 | NPU | [Shufflenet-v2Quantized.so](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.so) |
| Shufflenet-v2Quantized | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 | ONNX | 11.257 ms | 2 - 480 MB | INT8 | NPU | [Shufflenet-v2Quantized.onnx](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.onnx) |
| Shufflenet-v2Quantized | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite | TFLITE | 0.467 ms | 0 - 20 MB | INT8 | NPU | [Shufflenet-v2Quantized.tflite](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.tflite) |
| Shufflenet-v2Quantized | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite | QNN | 0.393 ms | 0 - 10 MB | INT8 | NPU | Use Export Script |
| Shufflenet-v2Quantized | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite | ONNX | 10.397 ms | 2 - 428 MB | INT8 | NPU | [Shufflenet-v2Quantized.onnx](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.onnx) |
| Shufflenet-v2Quantized | RB3 Gen 2 (Proxy) | QCS6490 Proxy | TFLITE | 0.897 ms | 0 - 20 MB | INT8 | NPU | [Shufflenet-v2Quantized.tflite](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.tflite) |
| Shufflenet-v2Quantized | RB3 Gen 2 (Proxy) | QCS6490 Proxy | QNN | 1.147 ms | 0 - 8 MB | INT8 | NPU | Use Export Script |
| Shufflenet-v2Quantized | RB5 (Proxy) | QCS8250 Proxy | TFLITE | 10.566 ms | 0 - 5 MB | FP32 | CPU | [Shufflenet-v2Quantized.tflite](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.tflite) |
| Shufflenet-v2Quantized | QCS8550 (Proxy) | QCS8550 Proxy | TFLITE | 0.614 ms | 0 - 1 MB | INT8 | NPU | [Shufflenet-v2Quantized.tflite](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.tflite) |
| Shufflenet-v2Quantized | QCS8550 (Proxy) | QCS8550 Proxy | QNN | 0.548 ms | 0 - 2 MB | INT8 | NPU | Use Export Script |
| Shufflenet-v2Quantized | SA8255 (Proxy) | SA8255P Proxy | TFLITE | 0.613 ms | 0 - 1 MB | INT8 | NPU | [Shufflenet-v2Quantized.tflite](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.tflite) |
| Shufflenet-v2Quantized | SA8255 (Proxy) | SA8255P Proxy | QNN | 0.545 ms | 0 - 1 MB | INT8 | NPU | Use Export Script |
| Shufflenet-v2Quantized | SA8775 (Proxy) | SA8775P Proxy | TFLITE | 0.62 ms | 0 - 2 MB | INT8 | NPU | [Shufflenet-v2Quantized.tflite](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.tflite) |
| Shufflenet-v2Quantized | SA8775 (Proxy) | SA8775P Proxy | QNN | 0.546 ms | 0 - 2 MB | INT8 | NPU | Use Export Script |
| Shufflenet-v2Quantized | SA8650 (Proxy) | SA8650P Proxy | TFLITE | 0.615 ms | 0 - 1 MB | INT8 | NPU | [Shufflenet-v2Quantized.tflite](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.tflite) |
| Shufflenet-v2Quantized | SA8650 (Proxy) | SA8650P Proxy | QNN | 0.54 ms | 0 - 2 MB | INT8 | NPU | Use Export Script |
| Shufflenet-v2Quantized | SA8295P ADP | SA8295P | TFLITE | 0.982 ms | 0 - 19 MB | INT8 | NPU | [Shufflenet-v2Quantized.tflite](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.tflite) |
| Shufflenet-v2Quantized | SA8295P ADP | SA8295P | QNN | 1.186 ms | 0 - 5 MB | INT8 | NPU | Use Export Script |
| Shufflenet-v2Quantized | QCS8450 (Proxy) | QCS8450 Proxy | TFLITE | 0.643 ms | 0 - 28 MB | INT8 | NPU | [Shufflenet-v2Quantized.tflite](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.tflite) |
| Shufflenet-v2Quantized | QCS8450 (Proxy) | QCS8450 Proxy | QNN | 0.655 ms | 0 - 13 MB | INT8 | NPU | Use Export Script |
| Shufflenet-v2Quantized | Snapdragon X Elite CRD | Snapdragon® X Elite | QNN | 0.679 ms | 1 - 1 MB | INT8 | NPU | Use Export Script |
| Shufflenet-v2Quantized | Snapdragon X Elite CRD | Snapdragon® X Elite | ONNX | 15.598 ms | 10 - 10 MB | INT8 | NPU | [Shufflenet-v2Quantized.onnx](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.onnx) |
## Installation
This model can be installed as a Python package via pip.
```bash
pip install qai-hub-models
```
## 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.shufflenet_v2_quantized.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_quantized.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.shufflenet_v2_quantized.export
```
```
Profiling Results
------------------------------------------------------------
Shufflenet-v2Quantized
Device : Samsung Galaxy S23 (13)
Runtime : TFLITE
Estimated inference time (ms) : 0.6
Estimated peak memory usage (MB): [0, 2]
Total # Ops : 233
Compute Unit(s) : NPU (233 ops)
```
## How does this work?
This [export script](https://aihub.qualcomm.com/models/shufflenet_v2_quantized/qai_hub_models/models/Shufflenet-v2Quantized/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.shufflenet_v2_quantized import
# Load the model
# Device
device = hub.Device("Samsung Galaxy S23")
```
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.shufflenet_v2_quantized.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_quantized.demo -- --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 Shufflenet-v2Quantized's performance across various devices [here](https://aihub.qualcomm.com/models/shufflenet_v2_quantized).
Explore all available models on [Qualcomm® AI Hub](https://aihub.qualcomm.com/)
## License
* The license for the original implementation of Shufflenet-v2Quantized can be found [here](https://github.com/pytorch/vision/blob/main/LICENSE).
* 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
* [ShuffleNet V2: Practical Guidelines for Efficient CNN Architecture Design](https://arxiv.org/abs/1807.11164)
* [Source Model Implementation](https://github.com/pytorch/vision/blob/main/torchvision/models/shufflenetv2.py)
## 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:[email protected]).
|