DDRNet23-Slim / README.md
qaihm-bot's picture
Upload README.md with huggingface_hub
e4e1979 verified
metadata
library_name: pytorch
license: mit
pipeline_tag: image-segmentation
tags:
  - real_time
  - android

DDRNet23-Slim: Optimized for Mobile Deployment

Segment images or video by class in real-time on device

DDRNet23Slim is a machine learning model that segments an image into semantic classes, specifically designed for road-based scenes. It is designed for the application of self-driving cars.

This model is an implementation of DDRNet23-Slim found here.

This repository provides scripts to run DDRNet23-Slim 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: DDRNet23s_imagenet.pth
    • Inference latency: RealTime
    • Input resolution: 2048x1024
    • Number of parameters: 5.69M
    • Model size: 21.7 MB
    • Number of output classes: 19
Model Device Chipset Target Runtime Inference Time (ms) Peak Memory Range (MB) Precision Primary Compute Unit Target Model
DDRNet23-Slim Samsung Galaxy S23 Snapdragon® 8 Gen 2 TFLITE 5.131 ms 2 - 4 MB FP16 NPU DDRNet23-Slim.tflite
DDRNet23-Slim Samsung Galaxy S23 Snapdragon® 8 Gen 2 ONNX 7.388 ms 9 - 14 MB FP16 NPU DDRNet23-Slim.onnx
DDRNet23-Slim Samsung Galaxy S24 Snapdragon® 8 Gen 3 TFLITE 3.489 ms 1 - 77 MB FP16 NPU DDRNet23-Slim.tflite
DDRNet23-Slim Samsung Galaxy S24 Snapdragon® 8 Gen 3 ONNX 4.952 ms 11 - 101 MB FP16 NPU DDRNet23-Slim.onnx
DDRNet23-Slim Snapdragon 8 Elite QRD Snapdragon® 8 Elite TFLITE 3.453 ms 0 - 39 MB FP16 NPU DDRNet23-Slim.tflite
DDRNet23-Slim Snapdragon 8 Elite QRD Snapdragon® 8 Elite ONNX 4.99 ms 11 - 55 MB FP16 NPU DDRNet23-Slim.onnx
DDRNet23-Slim QCS8550 (Proxy) QCS8550 Proxy TFLITE 5.068 ms 0 - 2 MB FP16 NPU DDRNet23-Slim.tflite
DDRNet23-Slim SA8255 (Proxy) SA8255P Proxy TFLITE 5.131 ms 1 - 2 MB FP16 NPU DDRNet23-Slim.tflite
DDRNet23-Slim SA8775 (Proxy) SA8775P Proxy TFLITE 5.185 ms 0 - 2 MB FP16 NPU DDRNet23-Slim.tflite
DDRNet23-Slim SA8650 (Proxy) SA8650P Proxy TFLITE 5.131 ms 0 - 3 MB FP16 NPU DDRNet23-Slim.tflite
DDRNet23-Slim SA8295P ADP SA8295P TFLITE 8.857 ms 1 - 31 MB FP16 NPU DDRNet23-Slim.tflite
DDRNet23-Slim QCS8450 (Proxy) QCS8450 Proxy TFLITE 7.549 ms 2 - 65 MB FP16 NPU DDRNet23-Slim.tflite
DDRNet23-Slim Snapdragon X Elite CRD Snapdragon® X Elite ONNX 8.362 ms 9 - 9 MB FP16 NPU DDRNet23-Slim.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.ddrnet23_slim.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.ddrnet23_slim.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.ddrnet23_slim.export
Profiling Results
------------------------------------------------------------
DDRNet23-Slim
Device                          : Samsung Galaxy S23 (13)
Runtime                         : TFLITE                 
Estimated inference time (ms)   : 5.1                    
Estimated peak memory usage (MB): [2, 4]                 
Total # Ops                     : 131                    
Compute Unit(s)                 : NPU (131 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.ddrnet23_slim 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.

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

License

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

References

Community