QuickSRNetLarge / README.md
qaihm-bot's picture
v0.30.5
4cc69f8 verified
|
raw
history blame
18.6 kB
metadata
library_name: pytorch
license: other
tags:
  - android
pipeline_tag: image-to-image

QuickSRNetLarge: Optimized for Mobile Deployment

Upscale images and remove image noise

QuickSRNet Large is designed for upscaling images on mobile platforms to sharpen in real-time.

This model is an implementation of QuickSRNetLarge found here.

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

Model Details

  • Model Type: Model_use_case.super_resolution
  • Model Stats:
    • Model checkpoint: quicksrnet_large_3x_checkpoint
    • Input resolution: 128x128
    • Number of parameters: 424K
    • Model size (float): 1.63 MB
    • Model size (w8a8): 449 KB
Model Precision Device Chipset Target Runtime Inference Time (ms) Peak Memory Range (MB) Primary Compute Unit Target Model
QuickSRNetLarge float QCS8275 (Proxy) Qualcomm® QCS8275 (Proxy) TFLITE 90.255 ms 6 - 19 MB NPU QuickSRNetLarge.tflite
QuickSRNetLarge float QCS8275 (Proxy) Qualcomm® QCS8275 (Proxy) QNN 87.044 ms 0 - 10 MB NPU Use Export Script
QuickSRNetLarge float QCS8450 (Proxy) Qualcomm® QCS8450 (Proxy) TFLITE 4.067 ms 6 - 26 MB NPU QuickSRNetLarge.tflite
QuickSRNetLarge float QCS8450 (Proxy) Qualcomm® QCS8450 (Proxy) QNN 3.264 ms 0 - 24 MB NPU Use Export Script
QuickSRNetLarge float QCS8550 (Proxy) Qualcomm® QCS8550 (Proxy) TFLITE 2.475 ms 0 - 5 MB NPU QuickSRNetLarge.tflite
QuickSRNetLarge float QCS8550 (Proxy) Qualcomm® QCS8550 (Proxy) QNN 1.986 ms 0 - 3 MB NPU Use Export Script
QuickSRNetLarge float QCS9075 (Proxy) Qualcomm® QCS9075 (Proxy) TFLITE 4.413 ms 6 - 21 MB NPU QuickSRNetLarge.tflite
QuickSRNetLarge float QCS9075 (Proxy) Qualcomm® QCS9075 (Proxy) QNN 3.474 ms 0 - 13 MB NPU Use Export Script
QuickSRNetLarge float SA7255P ADP Qualcomm® SA7255P TFLITE 90.255 ms 6 - 19 MB NPU QuickSRNetLarge.tflite
QuickSRNetLarge float SA7255P ADP Qualcomm® SA7255P QNN 87.044 ms 0 - 10 MB NPU Use Export Script
QuickSRNetLarge float SA8255 (Proxy) Qualcomm® SA8255P (Proxy) TFLITE 2.503 ms 0 - 5 MB NPU QuickSRNetLarge.tflite
QuickSRNetLarge float SA8255 (Proxy) Qualcomm® SA8255P (Proxy) QNN 2.008 ms 0 - 3 MB NPU Use Export Script
QuickSRNetLarge float SA8295P ADP Qualcomm® SA8295P TFLITE 4.668 ms 6 - 27 MB NPU QuickSRNetLarge.tflite
QuickSRNetLarge float SA8295P ADP Qualcomm® SA8295P QNN 3.905 ms 0 - 18 MB NPU Use Export Script
QuickSRNetLarge float SA8650 (Proxy) Qualcomm® SA8650P (Proxy) TFLITE 2.526 ms 0 - 5 MB NPU QuickSRNetLarge.tflite
QuickSRNetLarge float SA8650 (Proxy) Qualcomm® SA8650P (Proxy) QNN 1.974 ms 0 - 4 MB NPU Use Export Script
QuickSRNetLarge float SA8775P ADP Qualcomm® SA8775P TFLITE 4.413 ms 6 - 21 MB NPU QuickSRNetLarge.tflite
QuickSRNetLarge float SA8775P ADP Qualcomm® SA8775P QNN 3.474 ms 0 - 13 MB NPU Use Export Script
QuickSRNetLarge float Samsung Galaxy S23 Snapdragon® 8 Gen 2 Mobile TFLITE 2.5 ms 0 - 5 MB NPU QuickSRNetLarge.tflite
QuickSRNetLarge float Samsung Galaxy S23 Snapdragon® 8 Gen 2 Mobile QNN 1.978 ms 0 - 4 MB NPU Use Export Script
QuickSRNetLarge float Samsung Galaxy S23 Snapdragon® 8 Gen 2 Mobile ONNX 2.577 ms 0 - 8 MB NPU QuickSRNetLarge.onnx
QuickSRNetLarge float Samsung Galaxy S24 Snapdragon® 8 Gen 3 Mobile TFLITE 1.655 ms 0 - 24 MB NPU QuickSRNetLarge.tflite
QuickSRNetLarge float Samsung Galaxy S24 Snapdragon® 8 Gen 3 Mobile QNN 1.289 ms 0 - 24 MB NPU Use Export Script
QuickSRNetLarge float Samsung Galaxy S24 Snapdragon® 8 Gen 3 Mobile ONNX 1.67 ms 0 - 29 MB NPU QuickSRNetLarge.onnx
QuickSRNetLarge float Snapdragon 8 Elite QRD Snapdragon® 8 Elite Mobile TFLITE 1.898 ms 0 - 24 MB NPU QuickSRNetLarge.tflite
QuickSRNetLarge float Snapdragon 8 Elite QRD Snapdragon® 8 Elite Mobile QNN 1.333 ms 0 - 17 MB NPU Use Export Script
QuickSRNetLarge float Snapdragon 8 Elite QRD Snapdragon® 8 Elite Mobile ONNX 1.756 ms 3 - 21 MB NPU QuickSRNetLarge.onnx
QuickSRNetLarge float Snapdragon X Elite CRD Snapdragon® X Elite QNN 2.153 ms 0 - 0 MB NPU Use Export Script
QuickSRNetLarge float Snapdragon X Elite CRD Snapdragon® X Elite ONNX 2.44 ms 7 - 7 MB NPU QuickSRNetLarge.onnx
QuickSRNetLarge w8a8 QCS8275 (Proxy) Qualcomm® QCS8275 (Proxy) TFLITE 13.742 ms 2 - 14 MB NPU QuickSRNetLarge.tflite
QuickSRNetLarge w8a8 QCS8275 (Proxy) Qualcomm® QCS8275 (Proxy) QNN 11.495 ms 0 - 9 MB NPU Use Export Script
QuickSRNetLarge w8a8 QCS8450 (Proxy) Qualcomm® QCS8450 (Proxy) TFLITE 2.337 ms 0 - 28 MB NPU QuickSRNetLarge.tflite
QuickSRNetLarge w8a8 QCS8450 (Proxy) Qualcomm® QCS8450 (Proxy) QNN 0.879 ms 0 - 21 MB NPU Use Export Script
QuickSRNetLarge w8a8 QCS8550 (Proxy) Qualcomm® QCS8550 (Proxy) TFLITE 1.429 ms 0 - 6 MB NPU QuickSRNetLarge.tflite
QuickSRNetLarge w8a8 QCS8550 (Proxy) Qualcomm® QCS8550 (Proxy) QNN 0.628 ms 0 - 2 MB NPU Use Export Script
QuickSRNetLarge w8a8 QCS9075 (Proxy) Qualcomm® QCS9075 (Proxy) TFLITE 2.218 ms 0 - 15 MB NPU QuickSRNetLarge.tflite
QuickSRNetLarge w8a8 QCS9075 (Proxy) Qualcomm® QCS9075 (Proxy) QNN 0.818 ms 0 - 12 MB NPU Use Export Script
QuickSRNetLarge w8a8 RB3 Gen 2 (Proxy) Qualcomm® QCS6490 (Proxy) TFLITE 4.186 ms 2 - 18 MB NPU QuickSRNetLarge.tflite
QuickSRNetLarge w8a8 RB3 Gen 2 (Proxy) Qualcomm® QCS6490 (Proxy) QNN 3.057 ms 0 - 14 MB NPU Use Export Script
QuickSRNetLarge w8a8 RB5 (Proxy) Qualcomm® QCS8250 (Proxy) TFLITE 38.894 ms 2 - 4 MB NPU QuickSRNetLarge.tflite
QuickSRNetLarge w8a8 SA7255P ADP Qualcomm® SA7255P TFLITE 13.742 ms 2 - 14 MB NPU QuickSRNetLarge.tflite
QuickSRNetLarge w8a8 SA7255P ADP Qualcomm® SA7255P QNN 11.495 ms 0 - 9 MB NPU Use Export Script
QuickSRNetLarge w8a8 SA8255 (Proxy) Qualcomm® SA8255P (Proxy) TFLITE 1.484 ms 0 - 3 MB NPU QuickSRNetLarge.tflite
QuickSRNetLarge w8a8 SA8255 (Proxy) Qualcomm® SA8255P (Proxy) QNN 0.638 ms 0 - 4 MB NPU Use Export Script
QuickSRNetLarge w8a8 SA8295P ADP Qualcomm® SA8295P TFLITE 2.99 ms 0 - 15 MB NPU QuickSRNetLarge.tflite
QuickSRNetLarge w8a8 SA8295P ADP Qualcomm® SA8295P QNN 1.328 ms 0 - 17 MB NPU Use Export Script
QuickSRNetLarge w8a8 SA8650 (Proxy) Qualcomm® SA8650P (Proxy) TFLITE 1.426 ms 0 - 6 MB NPU QuickSRNetLarge.tflite
QuickSRNetLarge w8a8 SA8650 (Proxy) Qualcomm® SA8650P (Proxy) QNN 0.615 ms 0 - 2 MB NPU Use Export Script
QuickSRNetLarge w8a8 SA8775P ADP Qualcomm® SA8775P TFLITE 2.218 ms 0 - 15 MB NPU QuickSRNetLarge.tflite
QuickSRNetLarge w8a8 SA8775P ADP Qualcomm® SA8775P QNN 0.818 ms 0 - 12 MB NPU Use Export Script
QuickSRNetLarge w8a8 Samsung Galaxy S23 Snapdragon® 8 Gen 2 Mobile TFLITE 1.416 ms 0 - 4 MB NPU QuickSRNetLarge.tflite
QuickSRNetLarge w8a8 Samsung Galaxy S23 Snapdragon® 8 Gen 2 Mobile QNN 0.617 ms 0 - 7 MB NPU Use Export Script
QuickSRNetLarge w8a8 Samsung Galaxy S23 Snapdragon® 8 Gen 2 Mobile ONNX 15.349 ms 18 - 29 MB NPU QuickSRNetLarge.onnx
QuickSRNetLarge w8a8 Samsung Galaxy S24 Snapdragon® 8 Gen 3 Mobile TFLITE 1.095 ms 0 - 25 MB NPU QuickSRNetLarge.tflite
QuickSRNetLarge w8a8 Samsung Galaxy S24 Snapdragon® 8 Gen 3 Mobile QNN 0.398 ms 0 - 24 MB NPU Use Export Script
QuickSRNetLarge w8a8 Samsung Galaxy S24 Snapdragon® 8 Gen 3 Mobile ONNX 11.758 ms 24 - 51 MB NPU QuickSRNetLarge.onnx
QuickSRNetLarge w8a8 Snapdragon 8 Elite QRD Snapdragon® 8 Elite Mobile TFLITE 1.302 ms 0 - 22 MB NPU QuickSRNetLarge.tflite
QuickSRNetLarge w8a8 Snapdragon 8 Elite QRD Snapdragon® 8 Elite Mobile QNN 0.413 ms 0 - 19 MB NPU Use Export Script
QuickSRNetLarge w8a8 Snapdragon 8 Elite QRD Snapdragon® 8 Elite Mobile ONNX 10.81 ms 20 - 44 MB NPU QuickSRNetLarge.onnx
QuickSRNetLarge w8a8 Snapdragon X Elite CRD Snapdragon® X Elite QNN 0.718 ms 0 - 0 MB NPU Use Export Script
QuickSRNetLarge w8a8 Snapdragon X Elite CRD Snapdragon® X Elite ONNX 13.648 ms 33 - 33 MB NPU QuickSRNetLarge.onnx

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.quicksrnetlarge.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.quicksrnetlarge.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.quicksrnetlarge.export
Profiling Results
------------------------------------------------------------
QuickSRNetLarge
Device                          : cs_8275 (ANDROID 14)                
Runtime                         : TFLITE                              
Estimated inference time (ms)   : 90.3                                
Estimated peak memory usage (MB): [6, 19]                             
Total # Ops                     : 31                                  
Compute Unit(s)                 : npu (28 ops) gpu (0 ops) cpu (3 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.quicksrnetlarge 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.quicksrnetlarge.demo --eval-mode 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.quicksrnetlarge.demo -- --eval-mode 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 QuickSRNetLarge's performance across various devices here. Explore all available models on Qualcomm® AI Hub

License

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

References

Community