Skip to content

Commit f83e91b

Browse files
authored
documentation updates (openvinotoolkit#623)
1 parent 6f76ba5 commit f83e91b

File tree

5 files changed

+60
-46
lines changed

5 files changed

+60
-46
lines changed

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -105,10 +105,14 @@ Follow a [contributor guide](docs/contributing.md) and a [developer guide](docs/
105105

106106
* [RESTful API](https://restfulapi.net/)
107107

108+
* [Benchmarking results](https://docs.openvinotoolkit.org/latest/openvino_docs_performance_benchmarks_ovms.html)
109+
108110
* [Speed and Scale AI Inference Operations Across Multiple Architectures](https://techdecoded.intel.io/essentials/speed-and-scale-ai-inference-operations-across-multiple-architectures/?elq_cid=3646480_ts1607680426276&erpm_id=6470692_ts1607680426276) - webinar recording
109111

110112
* [What is new in OpenVINO Model Server C++](https://www.intel.com/content/www/us/en/artificial-intelligence/posts/whats-new-openvino-model-server.html)
111113

114+
* [Capital Health Improves Stroke Care with AI](https://www.intel.co.uk/content/www/uk/en/customer-spotlight/stories/capital-health-ai-customer-story.html) - use case example
115+
112116
## Contact
113117

114118
Submit Github issue to ask question, request a feature or report a bug.

deploy/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ release "ovms-app" uninstalled
257257
| aws_region | S3 storage secret key, use it with S3 storage for models | | - |
258258
| aws_secret_access_key | S3 storage secret key, use it with S3 storage for models | | - |
259259
| s3_compat_api_endpoint | S3 compatibility api endpoint, use it with Minio storage for models | | - |
260-
| azure_storage_connection_string | S3 compatibility api endpoint, use it with Minio storage for models | | - |
260+
| azure_storage_connection_string | connection string to the Azure Storage authentication account, use it with Azure storage for models | | - |
261261
| log_level | OVMS log level, one of ERROR,INFO,DEBUG| | INFO |
262262
| service_type | k8s service type | | LoadBalancer |
263263
| resources | compute resource limits | | All CPU and memory on the node |

example_client/README.md

+44-41
Original file line numberDiff line numberDiff line change
@@ -156,47 +156,47 @@ Start processing:
156156
Images numpy path: imgs.npy
157157
Images in shape: (10, 3, 224, 224)
158158

159-
Iteration 1; Processing time: 55.45 ms; speed 18.03 fps
159+
Iteration 1; Processing time: 26.54 ms; speed 37.67 fps
160160
imagenet top results in a single batch:
161-
0 warplane, military plane 895 ; Incorrect match. Should be 404 airliner
162-
Iteration 2; Processing time: 71.97 ms; speed 13.89 fps
161+
0 airliner 404 ; Correct match.
162+
Iteration 2; Processing time: 22.23 ms; speed 44.99 fps
163163
imagenet top results in a single batch:
164164
0 Arctic fox, white fox, Alopex lagopus 279 ; Correct match.
165-
Iteration 3; Processing time: 69.82 ms; speed 14.32 fps
165+
Iteration 3; Processing time: 21.72 ms; speed 46.03 fps
166166
imagenet top results in a single batch:
167167
0 bee 309 ; Correct match.
168-
Iteration 4; Processing time: 68.95 ms; speed 14.50 fps
168+
Iteration 4; Processing time: 20.71 ms; speed 48.28 fps
169169
imagenet top results in a single batch:
170170
0 golden retriever 207 ; Correct match.
171-
Iteration 5; Processing time: 49.82 ms; speed 20.07 fps
171+
Iteration 5; Processing time: 20.53 ms; speed 48.71 fps
172172
imagenet top results in a single batch:
173173
0 gorilla, Gorilla gorilla 366 ; Correct match.
174-
Iteration 6; Processing time: 56.90 ms; speed 17.58 fps
174+
Iteration 6; Processing time: 20.37 ms; speed 49.08 fps
175175
imagenet top results in a single batch:
176176
0 magnetic compass 635 ; Correct match.
177-
Iteration 7; Processing time: 122.50 ms; speed 8.16 fps
177+
Iteration 7; Processing time: 20.97 ms; speed 47.68 fps
178178
imagenet top results in a single batch:
179179
0 peacock 84 ; Correct match.
180-
Iteration 8; Processing time: 50.65 ms; speed 19.74 fps
180+
Iteration 8; Processing time: 22.82 ms; speed 43.83 fps
181181
imagenet top results in a single batch:
182182
0 pelican 144 ; Correct match.
183-
Iteration 9; Processing time: 56.45 ms; speed 17.71 fps
183+
Iteration 9; Processing time: 22.16 ms; speed 45.13 fps
184184
imagenet top results in a single batch:
185185
0 snail 113 ; Correct match.
186-
Iteration 10; Processing time: 58.95 ms; speed 16.96 fps
186+
Iteration 10; Processing time: 21.17 ms; speed 47.24 fps
187187
imagenet top results in a single batch:
188188
0 zebra 340 ; Correct match.
189189

190190
processing time for all iterations
191-
average time: 65.40 ms; average speed: 15.29 fps
192-
median time: 57.00 ms; median speed: 17.54 fps
193-
max time: 122.00 ms; max speed: 8.20 fps
194-
min time: 49.00 ms; min speed: 20.41 fps
195-
time percentile 90: 76.10 ms; speed percentile 90: 13.14 fps
196-
time percentile 50: 57.00 ms; speed percentile 50: 17.54 fps
197-
time standard deviation: 20.25
198-
time variance: 410.04
199-
Classification accuracy: 90.00
191+
average time: 21.40 ms; average speed: 46.73 fps
192+
median time: 21.00 ms; median speed: 47.62 fps
193+
max time: 26.00 ms; min speed: 38.46 fps
194+
min time: 20.00 ms; max speed: 50.00 fps
195+
time percentile 90: 22.40 ms; speed percentile 90: 44.64 fps
196+
time percentile 50: 21.00 ms; speed percentile 50: 47.62 fps
197+
time standard deviation: 1.74
198+
time variance: 3.04
199+
Classification accuracy: 100.00
200200

201201
```
202202

@@ -235,38 +235,41 @@ python jpeg_classification.py --grpc_port 9000 --input_name data --output_name p
235235
Model name: resnet
236236
Images list file: input_images.txt
237237

238+
Start processing:
239+
Model name: resnet
240+
Images list file: input_images.txt
238241
images/airliner.jpeg (1, 3, 224, 224) ; data range: 0.0 : 255.0
239-
Processing time: 20.00 ms; speed 2.00 fps 49.03
240-
Detected: 404 Should be: 404
242+
Processing time: 23.40 ms; speed 42.73 fps
243+
1 airliner 404 ; Correct match.
241244
images/arctic-fox.jpeg (1, 3, 224, 224) ; data range: 0.0 : 255.0
242-
Processing time: 22.00 ms; speed 2.00 fps 45.2
243-
Detected: 279 Should be: 279
245+
Processing time: 21.09 ms; speed 47.42 fps
246+
2 Arctic fox, white fox, Alopex lagopus 279 ; Correct match.
244247
images/bee.jpeg (1, 3, 224, 224) ; data range: 0.0 : 255.0
245-
Processing time: 14.00 ms; speed 2.00 fps 69.12
246-
Detected: 309 Should be: 309
248+
Processing time: 21.04 ms; speed 47.52 fps
249+
3 bee 309 ; Correct match.
247250
images/golden_retriever.jpeg (1, 3, 224, 224) ; data range: 0.0 : 255.0
248-
Processing time: 22.00 ms; speed 2.00 fps 45.68
249-
Detected: 207 Should be: 207
251+
Processing time: 20.03 ms; speed 49.92 fps
252+
4 golden retriever 207 ; Correct match.
250253
images/gorilla.jpeg (1, 3, 224, 224) ; data range: 0.0 : 255.0
251-
Processing time: 18.00 ms; speed 2.00 fps 56.02
252-
Detected: 366 Should be: 366
254+
Processing time: 21.95 ms; speed 45.57 fps
255+
5 gorilla, Gorilla gorilla 366 ; Correct match.
253256
images/magnetic_compass.jpeg (1, 3, 224, 224) ; data range: 0.0 : 247.0
254-
Processing time: 20.00 ms; speed 2.00 fps 50.78
255-
Detected: 635 Should be: 635
257+
Processing time: 21.51 ms; speed 46.48 fps
258+
6 magnetic compass 635 ; Correct match.
256259
images/peacock.jpeg (1, 3, 224, 224) ; data range: 0.0 : 255.0
257-
Processing time: 21.00 ms; speed 2.00 fps 47.1
258-
Detected: 84 Should be: 84
260+
Processing time: 20.81 ms; speed 48.05 fps
261+
7 peacock 84 ; Correct match.
259262
images/pelican.jpeg (1, 3, 224, 224) ; data range: 0.0 : 255.0
260-
Processing time: 24.00 ms; speed 2.00 fps 41.32
261-
Detected: 144 Should be: 144
263+
Processing time: 21.90 ms; speed 45.66 fps
264+
8 pelican 144 ; Correct match.
262265
images/snail.jpeg (1, 3, 224, 224) ; data range: 0.0 : 248.0
263-
Processing time: 20.00 ms; speed 2.00 fps 49.16
264-
Detected: 113 Should be: 113
266+
Processing time: 22.38 ms; speed 44.68 fps
267+
9 snail 113 ; Correct match.
265268
images/zebra.jpeg (1, 3, 224, 224) ; data range: 0.0 : 255.0
266-
Processing time: 21.00 ms; speed 2.00 fps 48.16
267-
Detected: 340 Should be: 340
269+
Processing time: 22.22 ms; speed 45.00 fps
270+
10 zebra 340 ; Correct match.
268271
Overall accuracy= 100.0 %
269-
Average latency= 19.8 ms
272+
Average latency= 21.2 ms
270273
```
271274
### Multiple input example for HDDL
272275

example_client/jpeg_classification.py

+6-1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616

1717
import grpc
1818
import numpy as np
19+
import classes
1920
from tensorflow import make_tensor_proto, make_ndarray, make_tensor_proto
2021
import datetime
2122
import argparse
@@ -109,10 +110,14 @@ def getJpeg(path, size, rgb_image=0):
109110
# for object classification models show imagenet class
110111
print('Processing time: {:.2f} ms; speed {:.2f} fps'.format(round(duration, 2), round(1000 / duration, 2)))
111112
ma = np.argmax(nu)
113+
mark_message = ""
112114
if int(label) == ma:
113115
matched += 1
116+
mark_message = "; Correct match."
117+
else:
118+
mark_message = "; Incorrect match. Should be {} {}".format(lb[i], classes.imagenet_classes[lb[i]] )
114119
i += 1
115-
print("Detected:", ma, " Should be:", label)
120+
print("\t",i, classes.imagenet_classes[ma],ma, mark_message)
116121

117122
latency = np.average(processing_times)
118123
accuracy = matched/i

extras/ovms-operator/tests/README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,16 @@ Prerequisites:
2626
export REGISTRY=quay.io
2727
export IMG_BUNDLE=$REGISTRY/ovms-operator-bundle:latest
2828
export IMG_CATALOG=$REGISTRY/test-catalog:latest
29-
git clone -b ovms-operator https://github.com/community-operators
29+
git clone https://github.com/operator-framework/community-operators
3030
cd community-operators/upstream-community-operators/ovms-operator/0.1.0
3131

3232
# edit manifests/ovms-operator.clusterserviceversion.yaml and set image: to point to the test operator image
3333

3434
podman build -t $IMG_BUNDLE .
35-
podman push $IMG_BUNDLE
36-
opm index add --bundles $IMG_BUNDLE --from-index quay.io/operatorhubio/catalog:latest --tag $IMG_CATALOG
35+
podman build -t $IMG_BUNDLE .
36+
podman build -t $IMG_BUNDLE .
37+
or
38+
opm index add --bundles $IMG_BUNDLE --from-index registry.redhat.io/redhat/community-operator-index:v4.7 -p podman --tag $IMG_CATALOG
3739
podman push $IMG_CATALOG
3840
```
3941

0 commit comments

Comments
 (0)