Hugging Face's logo

qualcomm
/
Yolo-v6

Object Detection
PyTorch
TF Lite
ONNX
real_time
android
Model card Files Community
Yolo-v6 / README.md
qaihm-bot's picture
qaihm-bot
Upload README.md with huggingface_hub
a0c802e verified
preview code
|
raw
history blame
10.3 kB
metadata
library_name: pytorch
license: gpl-3.0
pipeline_tag: object-detection
tags:
  - real_time
  - android

Yolo-v6: Optimized for Mobile Deployment

Real-time object detection optimized for mobile and edge

YoloV6 is a machine learning model that predicts bounding boxes and classes of objects in an image.

This model is an implementation of Yolo-v6 found here.

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

Model Details

  • Model Type: Object detection
  • Model Stats:
    • Model checkpoint: YoloV6-N
    • Input resolution: 640x640
    • Number of parameters: 4.68M
    • Model size: 17.9 MB
Model Device Chipset Target Runtime Inference Time (ms) Peak Memory Range (MB) Precision Primary Compute Unit Target Model
Yolo-v6 Samsung Galaxy S23 Snapdragon® 8 Gen 2 TFLITE 6.034 ms 0 - 4 MB FP16 NPU Yolo-v6.tflite
Yolo-v6 Samsung Galaxy S23 Snapdragon® 8 Gen 2 QNN 5.227 ms 6 - 17 MB FP16 NPU Yolo-v6.so
Yolo-v6 Samsung Galaxy S23 Snapdragon® 8 Gen 2 ONNX 6.073 ms 0 - 10 MB FP16 NPU Yolo-v6.onnx
Yolo-v6 Samsung Galaxy S24 Snapdragon® 8 Gen 3 TFLITE 4.172 ms 0 - 95 MB FP16 NPU Yolo-v6.tflite
Yolo-v6 Samsung Galaxy S24 Snapdragon® 8 Gen 3 QNN 3.743 ms 5 - 51 MB FP16 NPU Yolo-v6.so
Yolo-v6 Samsung Galaxy S24 Snapdragon® 8 Gen 3 ONNX 4.209 ms 5 - 113 MB FP16 NPU Yolo-v6.onnx
Yolo-v6 Snapdragon 8 Elite QRD Snapdragon® 8 Elite TFLITE 4.342 ms 0 - 58 MB FP16 NPU Yolo-v6.tflite
Yolo-v6 Snapdragon 8 Elite QRD Snapdragon® 8 Elite QNN 4.056 ms 5 - 48 MB FP16 NPU Use Export Script
Yolo-v6 Snapdragon 8 Elite QRD Snapdragon® 8 Elite ONNX 3.474 ms 0 - 66 MB FP16 NPU Yolo-v6.onnx
Yolo-v6 QCS8550 (Proxy) QCS8550 Proxy TFLITE 5.902 ms 0 - 213 MB FP16 NPU Yolo-v6.tflite
Yolo-v6 QCS8550 (Proxy) QCS8550 Proxy QNN 5.339 ms 5 - 6 MB FP16 NPU Use Export Script
Yolo-v6 SA8255 (Proxy) SA8255P Proxy TFLITE 6.069 ms 0 - 3 MB FP16 NPU Yolo-v6.tflite
Yolo-v6 SA8255 (Proxy) SA8255P Proxy QNN 5.406 ms 5 - 7 MB FP16 NPU Use Export Script
Yolo-v6 SA8775 (Proxy) SA8775P Proxy TFLITE 5.986 ms 0 - 15 MB FP16 NPU Yolo-v6.tflite
Yolo-v6 SA8775 (Proxy) SA8775P Proxy QNN 5.345 ms 5 - 6 MB FP16 NPU Use Export Script
Yolo-v6 SA8650 (Proxy) SA8650P Proxy TFLITE 6.12 ms 0 - 4 MB FP16 NPU Yolo-v6.tflite
Yolo-v6 SA8650 (Proxy) SA8650P Proxy QNN 5.361 ms 5 - 6 MB FP16 NPU Use Export Script
Yolo-v6 SA8295P ADP SA8295P TFLITE 8.304 ms 0 - 43 MB FP16 NPU Yolo-v6.tflite
Yolo-v6 SA8295P ADP SA8295P QNN 7.733 ms 0 - 5 MB FP16 NPU Use Export Script
Yolo-v6 QCS8450 (Proxy) QCS8450 Proxy TFLITE 7.226 ms 0 - 74 MB FP16 NPU Yolo-v6.tflite
Yolo-v6 QCS8450 (Proxy) QCS8450 Proxy QNN 6.927 ms 5 - 37 MB FP16 NPU Use Export Script
Yolo-v6 Snapdragon X Elite CRD Snapdragon® X Elite QNN 5.767 ms 5 - 5 MB FP16 NPU Use Export Script
Yolo-v6 Snapdragon X Elite CRD Snapdragon® X Elite ONNX 6.386 ms 8 - 8 MB FP16 NPU Yolo-v6.onnx

Installation

This model can be installed as a Python 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.yolov6.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.yolov6.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.yolov6.export

Profiling Results
------------------------------------------------------------
Yolo-v6
Device                          : Samsung Galaxy S23 (13)
Runtime                         : TFLITE                 
Estimated inference time (ms)   : 6.0                    
Estimated peak memory usage (MB): [0, 4]                 
Total # Ops                     : 182                    
Compute Unit(s)                 : NPU (182 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.yolov6 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.

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.yolov6.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.yolov6.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 Yolo-v6's performance across various devices here. Explore all available models on Qualcomm® AI Hub

License

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

References

Community