Upload README.md with huggingface_hub

README.md

@@ -16,11 +16,9 @@ tags:
 
 Ultralytics YOLOv8 is a machine learning model that predicts bounding boxes and classes of objects in an image. This model is post-training quantized to int8 using samples from the COCO dataset.
 
-This model is an implementation of YOLOv8-Detection-Quantized found [here](https://github.com/ultralytics/ultralytics/tree/main/ultralytics/models/yolo/detect).
-This repository provides scripts to run YOLOv8-Detection-Quantized on Qualcomm® devices.
-More details on model performance across various devices, can be found
-[here](https://aihub.qualcomm.com/models/yolov8_det_quantized).
-
+This is based on the implementation of YOLOv8-Detection-Quantized found
+[here]({source_repo}). More details on model performance
+accross various devices, can be found [here](https://aihub.qualcomm.com/models/yolov8_det_quantized).
 
 ### Model Details
 
@@ -31,129 +29,69 @@ More details on model performance across various devices, can be found
   - Number of parameters: 3.18M
   - Model size: 3.26 MB
 
+| Model | Device | Chipset | Target Runtime | Inference Time (ms) | Peak Memory Range (MB) | Precision | Primary Compute Unit | Target Model
+|---|---|---|---|---|---|---|---|---|
+| YOLOv8-Detection-Quantized | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 | TFLITE | 1.915 ms | 0 - 1 MB | INT8 | NPU | -- |
+| YOLOv8-Detection-Quantized | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 | QNN | 2.265 ms | 0 - 9 MB | INT8 | NPU | -- |
+| YOLOv8-Detection-Quantized | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 | ONNX | 5.638 ms | 7 - 11 MB | INT8 | NPU | -- |
+| YOLOv8-Detection-Quantized | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 | TFLITE | 1.273 ms | 0 - 57 MB | INT8 | NPU | -- |
+| YOLOv8-Detection-Quantized | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 | QNN | 1.489 ms | 1 - 31 MB | INT8 | NPU | -- |
+| YOLOv8-Detection-Quantized | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 | ONNX | 3.976 ms | 3 - 151 MB | INT8 | NPU | -- |
+| YOLOv8-Detection-Quantized | RB3 Gen 2 (Proxy) | QCS6490 Proxy | TFLITE | 4.734 ms | 0 - 42 MB | INT8 | NPU | -- |
+| YOLOv8-Detection-Quantized | RB3 Gen 2 (Proxy) | QCS6490 Proxy | QNN | 5.781 ms | 1 - 8 MB | INT8 | NPU | -- |
+| YOLOv8-Detection-Quantized | RB5 (Proxy) | QCS8250 Proxy | TFLITE | 46.023 ms | 3 - 16 MB | INT8 | NPU | -- |
+| YOLOv8-Detection-Quantized | QCS8550 (Proxy) | QCS8550 Proxy | TFLITE | 1.891 ms | 0 - 6 MB | INT8 | NPU | -- |
+| YOLOv8-Detection-Quantized | QCS8550 (Proxy) | QCS8550 Proxy | QNN | 1.941 ms | 1 - 2 MB | INT8 | NPU | -- |
+| YOLOv8-Detection-Quantized | SA8255 (Proxy) | SA8255P Proxy | TFLITE | 1.897 ms | 0 - 9 MB | INT8 | NPU | -- |
+| YOLOv8-Detection-Quantized | SA8255 (Proxy) | SA8255P Proxy | QNN | 1.97 ms | 1 - 2 MB | INT8 | NPU | -- |
+| YOLOv8-Detection-Quantized | SA8775 (Proxy) | SA8775P Proxy | TFLITE | 1.919 ms | 0 - 2 MB | INT8 | NPU | -- |
+| YOLOv8-Detection-Quantized | SA8775 (Proxy) | SA8775P Proxy | QNN | 1.953 ms | 5 - 6 MB | INT8 | NPU | -- |
+| YOLOv8-Detection-Quantized | SA8650 (Proxy) | SA8650P Proxy | TFLITE | 1.919 ms | 0 - 3 MB | INT8 | NPU | -- |
+| YOLOv8-Detection-Quantized | SA8650 (Proxy) | SA8650P Proxy | QNN | 1.979 ms | 1 - 2 MB | INT8 | NPU | -- |
+| YOLOv8-Detection-Quantized | QCS8450 (Proxy) | QCS8450 Proxy | TFLITE | 2.091 ms | 0 - 57 MB | INT8 | NPU | -- |
+| YOLOv8-Detection-Quantized | QCS8450 (Proxy) | QCS8450 Proxy | QNN | 2.512 ms | 1 - 33 MB | INT8 | NPU | -- |
+| YOLOv8-Detection-Quantized | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite | TFLITE | 1.206 ms | 0 - 38 MB | INT8 | NPU | -- |
+| YOLOv8-Detection-Quantized | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite | QNN | 1.487 ms | 1 - 27 MB | INT8 | NPU | -- |
+| YOLOv8-Detection-Quantized | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite | ONNX | 3.993 ms | 6 - 122 MB | INT8 | NPU | -- |
+| YOLOv8-Detection-Quantized | Snapdragon X Elite CRD | Snapdragon® X Elite | QNN | 2.263 ms | 1 - 1 MB | INT8 | NPU | -- |
+| YOLOv8-Detection-Quantized | Snapdragon X Elite CRD | Snapdragon® X Elite | ONNX | 6.306 ms | 7 - 7 MB | INT8 | NPU | -- |
 
 
 
-| 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 | 1.913 ms | 0 - 103 MB | INT8 | NPU |  [YOLOv8-Detection-Quantized.tflite](https://huggingface.co/qualcomm/YOLOv8-Detection-Quantized/blob/main/YOLOv8-Detection-Quantized.tflite) 
-| Samsung Galaxy S23 Ultra (Android 13) | Snapdragon® 8 Gen 2 | QNN Model Library | 2.242 ms | 2 - 12 MB | INT8 | NPU | YOLOv8-Detection-Quantized 
-
-
-
-## Installation
-
-This model can be installed as a Python package via pip.
-
-```bash
-pip install "qai-hub-models[yolov8_det_quantized]"
-```
-
-
-
-## 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.yolov8_det_quantized.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.yolov8_det_quantized.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.yolov8_det_quantized.export
-```
-
-```
-Profile Job summary of YOLOv8-Detection-Quantized
---------------------------------------------------
-Device: Snapdragon X Elite CRD (11)
-Estimated Inference Time: 2.22 ms
-Estimated Peak Memory Range: 1.18-1.18 MB
-Compute Units: NPU (273) | Total (273)
-
-
-```
-
-
-
-
-## Run demo on a cloud-hosted device
-
-You can also run the demo on-device.
-
-```bash
-python -m qai_hub_models.models.yolov8_det_quantized.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.yolov8_det_quantized.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.
 
+## License
+* The license for the original implementation of YOLOv8-Detection-Quantized can be found [here](https://github.com/ultralytics/ultralytics/blob/main/LICENSE).
+* The license for the compiled assets for on-device deployment can be found [here](https://github.com/ultralytics/ultralytics/blob/main/LICENSE)
 
-## View on Qualcomm® AI Hub
-Get more details on YOLOv8-Detection-Quantized's performance across various devices [here](https://aihub.qualcomm.com/models/yolov8_det_quantized).
-Explore all available models on [Qualcomm® AI Hub](https://aihub.qualcomm.com/)
 
-## License
-- The license for the original implementation of YOLOv8-Detection-Quantized can be found
-  [here](https://github.com/ultralytics/ultralytics/blob/main/LICENSE).
-- The license for the compiled assets for on-device deployment can be found [here](https://github.com/ultralytics/ultralytics/blob/main/LICENSE)
 
 ## References
 * [Ultralytics YOLOv8 Docs: Object Detection](https://docs.ultralytics.com/tasks/detect/)
 * [Source Model Implementation](https://github.com/ultralytics/ultralytics/tree/main/ultralytics/models/yolo/detect)
 
+
+
 ## Community
-* Join [our AI Hub Slack community](https://aihub.qualcomm.com/community/slack) to collaborate, post questions and learn more about on-device AI.
+* Join [our AI Hub Slack community](https://qualcomm-ai-hub.slack.com/join/shared_invite/zt-2d5zsmas3-Sj0Q9TzslueCjS31eXG2UA#/shared-invite/email) to collaborate, post questions and learn more about on-device AI.
 * For questions or feedback please [reach out to us](mailto:[email protected]).
 
-
+## Usage and Limitations
+
+Model may not be used for or in connection with any of the following applications:
+
+- Accessing essential private and public services and benefits;
+- Administration of justice and democratic processes;
+- Assessing or recognizing the emotional state of a person;
+- Biometric and biometrics-based systems, including categorization of persons based on sensitive characteristics;
+- Education and vocational training;
+- Employment and workers management;
+- Exploitation of the vulnerabilities of persons resulting in harmful behavior;
+- General purpose social scoring;
+- Law enforcement;
+- Management and operation of critical infrastructure;
+- Migration, asylum and border control management;
+- Predictive policing;
+- Real-time remote biometric identification in public spaces;
+- Recommender systems of social media platforms;
+- Scraping of facial images (from the internet or otherwise); and/or
+- Subliminal manipulation