Upload README.md with huggingface_hub
Browse files
README.md
ADDED
@@ -0,0 +1,304 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
---
|
2 |
+
library_name: pytorch
|
3 |
+
license: apache-2.0
|
4 |
+
tags:
|
5 |
+
- foundation
|
6 |
+
- android
|
7 |
+
pipeline_tag: image-segmentation
|
8 |
+
|
9 |
+
---
|
10 |
+
|
11 |
+

|
12 |
+
|
13 |
+
# MobileSam: Optimized for Mobile Deployment
|
14 |
+
## FASTER SEGMENT ANYTHING: TOWARDS LIGHTWEIGHT SAM FOR MOBILE APPLICATIONS
|
15 |
+
|
16 |
+
|
17 |
+
Transformer based encoder-decoder where prompts specify what to segment in an image thereby allowing segmentation without the need for additional training. The image encoder generates embeddings and the lightweight decoder operates on the embeddings for point and mask based image segmentation.
|
18 |
+
|
19 |
+
This model is an implementation of MobileSam found [here](https://github.com/facebookresearch/segment-anything).
|
20 |
+
|
21 |
+
|
22 |
+
This repository provides scripts to run MobileSam on Qualcomm® devices.
|
23 |
+
More details on model performance across various devices, can be found
|
24 |
+
[here](https://aihub.qualcomm.com/models/mobilesam).
|
25 |
+
|
26 |
+
|
27 |
+
### Model Details
|
28 |
+
|
29 |
+
- **Model Type:** Semantic segmentation
|
30 |
+
- **Model Stats:**
|
31 |
+
- Model checkpoint: vit_t
|
32 |
+
- Input resolution: 720p (720x1280)
|
33 |
+
- Number of parameters (MobileSamDecoder): 3.876M
|
34 |
+
- Model size (MobileSamDecoder): 19.6 MB
|
35 |
+
|
36 |
+
| Model | Device | Chipset | Target Runtime | Inference Time (ms) | Peak Memory Range (MB) | Precision | Primary Compute Unit | Target Model
|
37 |
+
|---|---|---|---|---|---|---|---|---|
|
38 |
+
| SAMEncoder | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 | TFLITE | 439.913 ms | 34 - 60 MB | FP16 | NPU | [MobileSam.tflite](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMEncoder.tflite) |
|
39 |
+
| SAMEncoder | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 | QNN | 334.816 ms | 12 - 89 MB | FP16 | NPU | [MobileSam.so](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMEncoder.so) |
|
40 |
+
| SAMEncoder | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 | ONNX | 417.54 ms | 65 - 122 MB | FP16 | NPU | [MobileSam.onnx](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMEncoder.onnx) |
|
41 |
+
| SAMEncoder | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 | TFLITE | 335.191 ms | 33 - 158 MB | FP16 | NPU | [MobileSam.tflite](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMEncoder.tflite) |
|
42 |
+
| SAMEncoder | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 | QNN | 247.716 ms | 191 - 694 MB | FP16 | NPU | [MobileSam.so](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMEncoder.so) |
|
43 |
+
| SAMEncoder | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 | ONNX | 313.436 ms | 95 - 218 MB | FP16 | NPU | [MobileSam.onnx](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMEncoder.onnx) |
|
44 |
+
| SAMEncoder | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite | TFLITE | 237.753 ms | 33 - 166 MB | FP16 | NPU | [MobileSam.tflite](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMEncoder.tflite) |
|
45 |
+
| SAMEncoder | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite | QNN | 235.822 ms | 12 - 519 MB | FP16 | NPU | Use Export Script |
|
46 |
+
| SAMEncoder | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite | ONNX | 271.979 ms | 78 - 213 MB | FP16 | NPU | [MobileSam.onnx](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMEncoder.onnx) |
|
47 |
+
| SAMEncoder | SA7255P ADP | SA7255P | TFLITE | 1302.15 ms | 33 - 166 MB | FP16 | NPU | [MobileSam.tflite](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMEncoder.tflite) |
|
48 |
+
| SAMEncoder | SA7255P ADP | SA7255P | QNN | 991.612 ms | 12 - 21 MB | FP16 | NPU | Use Export Script |
|
49 |
+
| SAMEncoder | SA8255 (Proxy) | SA8255P Proxy | TFLITE | 415.155 ms | 33 - 59 MB | FP16 | NPU | [MobileSam.tflite](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMEncoder.tflite) |
|
50 |
+
| SAMEncoder | SA8255 (Proxy) | SA8255P Proxy | QNN | 266.684 ms | 12 - 15 MB | FP16 | NPU | Use Export Script |
|
51 |
+
| SAMEncoder | SA8295P ADP | SA8295P | TFLITE | 585.405 ms | 33 - 168 MB | FP16 | NPU | [MobileSam.tflite](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMEncoder.tflite) |
|
52 |
+
| SAMEncoder | SA8295P ADP | SA8295P | QNN | 424.958 ms | 0 - 18 MB | FP16 | NPU | Use Export Script |
|
53 |
+
| SAMEncoder | SA8650 (Proxy) | SA8650P Proxy | TFLITE | 432.024 ms | 33 - 58 MB | FP16 | NPU | [MobileSam.tflite](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMEncoder.tflite) |
|
54 |
+
| SAMEncoder | SA8650 (Proxy) | SA8650P Proxy | QNN | 268.519 ms | 12 - 15 MB | FP16 | NPU | Use Export Script |
|
55 |
+
| SAMEncoder | SA8775P ADP | SA8775P | TFLITE | 494.361 ms | 33 - 165 MB | FP16 | NPU | [MobileSam.tflite](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMEncoder.tflite) |
|
56 |
+
| SAMEncoder | SA8775P ADP | SA8775P | QNN | 330.266 ms | 1 - 11 MB | FP16 | NPU | Use Export Script |
|
57 |
+
| SAMEncoder | QCS8275 (Proxy) | QCS8275 Proxy | TFLITE | 1302.15 ms | 33 - 166 MB | FP16 | NPU | [MobileSam.tflite](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMEncoder.tflite) |
|
58 |
+
| SAMEncoder | QCS8275 (Proxy) | QCS8275 Proxy | QNN | 991.612 ms | 12 - 21 MB | FP16 | NPU | Use Export Script |
|
59 |
+
| SAMEncoder | QCS8550 (Proxy) | QCS8550 Proxy | TFLITE | 420.702 ms | 33 - 60 MB | FP16 | NPU | [MobileSam.tflite](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMEncoder.tflite) |
|
60 |
+
| SAMEncoder | QCS8550 (Proxy) | QCS8550 Proxy | QNN | 270.321 ms | 12 - 15 MB | FP16 | NPU | Use Export Script |
|
61 |
+
| SAMEncoder | QCS9075 (Proxy) | QCS9075 Proxy | TFLITE | 494.361 ms | 33 - 165 MB | FP16 | NPU | [MobileSam.tflite](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMEncoder.tflite) |
|
62 |
+
| SAMEncoder | QCS9075 (Proxy) | QCS9075 Proxy | QNN | 330.266 ms | 1 - 11 MB | FP16 | NPU | Use Export Script |
|
63 |
+
| SAMEncoder | QCS8450 (Proxy) | QCS8450 Proxy | TFLITE | 597.124 ms | 33 - 171 MB | FP16 | NPU | [MobileSam.tflite](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMEncoder.tflite) |
|
64 |
+
| SAMEncoder | QCS8450 (Proxy) | QCS8450 Proxy | QNN | 503.439 ms | 12 - 572 MB | FP16 | NPU | Use Export Script |
|
65 |
+
| SAMEncoder | Snapdragon X Elite CRD | Snapdragon® X Elite | QNN | 275.036 ms | 12 - 12 MB | FP16 | NPU | Use Export Script |
|
66 |
+
| SAMEncoder | Snapdragon X Elite CRD | Snapdragon® X Elite | ONNX | 448.994 ms | 130 - 130 MB | FP16 | NPU | [MobileSam.onnx](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMEncoder.onnx) |
|
67 |
+
| SAMDecoder | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 | TFLITE | 7.38 ms | 0 - 29 MB | FP16 | NPU | [MobileSam.tflite](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMDecoder.tflite) |
|
68 |
+
| SAMDecoder | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 | QNN | 6.435 ms | 4 - 21 MB | FP16 | NPU | [MobileSam.so](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMDecoder.so) |
|
69 |
+
| SAMDecoder | Samsung Galaxy S23 | Snapdragon® 8 Gen 2 | ONNX | 8.887 ms | 1 - 62 MB | FP16 | NPU | [MobileSam.onnx](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMDecoder.onnx) |
|
70 |
+
| SAMDecoder | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 | TFLITE | 5.151 ms | 0 - 46 MB | FP16 | NPU | [MobileSam.tflite](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMDecoder.tflite) |
|
71 |
+
| SAMDecoder | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 | QNN | 4.55 ms | 4 - 48 MB | FP16 | NPU | [MobileSam.so](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMDecoder.so) |
|
72 |
+
| SAMDecoder | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 | ONNX | 6.067 ms | 6 - 75 MB | FP16 | NPU | [MobileSam.onnx](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMDecoder.onnx) |
|
73 |
+
| SAMDecoder | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite | TFLITE | 5.041 ms | 0 - 44 MB | FP16 | NPU | [MobileSam.tflite](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMDecoder.tflite) |
|
74 |
+
| SAMDecoder | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite | QNN | 4.357 ms | 4 - 42 MB | FP16 | NPU | Use Export Script |
|
75 |
+
| SAMDecoder | Snapdragon 8 Elite QRD | Snapdragon® 8 Elite | ONNX | 4.566 ms | 4 - 62 MB | FP16 | NPU | [MobileSam.onnx](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMDecoder.onnx) |
|
76 |
+
| SAMDecoder | SA7255P ADP | SA7255P | TFLITE | 53.054 ms | 0 - 40 MB | FP16 | NPU | [MobileSam.tflite](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMDecoder.tflite) |
|
77 |
+
| SAMDecoder | SA7255P ADP | SA7255P | QNN | 48.542 ms | 1 - 11 MB | FP16 | NPU | Use Export Script |
|
78 |
+
| SAMDecoder | SA8255 (Proxy) | SA8255P Proxy | TFLITE | 7.371 ms | 0 - 26 MB | FP16 | NPU | [MobileSam.tflite](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMDecoder.tflite) |
|
79 |
+
| SAMDecoder | SA8255 (Proxy) | SA8255P Proxy | QNN | 6.184 ms | 4 - 6 MB | FP16 | NPU | Use Export Script |
|
80 |
+
| SAMDecoder | SA8295P ADP | SA8295P | TFLITE | 9.906 ms | 0 - 36 MB | FP16 | NPU | [MobileSam.tflite](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMDecoder.tflite) |
|
81 |
+
| SAMDecoder | SA8295P ADP | SA8295P | QNN | 7.432 ms | 0 - 17 MB | FP16 | NPU | Use Export Script |
|
82 |
+
| SAMDecoder | SA8650 (Proxy) | SA8650P Proxy | TFLITE | 7.351 ms | 0 - 25 MB | FP16 | NPU | [MobileSam.tflite](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMDecoder.tflite) |
|
83 |
+
| SAMDecoder | SA8650 (Proxy) | SA8650P Proxy | QNN | 6.18 ms | 4 - 7 MB | FP16 | NPU | Use Export Script |
|
84 |
+
| SAMDecoder | SA8775P ADP | SA8775P | TFLITE | 10.347 ms | 0 - 40 MB | FP16 | NPU | [MobileSam.tflite](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMDecoder.tflite) |
|
85 |
+
| SAMDecoder | SA8775P ADP | SA8775P | QNN | 8.85 ms | 1 - 11 MB | FP16 | NPU | Use Export Script |
|
86 |
+
| SAMDecoder | QCS8275 (Proxy) | QCS8275 Proxy | TFLITE | 53.054 ms | 0 - 40 MB | FP16 | NPU | [MobileSam.tflite](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMDecoder.tflite) |
|
87 |
+
| SAMDecoder | QCS8275 (Proxy) | QCS8275 Proxy | QNN | 48.542 ms | 1 - 11 MB | FP16 | NPU | Use Export Script |
|
88 |
+
| SAMDecoder | QCS8550 (Proxy) | QCS8550 Proxy | TFLITE | 7.346 ms | 0 - 26 MB | FP16 | NPU | [MobileSam.tflite](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMDecoder.tflite) |
|
89 |
+
| SAMDecoder | QCS8550 (Proxy) | QCS8550 Proxy | QNN | 6.298 ms | 4 - 6 MB | FP16 | NPU | Use Export Script |
|
90 |
+
| SAMDecoder | QCS9075 (Proxy) | QCS9075 Proxy | TFLITE | 10.347 ms | 0 - 40 MB | FP16 | NPU | [MobileSam.tflite](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMDecoder.tflite) |
|
91 |
+
| SAMDecoder | QCS9075 (Proxy) | QCS9075 Proxy | QNN | 8.85 ms | 1 - 11 MB | FP16 | NPU | Use Export Script |
|
92 |
+
| SAMDecoder | QCS8450 (Proxy) | QCS8450 Proxy | TFLITE | 8.763 ms | 0 - 42 MB | FP16 | NPU | [MobileSam.tflite](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMDecoder.tflite) |
|
93 |
+
| SAMDecoder | QCS8450 (Proxy) | QCS8450 Proxy | QNN | 8.018 ms | 4 - 42 MB | FP16 | NPU | Use Export Script |
|
94 |
+
| SAMDecoder | Snapdragon X Elite CRD | Snapdragon® X Elite | QNN | 6.736 ms | 4 - 4 MB | FP16 | NPU | Use Export Script |
|
95 |
+
| SAMDecoder | Snapdragon X Elite CRD | Snapdragon® X Elite | ONNX | 10.021 ms | 12 - 12 MB | FP16 | NPU | [MobileSam.onnx](https://huggingface.co/qualcomm/MobileSam/blob/main/SAMDecoder.onnx) |
|
96 |
+
|
97 |
+
|
98 |
+
|
99 |
+
|
100 |
+
## Installation
|
101 |
+
|
102 |
+
|
103 |
+
Install the package via pip:
|
104 |
+
```bash
|
105 |
+
pip install "qai-hub-models[mobilesam]"
|
106 |
+
```
|
107 |
+
|
108 |
+
|
109 |
+
## Configure Qualcomm® AI Hub to run this model on a cloud-hosted device
|
110 |
+
|
111 |
+
Sign-in to [Qualcomm® AI Hub](https://app.aihub.qualcomm.com/) with your
|
112 |
+
Qualcomm® ID. Once signed in navigate to `Account -> Settings -> API Token`.
|
113 |
+
|
114 |
+
With this API token, you can configure your client to run models on the cloud
|
115 |
+
hosted devices.
|
116 |
+
```bash
|
117 |
+
qai-hub configure --api_token API_TOKEN
|
118 |
+
```
|
119 |
+
Navigate to [docs](https://app.aihub.qualcomm.com/docs/) for more information.
|
120 |
+
|
121 |
+
|
122 |
+
|
123 |
+
## Demo off target
|
124 |
+
|
125 |
+
The package contains a simple end-to-end demo that downloads pre-trained
|
126 |
+
weights and runs this model on a sample input.
|
127 |
+
|
128 |
+
```bash
|
129 |
+
python -m qai_hub_models.models.mobilesam.demo
|
130 |
+
```
|
131 |
+
|
132 |
+
The above demo runs a reference implementation of pre-processing, model
|
133 |
+
inference, and post processing.
|
134 |
+
|
135 |
+
**NOTE**: If you want running in a Jupyter Notebook or Google Colab like
|
136 |
+
environment, please add the following to your cell (instead of the above).
|
137 |
+
```
|
138 |
+
%run -m qai_hub_models.models.mobilesam.demo
|
139 |
+
```
|
140 |
+
|
141 |
+
|
142 |
+
### Run model on a cloud-hosted device
|
143 |
+
|
144 |
+
In addition to the demo, you can also run the model on a cloud-hosted Qualcomm®
|
145 |
+
device. This script does the following:
|
146 |
+
* Performance check on-device on a cloud-hosted device
|
147 |
+
* Downloads compiled assets that can be deployed on-device for Android.
|
148 |
+
* Accuracy check between PyTorch and on-device outputs.
|
149 |
+
|
150 |
+
```bash
|
151 |
+
python -m qai_hub_models.models.mobilesam.export
|
152 |
+
```
|
153 |
+
```
|
154 |
+
Profiling Results
|
155 |
+
------------------------------------------------------------
|
156 |
+
SAMEncoder
|
157 |
+
Device : Samsung Galaxy S23 (13)
|
158 |
+
Runtime : TFLITE
|
159 |
+
Estimated inference time (ms) : 439.9
|
160 |
+
Estimated peak memory usage (MB): [34, 60]
|
161 |
+
Total # Ops : 592
|
162 |
+
Compute Unit(s) : NPU (532 ops) CPU (60 ops)
|
163 |
+
|
164 |
+
------------------------------------------------------------
|
165 |
+
SAMDecoder
|
166 |
+
Device : Samsung Galaxy S23 (13)
|
167 |
+
Runtime : TFLITE
|
168 |
+
Estimated inference time (ms) : 7.4
|
169 |
+
Estimated peak memory usage (MB): [0, 29]
|
170 |
+
Total # Ops : 845
|
171 |
+
Compute Unit(s) : NPU (845 ops)
|
172 |
+
```
|
173 |
+
|
174 |
+
|
175 |
+
## How does this work?
|
176 |
+
|
177 |
+
This [export script](https://aihub.qualcomm.com/models/mobilesam/qai_hub_models/models/MobileSam/export.py)
|
178 |
+
leverages [Qualcomm® AI Hub](https://aihub.qualcomm.com/) to optimize, validate, and deploy this model
|
179 |
+
on-device. Lets go through each step below in detail:
|
180 |
+
|
181 |
+
Step 1: **Compile model for on-device deployment**
|
182 |
+
|
183 |
+
To compile a PyTorch model for on-device deployment, we first trace the model
|
184 |
+
in memory using the `jit.trace` and then call the `submit_compile_job` API.
|
185 |
+
|
186 |
+
```python
|
187 |
+
import torch
|
188 |
+
|
189 |
+
import qai_hub as hub
|
190 |
+
from qai_hub_models.models.mobilesam import Model
|
191 |
+
|
192 |
+
# Load the model
|
193 |
+
torch_model = Model.from_pretrained()
|
194 |
+
|
195 |
+
# Device
|
196 |
+
device = hub.Device("Samsung Galaxy S24")
|
197 |
+
|
198 |
+
# Trace model
|
199 |
+
input_shape = torch_model.get_input_spec()
|
200 |
+
sample_inputs = torch_model.sample_inputs()
|
201 |
+
|
202 |
+
pt_model = torch.jit.trace(torch_model, [torch.tensor(data[0]) for _, data in sample_inputs.items()])
|
203 |
+
|
204 |
+
# Compile model on a specific device
|
205 |
+
compile_job = hub.submit_compile_job(
|
206 |
+
model=pt_model,
|
207 |
+
device=device,
|
208 |
+
input_specs=torch_model.get_input_spec(),
|
209 |
+
)
|
210 |
+
|
211 |
+
# Get target model to run on-device
|
212 |
+
target_model = compile_job.get_target_model()
|
213 |
+
|
214 |
+
```
|
215 |
+
|
216 |
+
|
217 |
+
Step 2: **Performance profiling on cloud-hosted device**
|
218 |
+
|
219 |
+
After compiling models from step 1. Models can be profiled model on-device using the
|
220 |
+
`target_model`. Note that this scripts runs the model on a device automatically
|
221 |
+
provisioned in the cloud. Once the job is submitted, you can navigate to a
|
222 |
+
provided job URL to view a variety of on-device performance metrics.
|
223 |
+
```python
|
224 |
+
profile_job = hub.submit_profile_job(
|
225 |
+
model=target_model,
|
226 |
+
device=device,
|
227 |
+
)
|
228 |
+
|
229 |
+
```
|
230 |
+
|
231 |
+
Step 3: **Verify on-device accuracy**
|
232 |
+
|
233 |
+
To verify the accuracy of the model on-device, you can run on-device inference
|
234 |
+
on sample input data on the same cloud hosted device.
|
235 |
+
```python
|
236 |
+
input_data = torch_model.sample_inputs()
|
237 |
+
inference_job = hub.submit_inference_job(
|
238 |
+
model=target_model,
|
239 |
+
device=device,
|
240 |
+
inputs=input_data,
|
241 |
+
)
|
242 |
+
on_device_output = inference_job.download_output_data()
|
243 |
+
|
244 |
+
```
|
245 |
+
With the output of the model, you can compute like PSNR, relative errors or
|
246 |
+
spot check the output with expected output.
|
247 |
+
|
248 |
+
**Note**: This on-device profiling and inference requires access to Qualcomm®
|
249 |
+
AI Hub. [Sign up for access](https://myaccount.qualcomm.com/signup).
|
250 |
+
|
251 |
+
|
252 |
+
|
253 |
+
## Run demo on a cloud-hosted device
|
254 |
+
|
255 |
+
You can also run the demo on-device.
|
256 |
+
|
257 |
+
```bash
|
258 |
+
python -m qai_hub_models.models.mobilesam.demo --on-device
|
259 |
+
```
|
260 |
+
|
261 |
+
**NOTE**: If you want running in a Jupyter Notebook or Google Colab like
|
262 |
+
environment, please add the following to your cell (instead of the above).
|
263 |
+
```
|
264 |
+
%run -m qai_hub_models.models.mobilesam.demo -- --on-device
|
265 |
+
```
|
266 |
+
|
267 |
+
|
268 |
+
## Deploying compiled model to Android
|
269 |
+
|
270 |
+
|
271 |
+
The models can be deployed using multiple runtimes:
|
272 |
+
- TensorFlow Lite (`.tflite` export): [This
|
273 |
+
tutorial](https://www.tensorflow.org/lite/android/quickstart) provides a
|
274 |
+
guide to deploy the .tflite model in an Android application.
|
275 |
+
|
276 |
+
|
277 |
+
- QNN (`.so` export ): This [sample
|
278 |
+
app](https://docs.qualcomm.com/bundle/publicresource/topics/80-63442-50/sample_app.html)
|
279 |
+
provides instructions on how to use the `.so` shared library in an Android application.
|
280 |
+
|
281 |
+
|
282 |
+
## View on Qualcomm® AI Hub
|
283 |
+
Get more details on MobileSam's performance across various devices [here](https://aihub.qualcomm.com/models/mobilesam).
|
284 |
+
Explore all available models on [Qualcomm® AI Hub](https://aihub.qualcomm.com/)
|
285 |
+
|
286 |
+
|
287 |
+
## License
|
288 |
+
* The license for the original implementation of MobileSam can be found
|
289 |
+
[here](https://github.com/facebookresearch/segment-anything/blob/main/LICENSE).
|
290 |
+
* 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)
|
291 |
+
|
292 |
+
|
293 |
+
|
294 |
+
## References
|
295 |
+
* [Segment Anything](https://arxiv.org/abs/2306.14289)
|
296 |
+
* [Source Model Implementation](https://github.com/facebookresearch/segment-anything)
|
297 |
+
|
298 |
+
|
299 |
+
|
300 |
+
## Community
|
301 |
+
* Join [our AI Hub Slack community](https://aihub.qualcomm.com/community/slack) to collaborate, post questions and learn more about on-device AI.
|
302 |
+
* For questions or feedback please [reach out to us](mailto:[email protected]).
|
303 |
+
|
304 |
+
|