Publishing 2019 R1 content
[platform/upstream/dldt.git] / tools / benchmark / README.md
1 # OpenVINO™ Benchmark Python* package
2 Inference Engine `openvino.tools.benchmark` Python\* package consists types to measure synchronous mode latency.  
3 The package depends on `openvino.tools.accuracy_checker` the package.
4
5 Please, refer to https://docs.openvinotoolkit.org for details.
6
7 ## Usage
8 You can use the `openvino.tools.calibration` package in a simple way:
9 ```Python
10 import openvino.tools.benchmark as benchmark
11
12 config = benchmark.CommandLineReader.read()
13 result = benchmark.Benchmark(config).run()
14 print("{0}: {1:.4} ms".format(config.model, result.latency * 1000.0))
15 ```
16 ### Explanation
17 1. Import `openvino.tools.benchmark` types:
18 ```Python
19 import openvino.tools.benchmark as benchmark
20 ```
21
22 2. Read configuration and execute the benchmark:
23 ```Python
24 config = benchmark.CommandLineReader.read()
25 result = benchmark.Benchmark(config).run()
26 ```
27
28 3. Print results:
29 ```Python
30 print("{0}: {1:.4} ms".format(config.model, result.latency * 1000.0))
31 ```