Hugging Face's logo

qualcomm
/
FFNet-54S

Image Segmentation
PyTorch
android
Model card Files
xet
 Community
FFNet-54S / README.md
qaihm-bot's picture
qaihm-bot
Upload README.md with huggingface_hub
f80b25d verified
preview code
|
raw
history blame
15.9 kB
metadata 
library_name: pytorch
license: other
tags:
  - android
pipeline_tag: image-segmentation

FFNet-54S: Optimized for Mobile Deployment

Semantic segmentation for automotive street scenes

FFNet-54S is a "fuss-free network" that segments street scene images with per-pixel classes like road, sidewalk, and pedestrian. Trained on the Cityscapes dataset.

This model is an implementation of FFNet-54S found here.

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

Model Details

  • Model Type: Model_use_case.semantic_segmentation
  • Model Stats:
    • Model checkpoint: ffnet54S_dBBB_cityscapes_state_dict_quarts
    • Input resolution: 2048x1024
    • Number of parameters: 18.0M
    • Number of output classes: 19
    • Model size (float): 68.8 MB
    • Model size (w8a8): 17.5 MB
Model Precision Device Chipset Target Runtime Inference Time (ms) Peak Memory Range (MB) Primary Compute Unit Target Model
FFNet-54S float QCS8275 (Proxy) Qualcomm® QCS8275 (Proxy) TFLITE 169.866 ms 0 - 57 MB NPU FFNet-54S.tflite
FFNet-54S float QCS8275 (Proxy) Qualcomm® QCS8275 (Proxy) QNN 152.83 ms 24 - 34 MB NPU Use Export Script
FFNet-54S float QCS8450 (Proxy) Qualcomm® QCS8450 (Proxy) TFLITE 60.574 ms 2 - 93 MB NPU FFNet-54S.tflite
FFNet-54S float QCS8450 (Proxy) Qualcomm® QCS8450 (Proxy) QNN 72.64 ms 23 - 74 MB NPU Use Export Script
FFNet-54S float QCS8550 (Proxy) Qualcomm® QCS8550 (Proxy) TFLITE 45.847 ms 2 - 26 MB NPU FFNet-54S.tflite
FFNet-54S float QCS8550 (Proxy) Qualcomm® QCS8550 (Proxy) QNN 36.177 ms 24 - 28 MB NPU Use Export Script
FFNet-54S float QCS9075 (Proxy) Qualcomm® QCS9075 (Proxy) TFLITE 62.049 ms 2 - 60 MB NPU FFNet-54S.tflite
FFNet-54S float QCS9075 (Proxy) Qualcomm® QCS9075 (Proxy) QNN 51.997 ms 24 - 36 MB NPU Use Export Script
FFNet-54S float SA7255P ADP Qualcomm® SA7255P TFLITE 169.866 ms 0 - 57 MB NPU FFNet-54S.tflite
FFNet-54S float SA7255P ADP Qualcomm® SA7255P QNN 152.83 ms 24 - 34 MB NPU Use Export Script
FFNet-54S float SA8255 (Proxy) Qualcomm® SA8255P (Proxy) TFLITE 45.87 ms 2 - 23 MB NPU FFNet-54S.tflite
FFNet-54S float SA8255 (Proxy) Qualcomm® SA8255P (Proxy) QNN 36.813 ms 24 - 26 MB NPU Use Export Script
FFNet-54S float SA8295P ADP Qualcomm® SA8295P TFLITE 69.615 ms 2 - 58 MB NPU FFNet-54S.tflite
FFNet-54S float SA8295P ADP Qualcomm® SA8295P QNN 58.408 ms 24 - 42 MB NPU Use Export Script
FFNet-54S float SA8650 (Proxy) Qualcomm® SA8650P (Proxy) TFLITE 46.195 ms 2 - 25 MB NPU FFNet-54S.tflite
FFNet-54S float SA8650 (Proxy) Qualcomm® SA8650P (Proxy) QNN 36.47 ms 24 - 27 MB NPU Use Export Script
FFNet-54S float SA8775P ADP Qualcomm® SA8775P TFLITE 62.049 ms 2 - 60 MB NPU FFNet-54S.tflite
FFNet-54S float SA8775P ADP Qualcomm® SA8775P QNN 51.997 ms 24 - 36 MB NPU Use Export Script
FFNet-54S float Samsung Galaxy S23 Snapdragon® 8 Gen 2 Mobile TFLITE 45.972 ms 2 - 28 MB NPU FFNet-54S.tflite
FFNet-54S float Samsung Galaxy S23 Snapdragon® 8 Gen 2 Mobile QNN 36.525 ms 24 - 43 MB NPU Use Export Script
FFNet-54S float Samsung Galaxy S23 Snapdragon® 8 Gen 2 Mobile ONNX 37.233 ms 32 - 123 MB NPU FFNet-54S.onnx
FFNet-54S float Samsung Galaxy S24 Snapdragon® 8 Gen 3 Mobile TFLITE 31.012 ms 0 - 90 MB NPU FFNet-54S.tflite
FFNet-54S float Samsung Galaxy S24 Snapdragon® 8 Gen 3 Mobile QNN 25.784 ms 20 - 74 MB NPU Use Export Script
FFNet-54S float Samsung Galaxy S24 Snapdragon® 8 Gen 3 Mobile ONNX 26.402 ms 30 - 86 MB NPU FFNet-54S.onnx
FFNet-54S float Snapdragon 8 Elite QRD Snapdragon® 8 Elite Mobile TFLITE 31.824 ms 1 - 61 MB NPU FFNet-54S.tflite
FFNet-54S float Snapdragon 8 Elite QRD Snapdragon® 8 Elite Mobile QNN 23.989 ms 24 - 84 MB NPU Use Export Script
FFNet-54S float Snapdragon 8 Elite QRD Snapdragon® 8 Elite Mobile ONNX 23.406 ms 28 - 73 MB NPU FFNet-54S.onnx
FFNet-54S float Snapdragon X Elite CRD Snapdragon® X Elite QNN 37.916 ms 24 - 24 MB NPU Use Export Script
FFNet-54S float Snapdragon X Elite CRD Snapdragon® X Elite ONNX 39.025 ms 24 - 24 MB NPU FFNet-54S.onnx
FFNet-54S w8a8 QCS8275 (Proxy) Qualcomm® QCS8275 (Proxy) TFLITE 25.858 ms 1 - 39 MB NPU FFNet-54S.tflite
FFNet-54S w8a8 QCS8450 (Proxy) Qualcomm® QCS8450 (Proxy) TFLITE 11.313 ms 1 - 63 MB NPU FFNet-54S.tflite
FFNet-54S w8a8 QCS8550 (Proxy) Qualcomm® QCS8550 (Proxy) TFLITE 9.514 ms 1 - 16 MB NPU FFNet-54S.tflite
FFNet-54S w8a8 QCS9075 (Proxy) Qualcomm® QCS9075 (Proxy) TFLITE 10.25 ms 1 - 41 MB NPU FFNet-54S.tflite
FFNet-54S w8a8 RB3 Gen 2 (Proxy) Qualcomm® QCS6490 (Proxy) TFLITE 67.338 ms 0 - 61 MB NPU FFNet-54S.tflite
FFNet-54S w8a8 RB5 (Proxy) Qualcomm® QCS8250 (Proxy) TFLITE 319.196 ms 1 - 3 MB NPU FFNet-54S.tflite
FFNet-54S w8a8 SA7255P ADP Qualcomm® SA7255P TFLITE 25.858 ms 1 - 39 MB NPU FFNet-54S.tflite
FFNet-54S w8a8 SA8255 (Proxy) Qualcomm® SA8255P (Proxy) TFLITE 9.52 ms 1 - 15 MB NPU FFNet-54S.tflite
FFNet-54S w8a8 SA8295P ADP Qualcomm® SA8295P TFLITE 14.896 ms 0 - 42 MB NPU FFNet-54S.tflite
FFNet-54S w8a8 SA8650 (Proxy) Qualcomm® SA8650P (Proxy) TFLITE 9.509 ms 1 - 11 MB NPU FFNet-54S.tflite
FFNet-54S w8a8 SA8775P ADP Qualcomm® SA8775P TFLITE 10.25 ms 1 - 41 MB NPU FFNet-54S.tflite
FFNet-54S w8a8 Samsung Galaxy S23 Snapdragon® 8 Gen 2 Mobile TFLITE 9.65 ms 1 - 15 MB NPU FFNet-54S.tflite
FFNet-54S w8a8 Samsung Galaxy S23 Snapdragon® 8 Gen 2 Mobile ONNX 11.494 ms 6 - 47 MB NPU FFNet-54S.onnx
FFNet-54S w8a8 Samsung Galaxy S24 Snapdragon® 8 Gen 3 Mobile TFLITE 6.955 ms 0 - 60 MB NPU FFNet-54S.tflite
FFNet-54S w8a8 Samsung Galaxy S24 Snapdragon® 8 Gen 3 Mobile ONNX 7.429 ms 6 - 77 MB NPU FFNet-54S.onnx
FFNet-54S w8a8 Snapdragon 8 Elite QRD Snapdragon® 8 Elite Mobile TFLITE 6.847 ms 1 - 43 MB NPU FFNet-54S.tflite
FFNet-54S w8a8 Snapdragon 8 Elite QRD Snapdragon® 8 Elite Mobile ONNX 6.594 ms 3 - 61 MB NPU FFNet-54S.onnx
FFNet-54S w8a8 Snapdragon X Elite CRD Snapdragon® X Elite ONNX 14.287 ms 12 - 12 MB NPU FFNet-54S.onnx

Installation

Install the package via pip:

pip install "qai-hub-models[ffnet-54s]"

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.ffnet_54s.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.ffnet_54s.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.ffnet_54s.export

Profiling Results
------------------------------------------------------------
FFNet-54S
Device                          : cs_8275 (ANDROID 14)                 
Runtime                         : TFLITE                               
Estimated inference time (ms)   : 169.9                                
Estimated peak memory usage (MB): [0, 57]                              
Total # Ops                     : 115                                  
Compute Unit(s)                 : npu (115 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.ffnet_54s 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.ffnet_54s.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.ffnet_54s.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 FFNet-54S's performance across various devices here. Explore all available models on Qualcomm® AI Hub

License

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

References

Community