DenseNet-121 / README.md
qaihm-bot's picture
Upload README.md with huggingface_hub
386168f verified
metadata
library_name: pytorch
license: other
tags:
  - backbone
  - android
pipeline_tag: image-classification

DenseNet-121: Optimized for Mobile Deployment

Imagenet classifier and general purpose backbone

Densenet 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 DenseNet-121 found here.

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

Model Details

  • Model Type: Model_use_case.image_classification
  • Model Stats:
    • Model checkpoint: Imagenet
    • Input resolution: 224x224
    • Number of parameters: 7.97M
    • Model size (float): 30.5 MB
    • Model size (w8a8): 9.4 MB
Model Precision Device Chipset Target Runtime Inference Time (ms) Peak Memory Range (MB) Primary Compute Unit Target Model
DenseNet-121 float QCS8275 (Proxy) Qualcomm® QCS8275 (Proxy) TFLITE 8.285 ms 0 - 35 MB NPU DenseNet-121.tflite
DenseNet-121 float QCS8275 (Proxy) Qualcomm® QCS8275 (Proxy) QNN 7.894 ms 1 - 10 MB NPU Use Export Script
DenseNet-121 float QCS8450 (Proxy) Qualcomm® QCS8450 (Proxy) TFLITE 2.732 ms 0 - 52 MB NPU DenseNet-121.tflite
DenseNet-121 float QCS8450 (Proxy) Qualcomm® QCS8450 (Proxy) QNN 3.345 ms 1 - 38 MB NPU Use Export Script
DenseNet-121 float QCS8550 (Proxy) Qualcomm® QCS8550 (Proxy) TFLITE 1.905 ms 0 - 97 MB NPU DenseNet-121.tflite
DenseNet-121 float QCS8550 (Proxy) Qualcomm® QCS8550 (Proxy) QNN 1.727 ms 1 - 3 MB NPU Use Export Script
DenseNet-121 float QCS9075 (Proxy) Qualcomm® QCS9075 (Proxy) TFLITE 2.956 ms 0 - 36 MB NPU DenseNet-121.tflite
DenseNet-121 float QCS9075 (Proxy) Qualcomm® QCS9075 (Proxy) QNN 2.653 ms 1 - 15 MB NPU Use Export Script
DenseNet-121 float SA7255P ADP Qualcomm® SA7255P TFLITE 8.285 ms 0 - 35 MB NPU DenseNet-121.tflite
DenseNet-121 float SA7255P ADP Qualcomm® SA7255P QNN 7.894 ms 1 - 10 MB NPU Use Export Script
DenseNet-121 float SA8255 (Proxy) Qualcomm® SA8255P (Proxy) TFLITE 1.895 ms 0 - 96 MB NPU DenseNet-121.tflite
DenseNet-121 float SA8255 (Proxy) Qualcomm® SA8255P (Proxy) QNN 1.732 ms 1 - 2 MB NPU Use Export Script
DenseNet-121 float SA8295P ADP Qualcomm® SA8295P TFLITE 3.336 ms 0 - 37 MB NPU DenseNet-121.tflite
DenseNet-121 float SA8295P ADP Qualcomm® SA8295P QNN 3.116 ms 1 - 18 MB NPU Use Export Script
DenseNet-121 float SA8650 (Proxy) Qualcomm® SA8650P (Proxy) TFLITE 1.902 ms 0 - 97 MB NPU DenseNet-121.tflite
DenseNet-121 float SA8650 (Proxy) Qualcomm® SA8650P (Proxy) QNN 1.733 ms 1 - 11 MB NPU Use Export Script
DenseNet-121 float SA8775P ADP Qualcomm® SA8775P TFLITE 2.956 ms 0 - 36 MB NPU DenseNet-121.tflite
DenseNet-121 float SA8775P ADP Qualcomm® SA8775P QNN 2.653 ms 1 - 15 MB NPU Use Export Script
DenseNet-121 float Samsung Galaxy S23 Snapdragon® 8 Gen 2 Mobile TFLITE 1.9 ms 0 - 97 MB NPU DenseNet-121.tflite
DenseNet-121 float Samsung Galaxy S23 Snapdragon® 8 Gen 2 Mobile QNN 1.738 ms 1 - 8 MB NPU Use Export Script
DenseNet-121 float Samsung Galaxy S23 Snapdragon® 8 Gen 2 Mobile ONNX 1.688 ms 0 - 55 MB NPU DenseNet-121.onnx
DenseNet-121 float Samsung Galaxy S24 Snapdragon® 8 Gen 3 Mobile TFLITE 1.273 ms 0 - 53 MB NPU DenseNet-121.tflite
DenseNet-121 float Samsung Galaxy S24 Snapdragon® 8 Gen 3 Mobile QNN 1.193 ms 0 - 37 MB NPU Use Export Script
DenseNet-121 float Samsung Galaxy S24 Snapdragon® 8 Gen 3 Mobile ONNX 1.151 ms 0 - 64 MB NPU DenseNet-121.onnx
DenseNet-121 float Snapdragon 8 Elite QRD Snapdragon® 8 Elite Mobile TFLITE 1.147 ms 0 - 37 MB NPU DenseNet-121.tflite
DenseNet-121 float Snapdragon 8 Elite QRD Snapdragon® 8 Elite Mobile QNN 1.047 ms 1 - 26 MB NPU Use Export Script
DenseNet-121 float Snapdragon 8 Elite QRD Snapdragon® 8 Elite Mobile ONNX 0.917 ms 1 - 28 MB NPU DenseNet-121.onnx
DenseNet-121 float Snapdragon X Elite CRD Snapdragon® X Elite QNN 1.96 ms 1 - 1 MB NPU Use Export Script
DenseNet-121 float Snapdragon X Elite CRD Snapdragon® X Elite ONNX 2.05 ms 16 - 16 MB NPU DenseNet-121.onnx
DenseNet-121 w8a8 QCS8275 (Proxy) Qualcomm® QCS8275 (Proxy) TFLITE 4.698 ms 0 - 34 MB NPU DenseNet-121.tflite
DenseNet-121 w8a8 QCS8450 (Proxy) Qualcomm® QCS8450 (Proxy) TFLITE 3.315 ms 0 - 45 MB NPU DenseNet-121.tflite
DenseNet-121 w8a8 QCS8550 (Proxy) Qualcomm® QCS8550 (Proxy) TFLITE 2.308 ms 0 - 18 MB NPU DenseNet-121.tflite
DenseNet-121 w8a8 QCS9075 (Proxy) Qualcomm® QCS9075 (Proxy) TFLITE 2.715 ms 0 - 35 MB NPU DenseNet-121.tflite
DenseNet-121 w8a8 RB3 Gen 2 (Proxy) Qualcomm® QCS6490 (Proxy) TFLITE 92.727 ms 7 - 38 MB NPU DenseNet-121.tflite
DenseNet-121 w8a8 RB5 (Proxy) Qualcomm® QCS8250 (Proxy) TFLITE 108.538 ms 0 - 40 MB GPU DenseNet-121.tflite
DenseNet-121 w8a8 SA7255P ADP Qualcomm® SA7255P TFLITE 4.698 ms 0 - 34 MB NPU DenseNet-121.tflite
DenseNet-121 w8a8 SA8255 (Proxy) Qualcomm® SA8255P (Proxy) TFLITE 2.304 ms 0 - 18 MB NPU DenseNet-121.tflite
DenseNet-121 w8a8 SA8295P ADP Qualcomm® SA8295P TFLITE 3.903 ms 0 - 36 MB NPU DenseNet-121.tflite
DenseNet-121 w8a8 SA8650 (Proxy) Qualcomm® SA8650P (Proxy) TFLITE 2.3 ms 0 - 18 MB NPU DenseNet-121.tflite
DenseNet-121 w8a8 SA8775P ADP Qualcomm® SA8775P TFLITE 2.715 ms 0 - 35 MB NPU DenseNet-121.tflite
DenseNet-121 w8a8 Samsung Galaxy S23 Snapdragon® 8 Gen 2 Mobile TFLITE 2.311 ms 0 - 18 MB NPU DenseNet-121.tflite
DenseNet-121 w8a8 Samsung Galaxy S24 Snapdragon® 8 Gen 3 Mobile TFLITE 1.663 ms 17 - 60 MB NPU DenseNet-121.tflite
DenseNet-121 w8a8 Snapdragon 8 Elite QRD Snapdragon® 8 Elite Mobile TFLITE 1.235 ms 0 - 40 MB NPU DenseNet-121.tflite

Installation

Install the 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.densenet121.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.densenet121.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.densenet121.export
Profiling Results
------------------------------------------------------------
DenseNet-121
Device                          : cs_8275 (ANDROID 14)                 
Runtime                         : TFLITE                               
Estimated inference time (ms)   : 8.3                                  
Estimated peak memory usage (MB): [0, 35]                              
Total # Ops                     : 312                                  
Compute Unit(s)                 : npu (312 ops) gpu (0 ops) cpu (0 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.densenet121 import Model

# Load the model
torch_model = Model.from_pretrained()

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

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

License

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

References

Community