Upload README.md with huggingface_hub

README.md

@@ -18,7 +18,7 @@ tags:
 
 ShufflenetV2 is a machine learning model that can classify images from the Imagenet dataset. It can also be used as a backbone in building more complex models for specific use cases.
 
-This model is an implementation of Shufflenet-v2Quantized found [here](https://github.com/pytorch/vision/blob/main/torchvision/models/shufflenetv2.py).
+This model is an implementation of Shufflenet-v2Quantized found [here]({source_repo}).
 This repository provides scripts to run Shufflenet-v2Quantized on Qualcomm® devices.
 More details on model performance across various devices, can be found
 [here](https://aihub.qualcomm.com/models/shufflenet_v2_quantized).
@@ -33,26 +33,43 @@ More details on model performance across various devices, can be found
   - Number of parameters: 1.37M
   - Model size: 4.42 MB
 
+| Model | Device | Chipset | Target Runtime | Inference Time (ms) | Peak Memory Range (MB) | Precision | Primary Compute Unit | Target Model
+|---|---|---|---|---|---|---|---|---|
+| Shufflenet-v2Quantized | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 | TFLITE | 0.615 ms | 0 - 1 MB | INT8 | NPU | [Shufflenet-v2Quantized.tflite](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.tflite) |
+| Shufflenet-v2Quantized | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 | QNN | 0.601 ms | 0 - 32 MB | INT8 | NPU | [Shufflenet-v2Quantized.so](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.so) |
+| Shufflenet-v2Quantized | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 | ONNX | 8.856 ms | 2 - 6 MB | INT8 | NPU | [Shufflenet-v2Quantized.onnx](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.onnx) |
+| Shufflenet-v2Quantized | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 | TFLITE | 0.423 ms | 0 - 28 MB | INT8 | NPU | [Shufflenet-v2Quantized.tflite](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.tflite) |
+| Shufflenet-v2Quantized | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 | QNN | 0.438 ms | 0 - 13 MB | INT8 | NPU | [Shufflenet-v2Quantized.so](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.so) |
+| Shufflenet-v2Quantized | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 | ONNX | 7.974 ms | 1 - 340 MB | INT8 | NPU | [Shufflenet-v2Quantized.onnx](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.onnx) |
+| Shufflenet-v2Quantized | RB3 Gen 2 (Proxy) | QCS6490 Proxy | TFLITE | 0.892 ms | 0 - 21 MB | INT8 | NPU | [Shufflenet-v2Quantized.tflite](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.tflite) |
+| Shufflenet-v2Quantized | RB3 Gen 2 (Proxy) | QCS6490 Proxy | QNN | 1.21 ms | 0 - 8 MB | INT8 | NPU | Use Export Script |
+| Shufflenet-v2Quantized | RB5 (Proxy) | QCS8250 Proxy | TFLITE | 10.608 ms | 0 - 13 MB | FP32 | CPU | [Shufflenet-v2Quantized.tflite](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.tflite) |
+| Shufflenet-v2Quantized | QCS8550 (Proxy) | QCS8550 Proxy | TFLITE | 0.614 ms | 0 - 7 MB | INT8 | NPU | [Shufflenet-v2Quantized.tflite](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.tflite) |
+| Shufflenet-v2Quantized | QCS8550 (Proxy) | QCS8550 Proxy | QNN | 0.546 ms | 0 - 1 MB | INT8 | NPU | Use Export Script |
+| Shufflenet-v2Quantized | SA8255 (Proxy) | SA8255P Proxy | TFLITE | 0.611 ms | 0 - 2 MB | INT8 | NPU | [Shufflenet-v2Quantized.tflite](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.tflite) |
+| Shufflenet-v2Quantized | SA8255 (Proxy) | SA8255P Proxy | QNN | 0.544 ms | 0 - 1 MB | INT8 | NPU | Use Export Script |
+| Shufflenet-v2Quantized | SA8775 (Proxy) | SA8775P Proxy | TFLITE | 0.616 ms | 0 - 2 MB | INT8 | NPU | [Shufflenet-v2Quantized.tflite](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.tflite) |
+| Shufflenet-v2Quantized | SA8775 (Proxy) | SA8775P Proxy | QNN | 0.566 ms | 0 - 2 MB | INT8 | NPU | Use Export Script |
+| Shufflenet-v2Quantized | QCS8450 (Proxy) | QCS8450 Proxy | TFLITE | 0.645 ms | 0 - 29 MB | INT8 | NPU | [Shufflenet-v2Quantized.tflite](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.tflite) |
+| Shufflenet-v2Quantized | QCS8450 (Proxy) | QCS8450 Proxy | QNN | 0.649 ms | 0 - 14 MB | INT8 | NPU | Use Export Script |
+| Shufflenet-v2Quantized | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite | TFLITE | 0.466 ms | 0 - 20 MB | INT8 | NPU | [Shufflenet-v2Quantized.tflite](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.tflite) |
+| Shufflenet-v2Quantized | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite | QNN | 0.382 ms | 0 - 10 MB | INT8 | NPU | Use Export Script |
+| Shufflenet-v2Quantized | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite | ONNX | 6.292 ms | 0 - 274 MB | INT8 | NPU | [Shufflenet-v2Quantized.onnx](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.onnx) |
+| Shufflenet-v2Quantized | Snapdragon X Elite CRD | Snapdragon® X Elite | QNN | 0.681 ms | 1 - 1 MB | INT8 | NPU | Use Export Script |
+| Shufflenet-v2Quantized | Snapdragon X Elite CRD | Snapdragon® X Elite | ONNX | 10.337 ms | 6 - 6 MB | INT8 | NPU | [Shufflenet-v2Quantized.onnx](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.onnx) |
 
 
 
-| Device | Chipset | Target Runtime | Inference Time (ms) | Peak Memory Range (MB) | Precision | Primary Compute Unit | Target Model
-| ---|---|---|---|---|---|---|---|
-| Samsung Galaxy S23 Ultra (Android 13) | Snapdragon® 8 Gen 2 | TFLite | 0.61 ms | 0 - 2 MB | INT8 | NPU |  [Shufflenet-v2Quantized.tflite](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.tflite) 
-| Samsung Galaxy S23 Ultra (Android 13) | Snapdragon® 8 Gen 2 | QNN Model Library | 0.589 ms | 0 - 72 MB | INT8 | NPU |  [Shufflenet-v2Quantized.so](https://huggingface.co/qualcomm/Shufflenet-v2Quantized/blob/main/Shufflenet-v2Quantized.so) 
-
-
 
 ## Installation
 
 This model can be installed as a Python package via pip.
 
 ```bash
-pip install "qai-hub-models[shufflenet_v2_quantized]"
+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
@@ -97,18 +114,78 @@ device. This script does the following:
 ```bash
 python -m qai_hub_models.models.shufflenet_v2_quantized.export
 ```
+```
+Profiling Results
+------------------------------------------------------------
+Shufflenet-v2Quantized
+Device                          : Samsung Galaxy S23 (13)
+Runtime                         : TFLITE                 
+Estimated inference time (ms)   : 0.6                    
+Estimated peak memory usage (MB): [0, 1]                 
+Total # Ops                     : 233                    
+Compute Unit(s)                 : NPU (233 ops)          
+```
+
+
+## How does this work?
+
+This [export script](https://aihub.qualcomm.com/models/shufflenet_v2_quantized/qai_hub_models/models/Shufflenet-v2Quantized/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.shufflenet_v2_quantized 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,
+)
+        
 ```
-Profile Job summary of Shufflenet-v2Quantized
---------------------------------------------------
-Device: Snapdragon X Elite CRD (11)
-Estimated Inference Time: 0.66 ms
-Estimated Peak Memory Range: 0.51-0.51 MB
-Compute Units: NPU (122) | Total (122)
 
+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).
 
 
 
@@ -145,15 +222,19 @@ provides instructions on how to use the `.so` shared library  in an Android appl
 Get more details on Shufflenet-v2Quantized's performance across various devices [here](https://aihub.qualcomm.com/models/shufflenet_v2_quantized).
 Explore all available models on [Qualcomm® AI Hub](https://aihub.qualcomm.com/)
 
+
 ## License
-- The license for the original implementation of Shufflenet-v2Quantized can be found
-  [here](https://github.com/pytorch/vision/blob/main/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)
+* The license for the original implementation of Shufflenet-v2Quantized can be found [here](https://github.com/pytorch/vision/blob/main/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
 * [ShuffleNet V2: Practical Guidelines for Efficient CNN Architecture Design](https://arxiv.org/abs/1807.11164)
 * [Source Model Implementation](https://github.com/pytorch/vision/blob/main/torchvision/models/shufflenetv2.py)
 
+
+
 ## 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).