qaihm-bot's picture
Upload README.md with huggingface_hub
f316ab5 verified
metadata
library_name: pytorch
license: mit
pipeline_tag: image-segmentation
tags:
  - quantized
  - android

DeepLabV3-Plus-MobileNet-Quantized: Optimized for Mobile Deployment

Quantized Deep Convolutional Neural Network model for semantic segmentation

DeepLabV3 Quantized is designed for semantic segmentation at multiple scales, trained on various datasets. It uses MobileNet as a backbone.

This model is an implementation of DeepLabV3-Plus-MobileNet-Quantized found here.

This repository provides scripts to run DeepLabV3-Plus-MobileNet-Quantized on Qualcomm® devices. More details on model performance across various devices, can be found here.

Model Details

  • Model Type: Semantic segmentation
  • Model Stats:
    • Model checkpoint: VOC2012
    • Input resolution: 513x513
    • Number of parameters: 5.80M
    • Model size: 6.04 MB
    • Number of output classes: 21
Model Device Chipset Target Runtime Inference Time (ms) Peak Memory Range (MB) Precision Primary Compute Unit Target Model
DeepLabV3-Plus-MobileNet-Quantized Samsung Galaxy S23 Snapdragon® 8 Gen 2 TFLITE 4.165 ms 0 - 12 MB INT8 NPU DeepLabV3-Plus-MobileNet-Quantized.tflite
DeepLabV3-Plus-MobileNet-Quantized Samsung Galaxy S23 Snapdragon® 8 Gen 2 QNN 4.764 ms 0 - 15 MB INT8 NPU DeepLabV3-Plus-MobileNet-Quantized.so
DeepLabV3-Plus-MobileNet-Quantized Samsung Galaxy S24 Snapdragon® 8 Gen 3 TFLITE 2.993 ms 0 - 40 MB INT8 NPU DeepLabV3-Plus-MobileNet-Quantized.tflite
DeepLabV3-Plus-MobileNet-Quantized Samsung Galaxy S24 Snapdragon® 8 Gen 3 QNN 3.449 ms 0 - 36 MB INT8 NPU DeepLabV3-Plus-MobileNet-Quantized.so
DeepLabV3-Plus-MobileNet-Quantized Snapdragon 8 Elite QRD Snapdragon® 8 Elite TFLITE 2.819 ms 0 - 35 MB INT8 NPU DeepLabV3-Plus-MobileNet-Quantized.tflite
DeepLabV3-Plus-MobileNet-Quantized Snapdragon 8 Elite QRD Snapdragon® 8 Elite QNN 3.466 ms 1 - 34 MB INT8 NPU Use Export Script
DeepLabV3-Plus-MobileNet-Quantized RB3 Gen 2 (Proxy) QCS6490 Proxy TFLITE 18.168 ms 0 - 43 MB INT8 NPU DeepLabV3-Plus-MobileNet-Quantized.tflite
DeepLabV3-Plus-MobileNet-Quantized RB3 Gen 2 (Proxy) QCS6490 Proxy QNN 19.691 ms 1 - 7 MB INT8 NPU Use Export Script
DeepLabV3-Plus-MobileNet-Quantized RB5 (Proxy) QCS8250 Proxy TFLITE 164.857 ms 3 - 6 MB INT8 NPU DeepLabV3-Plus-MobileNet-Quantized.tflite
DeepLabV3-Plus-MobileNet-Quantized QCS8550 (Proxy) QCS8550 Proxy TFLITE 4.194 ms 0 - 11 MB INT8 NPU DeepLabV3-Plus-MobileNet-Quantized.tflite
DeepLabV3-Plus-MobileNet-Quantized QCS8550 (Proxy) QCS8550 Proxy QNN 3.948 ms 1 - 2 MB INT8 NPU Use Export Script
DeepLabV3-Plus-MobileNet-Quantized SA7255P ADP SA7255P TFLITE 54.904 ms 0 - 31 MB INT8 NPU DeepLabV3-Plus-MobileNet-Quantized.tflite
DeepLabV3-Plus-MobileNet-Quantized SA7255P ADP SA7255P QNN 55.303 ms 1 - 11 MB INT8 NPU Use Export Script
DeepLabV3-Plus-MobileNet-Quantized SA8255 (Proxy) SA8255P Proxy TFLITE 4.16 ms 0 - 12 MB INT8 NPU DeepLabV3-Plus-MobileNet-Quantized.tflite
DeepLabV3-Plus-MobileNet-Quantized SA8255 (Proxy) SA8255P Proxy QNN 3.937 ms 1 - 2 MB INT8 NPU Use Export Script
DeepLabV3-Plus-MobileNet-Quantized SA8295P ADP SA8295P TFLITE 6.619 ms 0 - 34 MB INT8 NPU DeepLabV3-Plus-MobileNet-Quantized.tflite
DeepLabV3-Plus-MobileNet-Quantized SA8295P ADP SA8295P QNN 6.472 ms 1 - 7 MB INT8 NPU Use Export Script
DeepLabV3-Plus-MobileNet-Quantized SA8650 (Proxy) SA8650P Proxy TFLITE 4.164 ms 0 - 16 MB INT8 NPU DeepLabV3-Plus-MobileNet-Quantized.tflite
DeepLabV3-Plus-MobileNet-Quantized SA8650 (Proxy) SA8650P Proxy QNN 3.91 ms 1 - 2 MB INT8 NPU Use Export Script
DeepLabV3-Plus-MobileNet-Quantized SA8775P ADP SA8775P TFLITE 5.733 ms 0 - 33 MB INT8 NPU DeepLabV3-Plus-MobileNet-Quantized.tflite
DeepLabV3-Plus-MobileNet-Quantized SA8775P ADP SA8775P QNN 5.497 ms 1 - 7 MB INT8 NPU Use Export Script
DeepLabV3-Plus-MobileNet-Quantized QCS8450 (Proxy) QCS8450 Proxy TFLITE 5.016 ms 0 - 36 MB INT8 NPU DeepLabV3-Plus-MobileNet-Quantized.tflite
DeepLabV3-Plus-MobileNet-Quantized QCS8450 (Proxy) QCS8450 Proxy QNN 5.51 ms 1 - 36 MB INT8 NPU Use Export Script
DeepLabV3-Plus-MobileNet-Quantized Snapdragon X Elite CRD Snapdragon® X Elite QNN 4.272 ms 1 - 1 MB INT8 NPU Use Export Script

Installation

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

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

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.deeplabv3_plus_mobilenet_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.deeplabv3_plus_mobilenet_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.
python -m qai_hub_models.models.deeplabv3_plus_mobilenet_quantized.export
Profiling Results
------------------------------------------------------------
DeepLabV3-Plus-MobileNet-Quantized
Device                          : Samsung Galaxy S23 (13)
Runtime                         : TFLITE                 
Estimated inference time (ms)   : 4.2                    
Estimated peak memory usage (MB): [0, 12]                
Total # Ops                     : 136                    
Compute Unit(s)                 : NPU (136 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.deeplabv3_plus_mobilenet_quantized 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.deeplabv3_plus_mobilenet_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.deeplabv3_plus_mobilenet_quantized.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 DeepLabV3-Plus-MobileNet-Quantized's performance across various devices here. Explore all available models on Qualcomm® AI Hub

License

  • The license for the original implementation of DeepLabV3-Plus-MobileNet-Quantized can be found here.
  • The license for the compiled assets for on-device deployment can be found here

References

Community