--- library_name: pytorch license: apache-2.0 pipeline_tag: image-to-image tags: - android --- ![](https://qaihub-public-assets.s3.us-west-2.amazonaws.com/qai-hub-models/models/esrgan/web-assets/model_demo.png) # ESRGAN: Optimized for Mobile Deployment ## Upscale images and remove image noise ESRGAN is a machine learning model that upscales an image with minimal loss in quality. This model is an implementation of ESRGAN found [here](https://github.com/xinntao/ESRGAN/). This repository provides scripts to run ESRGAN on Qualcomm® devices. More details on model performance across various devices, can be found [here](https://aihub.qualcomm.com/models/esrgan). ### Model Details - **Model Type:** Super resolution - **Model Stats:** - Model checkpoint: ESRGAN_x4 - Input resolution: 128x128 - Number of parameters: 16.7M - Model size: 64.0 MB | Model | Device | Chipset | Target Runtime | Inference Time (ms) | Peak Memory Range (MB) | Precision | Primary Compute Unit | Target Model |---|---|---|---|---|---|---|---|---| | ESRGAN | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 | TFLITE | 65.917 ms | 3 - 6 MB | FP16 | NPU | [ESRGAN.tflite](https://huggingface.co/qualcomm/ESRGAN/blob/main/ESRGAN.tflite) | | ESRGAN | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 | QNN | 70.267 ms | 0 - 215 MB | FP16 | NPU | [ESRGAN.so](https://huggingface.co/qualcomm/ESRGAN/blob/main/ESRGAN.so) | | ESRGAN | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 | ONNX | 71.498 ms | 0 - 42 MB | FP16 | NPU | [ESRGAN.onnx](https://huggingface.co/qualcomm/ESRGAN/blob/main/ESRGAN.onnx) | | ESRGAN | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 | TFLITE | 48.914 ms | 3 - 662 MB | FP16 | NPU | [ESRGAN.tflite](https://huggingface.co/qualcomm/ESRGAN/blob/main/ESRGAN.tflite) | | ESRGAN | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 | QNN | 50.782 ms | 0 - 108 MB | FP16 | NPU | [ESRGAN.so](https://huggingface.co/qualcomm/ESRGAN/blob/main/ESRGAN.so) | | ESRGAN | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 | ONNX | 52.531 ms | 6 - 696 MB | FP16 | NPU | [ESRGAN.onnx](https://huggingface.co/qualcomm/ESRGAN/blob/main/ESRGAN.onnx) | | ESRGAN | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite | TFLITE | 37.71 ms | 3 - 183 MB | FP16 | NPU | [ESRGAN.tflite](https://huggingface.co/qualcomm/ESRGAN/blob/main/ESRGAN.tflite) | | ESRGAN | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite | QNN | 42.47 ms | 0 - 128 MB | FP16 | NPU | Use Export Script | | ESRGAN | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite | ONNX | 43.058 ms | 6 - 183 MB | FP16 | NPU | [ESRGAN.onnx](https://huggingface.co/qualcomm/ESRGAN/blob/main/ESRGAN.onnx) | | ESRGAN | QCS8550 (Proxy) | QCS8550 Proxy | TFLITE | 63.196 ms | 3 - 6 MB | FP16 | NPU | [ESRGAN.tflite](https://huggingface.co/qualcomm/ESRGAN/blob/main/ESRGAN.tflite) | | ESRGAN | QCS8550 (Proxy) | QCS8550 Proxy | QNN | 64.385 ms | 0 - 2 MB | FP16 | NPU | Use Export Script | | ESRGAN | SA8255 (Proxy) | SA8255P Proxy | TFLITE | 67.89 ms | 3 - 5 MB | FP16 | NPU | [ESRGAN.tflite](https://huggingface.co/qualcomm/ESRGAN/blob/main/ESRGAN.tflite) | | ESRGAN | SA8255 (Proxy) | SA8255P Proxy | QNN | 62.524 ms | 0 - 2 MB | FP16 | NPU | Use Export Script | | ESRGAN | SA8775 (Proxy) | SA8775P Proxy | TFLITE | 71.251 ms | 3 - 6 MB | FP16 | NPU | [ESRGAN.tflite](https://huggingface.co/qualcomm/ESRGAN/blob/main/ESRGAN.tflite) | | ESRGAN | SA8775 (Proxy) | SA8775P Proxy | QNN | 63.428 ms | 0 - 1 MB | FP16 | NPU | Use Export Script | | ESRGAN | SA8650 (Proxy) | SA8650P Proxy | TFLITE | 65.346 ms | 3 - 5 MB | FP16 | NPU | [ESRGAN.tflite](https://huggingface.co/qualcomm/ESRGAN/blob/main/ESRGAN.tflite) | | ESRGAN | SA8650 (Proxy) | SA8650P Proxy | QNN | 63.333 ms | 0 - 2 MB | FP16 | NPU | Use Export Script | | ESRGAN | SA8295P ADP | SA8295P | TFLITE | 112.057 ms | 3 - 170 MB | FP16 | NPU | [ESRGAN.tflite](https://huggingface.co/qualcomm/ESRGAN/blob/main/ESRGAN.tflite) | | ESRGAN | SA8295P ADP | SA8295P | QNN | 111.03 ms | 0 - 6 MB | FP16 | NPU | Use Export Script | | ESRGAN | QCS8450 (Proxy) | QCS8450 Proxy | TFLITE | 157.613 ms | 0 - 618 MB | FP16 | NPU | [ESRGAN.tflite](https://huggingface.co/qualcomm/ESRGAN/blob/main/ESRGAN.tflite) | | ESRGAN | QCS8450 (Proxy) | QCS8450 Proxy | QNN | 128.296 ms | 0 - 85 MB | FP16 | NPU | Use Export Script | | ESRGAN | Snapdragon X Elite CRD | Snapdragon® X Elite | QNN | 64.877 ms | 0 - 0 MB | FP16 | NPU | Use Export Script | | ESRGAN | Snapdragon X Elite CRD | Snapdragon® X Elite | ONNX | 65.632 ms | 39 - 39 MB | FP16 | NPU | [ESRGAN.onnx](https://huggingface.co/qualcomm/ESRGAN/blob/main/ESRGAN.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.esrgan.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.esrgan.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.esrgan.export ``` ``` Profiling Results ------------------------------------------------------------ ESRGAN Device : Samsung Galaxy S23 (13) Runtime : TFLITE Estimated inference time (ms) : 65.9 Estimated peak memory usage (MB): [3, 6] Total # Ops : 1024 Compute Unit(s) : NPU (1024 ops) ``` ## How does this work? This [export script](https://aihub.qualcomm.com/models/esrgan/qai_hub_models/models/ESRGAN/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.esrgan 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.esrgan.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.esrgan.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 ESRGAN's performance across various devices [here](https://aihub.qualcomm.com/models/esrgan). Explore all available models on [Qualcomm® AI Hub](https://aihub.qualcomm.com/) ## License * The license for the original implementation of ESRGAN can be found [here](https://github.com/xinntao/ESRGAN/blob/master/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 * [ESRGAN: Enhanced Super-Resolution Generative Adversarial Networks](https://arxiv.org/abs/1809.00219) * [Source Model Implementation](https://github.com/xinntao/ESRGAN/) ## 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:ai-hub-support@qti.qualcomm.com).