--- library_name: pytorch license: other pipeline_tag: image-to-image tags: - android --- ![](https://qaihub-public-assets.s3.us-west-2.amazonaws.com/qai-hub-models/models/xlsr/web-assets/model_demo.png) # XLSR: Optimized for Mobile Deployment ## Upscale images in real time XLSR is designed for lightweight real-time upscaling of images. This model is an implementation of XLSR found [here](https://github.com/quic/aimet-model-zoo/tree/develop/aimet_zoo_torch/xlsr). This repository provides scripts to run XLSR on Qualcomm® devices. More details on model performance across various devices, can be found [here](https://aihub.qualcomm.com/models/xlsr). ### Model Details - **Model Type:** Super resolution - **Model Stats:** - Model checkpoint: xlsr_3x_checkpoint - Input resolution: 128x128 - Number of parameters: 22.0K - Model size: 92.7 KB | Model | Device | Chipset | Target Runtime | Inference Time (ms) | Peak Memory Range (MB) | Precision | Primary Compute Unit | Target Model |---|---|---|---|---|---|---|---|---| | XLSR | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 | TFLITE | 2.476 ms | 1 - 9 MB | FP16 | NPU | [XLSR.tflite](https://huggingface.co/qualcomm/XLSR/blob/main/XLSR.tflite) | | XLSR | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 | QNN | 1.36 ms | 0 - 65 MB | FP16 | NPU | [XLSR.so](https://huggingface.co/qualcomm/XLSR/blob/main/XLSR.so) | | XLSR | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 | ONNX | 1.504 ms | 0 - 1 MB | FP16 | NPU | [XLSR.onnx](https://huggingface.co/qualcomm/XLSR/blob/main/XLSR.onnx) | | XLSR | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 | TFLITE | 1.692 ms | 0 - 24 MB | FP16 | NPU | [XLSR.tflite](https://huggingface.co/qualcomm/XLSR/blob/main/XLSR.tflite) | | XLSR | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 | QNN | 0.827 ms | 0 - 10 MB | FP16 | NPU | [XLSR.so](https://huggingface.co/qualcomm/XLSR/blob/main/XLSR.so) | | XLSR | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 | ONNX | 1.044 ms | 0 - 23 MB | FP16 | NPU | [XLSR.onnx](https://huggingface.co/qualcomm/XLSR/blob/main/XLSR.onnx) | | XLSR | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite | TFLITE | 1.553 ms | 0 - 16 MB | FP16 | NPU | [XLSR.tflite](https://huggingface.co/qualcomm/XLSR/blob/main/XLSR.tflite) | | XLSR | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite | QNN | 0.792 ms | 0 - 9 MB | FP16 | NPU | Use Export Script | | XLSR | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite | ONNX | 1.067 ms | 0 - 14 MB | FP16 | NPU | [XLSR.onnx](https://huggingface.co/qualcomm/XLSR/blob/main/XLSR.onnx) | | XLSR | QCS8550 (Proxy) | QCS8550 Proxy | TFLITE | 2.538 ms | 0 - 8 MB | FP16 | NPU | [XLSR.tflite](https://huggingface.co/qualcomm/XLSR/blob/main/XLSR.tflite) | | XLSR | QCS8550 (Proxy) | QCS8550 Proxy | QNN | 1.339 ms | 0 - 2 MB | FP16 | NPU | Use Export Script | | XLSR | SA8255 (Proxy) | SA8255P Proxy | TFLITE | 2.515 ms | 0 - 8 MB | FP16 | NPU | [XLSR.tflite](https://huggingface.co/qualcomm/XLSR/blob/main/XLSR.tflite) | | XLSR | SA8255 (Proxy) | SA8255P Proxy | QNN | 1.332 ms | 0 - 1 MB | FP16 | NPU | Use Export Script | | XLSR | SA8775 (Proxy) | SA8775P Proxy | TFLITE | 2.607 ms | 0 - 1 MB | FP16 | NPU | [XLSR.tflite](https://huggingface.co/qualcomm/XLSR/blob/main/XLSR.tflite) | | XLSR | SA8775 (Proxy) | SA8775P Proxy | QNN | 1.353 ms | 0 - 1 MB | FP16 | NPU | Use Export Script | | XLSR | SA8650 (Proxy) | SA8650P Proxy | TFLITE | 2.586 ms | 0 - 9 MB | FP16 | NPU | [XLSR.tflite](https://huggingface.co/qualcomm/XLSR/blob/main/XLSR.tflite) | | XLSR | SA8650 (Proxy) | SA8650P Proxy | QNN | 1.355 ms | 0 - 1 MB | FP16 | NPU | Use Export Script | | XLSR | SA8295P ADP | SA8295P | TFLITE | 3.916 ms | 6 - 21 MB | FP16 | NPU | [XLSR.tflite](https://huggingface.co/qualcomm/XLSR/blob/main/XLSR.tflite) | | XLSR | SA8295P ADP | SA8295P | QNN | 2.328 ms | 0 - 6 MB | FP16 | NPU | Use Export Script | | XLSR | QCS8450 (Proxy) | QCS8450 Proxy | TFLITE | 3.326 ms | 6 - 31 MB | FP16 | NPU | [XLSR.tflite](https://huggingface.co/qualcomm/XLSR/blob/main/XLSR.tflite) | | XLSR | QCS8450 (Proxy) | QCS8450 Proxy | QNN | 1.553 ms | 0 - 14 MB | FP16 | NPU | Use Export Script | | XLSR | Snapdragon X Elite CRD | Snapdragon® X Elite | QNN | 1.523 ms | 0 - 0 MB | FP16 | NPU | Use Export Script | | XLSR | Snapdragon X Elite CRD | Snapdragon® X Elite | ONNX | 1.535 ms | 8 - 8 MB | FP16 | NPU | [XLSR.onnx](https://huggingface.co/qualcomm/XLSR/blob/main/XLSR.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.xlsr.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.xlsr.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.xlsr.export ``` ``` Profiling Results ------------------------------------------------------------ XLSR Device : Samsung Galaxy S23 (13) Runtime : TFLITE Estimated inference time (ms) : 2.5 Estimated peak memory usage (MB): [1, 9] Total # Ops : 16 Compute Unit(s) : NPU (13 ops) CPU (3 ops) ``` ## How does this work? This [export script](https://aihub.qualcomm.com/models/xlsr/qai_hub_models/models/XLSR/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.xlsr 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.xlsr.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.xlsr.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 XLSR's performance across various devices [here](https://aihub.qualcomm.com/models/xlsr). Explore all available models on [Qualcomm® AI Hub](https://aihub.qualcomm.com/) ## License * The license for the original implementation of XLSR can be found [here](https://github.com/quic/aimet-model-zoo/blob/develop/LICENSE.pdf). * 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 * [Extremely Lightweight Quantization Robust Real-Time Single-Image Super Resolution for Mobile Devices](https://arxiv.org/abs/2105.10288) * [Source Model Implementation](https://github.com/quic/aimet-model-zoo/tree/develop/aimet_zoo_torch/xlsr) ## 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).