Hugging Face's logo

qualcomm
/
TrOCR

Image-to-Text
PyTorch
LiteRT
android
Model card Files
xet
Community
3
TrOCR
File size: 18,120 Bytes 
ef427ac
 
c6cde83
ef427ac
 
c776c2a
ef427ac
 
 
e8a849c
ef427ac
 
 
 
79b3898
ef427ac
 
238714d
79b3898
 
ef427ac
 
 
 
 
89ce00c
ef427ac
 
c6cde83
ef427ac
 
 
 
c651c25
 
 
ef427ac
c6cde83
5291c19
e2da246
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ef427ac
9d8ef57
 
ef427ac
 
 
 
9b1fa5c
ef427ac
04c5fcb
ef427ac
 
 
 
328befd
ef427ac
328befd
ef427ac
 
 
 
 
 
 
328befd
ef427ac
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
89ce00c
9d8ef57
 
ef427ac
 
9d8ef57
ef427ac
 
 
 
 
 
 
 
 
 
 
 
aa988ea
ef427ac
 
3108d1c
8285fbc
ef427ac
32c3acd
ef427ac
8285fbc
3108d1c
 
8285fbc
3108d1c
8285fbc
 
3108d1c
 
8285fbc
3108d1c
8285fbc
 
 
3108d1c
ef427ac
 
 
 
 
 
 
 
 
 
 
3108d1c
 
2bc5d1f
 
3108d1c
ef427ac
 
 
 
 
 
 
3108d1c
 
 
2bc5d1f
3108d1c
2bc5d1f
3108d1c
ef427ac
 
 
 
 
 
328befd
ef427ac
 
 
9d8ef57
ef427ac
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
5291c19
ef427ac
9b1fa5c
 
5291c19
 
 
ef427ac
 
 
 
 
5291c19
 
ef427ac
4332354
ef427ac
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
---
library_name: pytorch
license: other
tags:
- android
pipeline_tag: image-to-text

---

![](https://qaihub-public-assets.s3.us-west-2.amazonaws.com/qai-hub-models/models/trocr/web-assets/model_demo.png)

# TrOCR: Optimized for Mobile Deployment
## Transformer based model for state-of-the-art optical character recognition (OCR) on both printed and handwritten text


End-to-end text recognition approach with pre-trained image transformer and text transformer models for both image understanding and wordpiece-level text generation.

This model is an implementation of TrOCR found [here](https://huggingface.co/microsoft/trocr-small-stage1).


This repository provides scripts to run TrOCR on Qualcomm® devices.
More details on model performance across various devices, can be found
[here](https://aihub.qualcomm.com/models/trocr).



### Model Details

- **Model Type:** Model_use_case.image_to_text
- **Model Stats:**
  - Model checkpoint: trocr-small-stage1
  - Input resolution: 320x320
  - Number of parameters (TrOCRDecoder): 38.3M
  - Model size (TrOCRDecoder) (float): 146 MB
  - Number of parameters (TrOCREncoder): 23.0M
  - Model size (TrOCREncoder) (float): 87.8 MB

| Model | Precision | Device | Chipset | Target Runtime | Inference Time (ms) | Peak Memory Range (MB) | Primary Compute Unit | Target Model
|---|---|---|---|---|---|---|---|---|
| TrOCRDecoder | float | QCS8275 (Proxy) | Qualcomm® QCS8275 (Proxy) | TFLITE | 4.357 ms | 0 - 74 MB | NPU | [TrOCR.tflite](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.tflite) |
| TrOCRDecoder | float | QCS8275 (Proxy) | Qualcomm® QCS8275 (Proxy) | QNN_DLC | 4.106 ms | 4 - 73 MB | NPU | [TrOCR.dlc](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.dlc) |
| TrOCRDecoder | float | QCS8450 (Proxy) | Qualcomm® QCS8450 (Proxy) | TFLITE | 2.401 ms | 0 - 133 MB | NPU | [TrOCR.tflite](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.tflite) |
| TrOCRDecoder | float | QCS8450 (Proxy) | Qualcomm® QCS8450 (Proxy) | QNN_DLC | 2.86 ms | 7 - 135 MB | NPU | [TrOCR.dlc](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.dlc) |
| TrOCRDecoder | float | QCS8550 (Proxy) | Qualcomm® QCS8550 (Proxy) | TFLITE | 2.018 ms | 0 - 212 MB | NPU | [TrOCR.tflite](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.tflite) |
| TrOCRDecoder | float | QCS8550 (Proxy) | Qualcomm® QCS8550 (Proxy) | QNN_DLC | 1.967 ms | 2 - 26 MB | NPU | [TrOCR.dlc](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.dlc) |
| TrOCRDecoder | float | QCS8550 (Proxy) | Qualcomm® QCS8550 (Proxy) | ONNX | 2.466 ms | 7 - 31 MB | NPU | [TrOCR.onnx.zip](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.onnx.zip) |
| TrOCRDecoder | float | QCS9075 (Proxy) | Qualcomm® QCS9075 (Proxy) | TFLITE | 2.875 ms | 0 - 75 MB | NPU | [TrOCR.tflite](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.tflite) |
| TrOCRDecoder | float | QCS9075 (Proxy) | Qualcomm® QCS9075 (Proxy) | QNN_DLC | 2.815 ms | 5 - 74 MB | NPU | [TrOCR.dlc](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.dlc) |
| TrOCRDecoder | float | SA7255P ADP | Qualcomm® SA7255P | TFLITE | 4.357 ms | 0 - 74 MB | NPU | [TrOCR.tflite](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.tflite) |
| TrOCRDecoder | float | SA7255P ADP | Qualcomm® SA7255P | QNN_DLC | 4.106 ms | 4 - 73 MB | NPU | [TrOCR.dlc](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.dlc) |
| TrOCRDecoder | float | SA8255 (Proxy) | Qualcomm® SA8255P (Proxy) | TFLITE | 1.99 ms | 0 - 391 MB | NPU | [TrOCR.tflite](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.tflite) |
| TrOCRDecoder | float | SA8255 (Proxy) | Qualcomm® SA8255P (Proxy) | QNN_DLC | 1.975 ms | 1 - 22 MB | NPU | [TrOCR.dlc](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.dlc) |
| TrOCRDecoder | float | SA8295P ADP | Qualcomm® SA8295P | TFLITE | 2.972 ms | 0 - 65 MB | NPU | [TrOCR.tflite](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.tflite) |
| TrOCRDecoder | float | SA8295P ADP | Qualcomm® SA8295P | QNN_DLC | 2.826 ms | 0 - 60 MB | NPU | [TrOCR.dlc](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.dlc) |
| TrOCRDecoder | float | SA8650 (Proxy) | Qualcomm® SA8650P (Proxy) | TFLITE | 1.986 ms | 0 - 274 MB | NPU | [TrOCR.tflite](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.tflite) |
| TrOCRDecoder | float | SA8650 (Proxy) | Qualcomm® SA8650P (Proxy) | QNN_DLC | 1.968 ms | 1 - 24 MB | NPU | [TrOCR.dlc](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.dlc) |
| TrOCRDecoder | float | SA8775P ADP | Qualcomm® SA8775P | TFLITE | 2.875 ms | 0 - 75 MB | NPU | [TrOCR.tflite](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.tflite) |
| TrOCRDecoder | float | SA8775P ADP | Qualcomm® SA8775P | QNN_DLC | 2.815 ms | 5 - 74 MB | NPU | [TrOCR.dlc](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.dlc) |
| TrOCRDecoder | float | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | TFLITE | 1.479 ms | 0 - 148 MB | NPU | [TrOCR.tflite](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.tflite) |
| TrOCRDecoder | float | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | QNN_DLC | 1.437 ms | 0 - 146 MB | NPU | [TrOCR.dlc](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.dlc) |
| TrOCRDecoder | float | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | ONNX | 1.715 ms | 0 - 146 MB | NPU | [TrOCR.onnx.zip](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.onnx.zip) |
| TrOCRDecoder | float | Samsung Galaxy S25 | Snapdragon® 8 Elite For Galaxy Mobile | TFLITE | 1.196 ms | 0 - 76 MB | NPU | [TrOCR.tflite](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.tflite) |
| TrOCRDecoder | float | Samsung Galaxy S25 | Snapdragon® 8 Elite For Galaxy Mobile | QNN_DLC | 1.153 ms | 0 - 154 MB | NPU | [TrOCR.dlc](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.dlc) |
| TrOCRDecoder | float | Samsung Galaxy S25 | Snapdragon® 8 Elite For Galaxy Mobile | ONNX | 1.659 ms | 0 - 155 MB | NPU | [TrOCR.onnx.zip](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.onnx.zip) |
| TrOCRDecoder | float | Snapdragon 8 Elite Gen 5 QRD | Snapdragon® 8 Elite Gen5 Mobile | TFLITE | 1.181 ms | 0 - 73 MB | NPU | [TrOCR.tflite](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.tflite) |
| TrOCRDecoder | float | Snapdragon 8 Elite Gen 5 QRD | Snapdragon® 8 Elite Gen5 Mobile | QNN_DLC | 1.123 ms | 2 - 141 MB | NPU | [TrOCR.dlc](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.dlc) |
| TrOCRDecoder | float | Snapdragon 8 Elite Gen 5 QRD | Snapdragon® 8 Elite Gen5 Mobile | ONNX | 1.369 ms | 1 - 141 MB | NPU | [TrOCR.onnx.zip](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.onnx.zip) |
| TrOCRDecoder | float | Snapdragon X Elite CRD | Snapdragon® X Elite | QNN_DLC | 2.232 ms | 627 - 627 MB | NPU | [TrOCR.dlc](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.dlc) |
| TrOCRDecoder | float | Snapdragon X Elite CRD | Snapdragon® X Elite | ONNX | 2.284 ms | 67 - 67 MB | NPU | [TrOCR.onnx.zip](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.onnx.zip) |
| TrOCREncoder | float | QCS8275 (Proxy) | Qualcomm® QCS8275 (Proxy) | TFLITE | 41.868 ms | 7 - 115 MB | NPU | [TrOCR.tflite](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.tflite) |
| TrOCREncoder | float | QCS8275 (Proxy) | Qualcomm® QCS8275 (Proxy) | QNN_DLC | 45.887 ms | 2 - 123 MB | NPU | [TrOCR.dlc](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.dlc) |
| TrOCREncoder | float | QCS8450 (Proxy) | Qualcomm® QCS8450 (Proxy) | TFLITE | 22.59 ms | 7 - 127 MB | NPU | [TrOCR.tflite](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.tflite) |
| TrOCREncoder | float | QCS8450 (Proxy) | Qualcomm® QCS8450 (Proxy) | QNN_DLC | 28.272 ms | 2 - 134 MB | NPU | [TrOCR.dlc](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.dlc) |
| TrOCREncoder | float | QCS8550 (Proxy) | Qualcomm® QCS8550 (Proxy) | TFLITE | 13.25 ms | 7 - 25 MB | NPU | [TrOCR.tflite](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.tflite) |
| TrOCREncoder | float | QCS8550 (Proxy) | Qualcomm® QCS8550 (Proxy) | QNN_DLC | 16.801 ms | 2 - 22 MB | NPU | [TrOCR.dlc](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.dlc) |
| TrOCREncoder | float | QCS8550 (Proxy) | Qualcomm® QCS8550 (Proxy) | ONNX | 17.459 ms | 0 - 135 MB | NPU | [TrOCR.onnx.zip](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.onnx.zip) |
| TrOCREncoder | float | QCS9075 (Proxy) | Qualcomm® QCS9075 (Proxy) | TFLITE | 16.029 ms | 7 - 115 MB | NPU | [TrOCR.tflite](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.tflite) |
| TrOCREncoder | float | QCS9075 (Proxy) | Qualcomm® QCS9075 (Proxy) | QNN_DLC | 19.8 ms | 2 - 127 MB | NPU | [TrOCR.dlc](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.dlc) |
| TrOCREncoder | float | SA7255P ADP | Qualcomm® SA7255P | TFLITE | 41.868 ms | 7 - 115 MB | NPU | [TrOCR.tflite](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.tflite) |
| TrOCREncoder | float | SA7255P ADP | Qualcomm® SA7255P | QNN_DLC | 45.887 ms | 2 - 123 MB | NPU | [TrOCR.dlc](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.dlc) |
| TrOCREncoder | float | SA8255 (Proxy) | Qualcomm® SA8255P (Proxy) | TFLITE | 13.169 ms | 8 - 34 MB | NPU | [TrOCR.tflite](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.tflite) |
| TrOCREncoder | float | SA8255 (Proxy) | Qualcomm® SA8255P (Proxy) | QNN_DLC | 16.828 ms | 2 - 23 MB | NPU | [TrOCR.dlc](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.dlc) |
| TrOCREncoder | float | SA8295P ADP | Qualcomm® SA8295P | TFLITE | 24.297 ms | 6 - 123 MB | NPU | [TrOCR.tflite](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.tflite) |
| TrOCREncoder | float | SA8295P ADP | Qualcomm® SA8295P | QNN_DLC | 25.839 ms | 2 - 131 MB | NPU | [TrOCR.dlc](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.dlc) |
| TrOCREncoder | float | SA8650 (Proxy) | Qualcomm® SA8650P (Proxy) | TFLITE | 13.207 ms | 7 - 23 MB | NPU | [TrOCR.tflite](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.tflite) |
| TrOCREncoder | float | SA8650 (Proxy) | Qualcomm® SA8650P (Proxy) | QNN_DLC | 16.703 ms | 2 - 25 MB | NPU | [TrOCR.dlc](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.dlc) |
| TrOCREncoder | float | SA8775P ADP | Qualcomm® SA8775P | TFLITE | 16.029 ms | 7 - 115 MB | NPU | [TrOCR.tflite](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.tflite) |
| TrOCREncoder | float | SA8775P ADP | Qualcomm® SA8775P | QNN_DLC | 19.8 ms | 2 - 127 MB | NPU | [TrOCR.dlc](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.dlc) |
| TrOCREncoder | float | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | TFLITE | 9.435 ms | 5 - 122 MB | NPU | [TrOCR.tflite](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.tflite) |
| TrOCREncoder | float | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | QNN_DLC | 11.435 ms | 0 - 131 MB | NPU | [TrOCR.dlc](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.dlc) |
| TrOCREncoder | float | Samsung Galaxy S24 | Snapdragon® 8 Gen 3 Mobile | ONNX | 11.589 ms | 15 - 184 MB | NPU | [TrOCR.onnx.zip](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.onnx.zip) |
| TrOCREncoder | float | Samsung Galaxy S25 | Snapdragon® 8 Elite For Galaxy Mobile | TFLITE | 6.336 ms | 6 - 118 MB | NPU | [TrOCR.tflite](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.tflite) |
| TrOCREncoder | float | Samsung Galaxy S25 | Snapdragon® 8 Elite For Galaxy Mobile | QNN_DLC | 9.531 ms | 2 - 155 MB | NPU | [TrOCR.dlc](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.dlc) |
| TrOCREncoder | float | Samsung Galaxy S25 | Snapdragon® 8 Elite For Galaxy Mobile | ONNX | 10.053 ms | 15 - 165 MB | NPU | [TrOCR.onnx.zip](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.onnx.zip) |
| TrOCREncoder | float | Snapdragon 8 Elite Gen 5 QRD | Snapdragon® 8 Elite Gen5 Mobile | TFLITE | 5.473 ms | 0 - 112 MB | NPU | [TrOCR.tflite](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.tflite) |
| TrOCREncoder | float | Snapdragon 8 Elite Gen 5 QRD | Snapdragon® 8 Elite Gen5 Mobile | QNN_DLC | 6.972 ms | 2 - 129 MB | NPU | [TrOCR.dlc](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.dlc) |
| TrOCREncoder | float | Snapdragon 8 Elite Gen 5 QRD | Snapdragon® 8 Elite Gen5 Mobile | ONNX | 7.297 ms | 15 - 144 MB | NPU | [TrOCR.onnx.zip](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.onnx.zip) |
| TrOCREncoder | float | Snapdragon X Elite CRD | Snapdragon® X Elite | QNN_DLC | 17.534 ms | 217 - 217 MB | NPU | [TrOCR.dlc](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.dlc) |
| TrOCREncoder | float | Snapdragon X Elite CRD | Snapdragon® X Elite | ONNX | 18.04 ms | 48 - 48 MB | NPU | [TrOCR.onnx.zip](https://huggingface.co/qualcomm/TrOCR/blob/main/TrOCR.onnx.zip) |




## Installation


Install the package via pip:
```bash
# NOTE: 3.10 <= PYTHON_VERSION < 3.14 is supported.
pip install "qai-hub-models[trocr]"
```


## Configure Qualcomm® AI Hub Workbench to run this model on a cloud-hosted device

Sign-in to [Qualcomm® AI Hub Workbench](https://workbench.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://workbench.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.trocr.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.trocr.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.trocr.export
```



## How does this work?

This [export script](https://aihub.qualcomm.com/models/trocr/qai_hub_models/models/TrOCR/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.trocr import Model

# Load the model
torch_model = Model.from_pretrained()

# Device
device = hub.Device("Samsung Galaxy S25")

# 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.
```python
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.
```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 Workbench. [Sign up for access](https://myaccount.qualcomm.com/signup).




## 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.


## View on Qualcomm® AI Hub
Get more details on TrOCR's performance across various devices [here](https://aihub.qualcomm.com/models/trocr).
Explore all available models on [Qualcomm® AI Hub](https://aihub.qualcomm.com/)


## License
* The license for the original implementation of TrOCR can be found
  [here](https://github.com/microsoft/unilm/blob/master/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
* [TrOCR: Transformer-based Optical Character Recognition with Pre-trained Models](https://arxiv.org/abs/2109.10282)
* [Source Model Implementation](https://huggingface.co/microsoft/trocr-small-stage1)



## 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).