174 lines
5.2 KiB
ReStructuredText
174 lines
5.2 KiB
ReStructuredText
.. {#openvino_sample_sync_benchmark}
|
|
|
|
Sync Benchmark Sample
|
|
=====================
|
|
|
|
|
|
.. meta::
|
|
:description: Learn how to estimate performance of a model using Synchronous Inference Request API (Python, C++).
|
|
|
|
|
|
This sample demonstrates how to estimate performance of a model using Synchronous
|
|
Inference Request API. It makes sense to use synchronous inference only in latency
|
|
oriented scenarios. Models with static input shapes are supported. Unlike
|
|
`demos <https://docs.openvino.ai/2024/omz_demos.html>`__ this sample does not have other configurable command-line
|
|
arguments. Feel free to modify sample's source code to try out different options.
|
|
Before using the sample, refer to the following requirements:
|
|
|
|
- The sample accepts any file format supported by ``core.read_model``.
|
|
- The sample has been validated with: `yolo-v3-tf <https://docs.openvino.ai/2024/omz_models_model_yolo_v3_tf.html>`__,
|
|
`face-detection-0200 <https://docs.openvino.ai/2024/omz_models_model_face_detection_0200.html>`__ models.
|
|
- To build the sample, use instructions available at :ref:`Build the Sample Applications <build-samples>`
|
|
section in "Get Started with Samples" guide.
|
|
|
|
How It Works
|
|
####################
|
|
|
|
The sample compiles a model for a given device, randomly generates input data,
|
|
performs synchronous inference multiple times for a given number of seconds.
|
|
Then, it processes and reports performance results.
|
|
|
|
.. tab-set::
|
|
|
|
.. tab-item:: Python
|
|
:sync: python
|
|
|
|
.. scrollbox::
|
|
|
|
.. doxygensnippet:: samples/python/benchmark/sync_benchmark/sync_benchmark.py
|
|
:language: python
|
|
|
|
.. tab-item:: C++
|
|
:sync: cpp
|
|
|
|
.. scrollbox::
|
|
|
|
.. doxygensnippet:: samples/cpp/benchmark/sync_benchmark/main.cpp
|
|
:language: cpp
|
|
|
|
|
|
You can see the explicit description of
|
|
each sample step at :doc:`Integration Steps <../../openvino-workflow/running-inference/integrate-openvino-with-your-application>`
|
|
section of "Integrate OpenVINO™ Runtime with Your Application" guide.
|
|
|
|
Running
|
|
####################
|
|
|
|
.. tab-set::
|
|
|
|
.. tab-item:: Python
|
|
:sync: python
|
|
|
|
.. code-block:: console
|
|
|
|
python sync_benchmark.py <path_to_model> <device_name>(default: CPU)
|
|
|
|
.. tab-item:: C++
|
|
:sync: cpp
|
|
|
|
.. code-block:: console
|
|
|
|
sync_benchmark <path_to_model> <device_name>(default: CPU)
|
|
|
|
|
|
To run the sample, you need to specify a model. You can get a model specific for
|
|
your inference task from one of model repositories, such as TensorFlow Zoo, HuggingFace, or TensorFlow Hub.
|
|
|
|
Example
|
|
++++++++++++++++++++
|
|
|
|
1. Download a pre-trained model.
|
|
2. You can convert it by using:
|
|
|
|
.. tab-set::
|
|
|
|
.. tab-item:: Python
|
|
:sync: python
|
|
|
|
.. code-block:: python
|
|
|
|
import openvino as ov
|
|
|
|
ov_model = ov.convert_model('./models/googlenet-v1')
|
|
# or, when model is a Python model object
|
|
ov_model = ov.convert_model(googlenet-v1)
|
|
|
|
.. tab-item:: CLI
|
|
:sync: cli
|
|
|
|
.. code-block:: console
|
|
|
|
ovc ./models/googlenet-v1
|
|
|
|
3. Perform benchmarking, using the ``googlenet-v1`` model on a ``CPU``:
|
|
|
|
.. tab-set::
|
|
|
|
.. tab-item:: Python
|
|
:sync: python
|
|
|
|
.. code-block:: console
|
|
|
|
python sync_benchmark.py googlenet-v1.xml
|
|
|
|
.. tab-item:: C++
|
|
:sync: cpp
|
|
|
|
.. code-block:: console
|
|
|
|
sync_benchmark googlenet-v1.xml
|
|
|
|
|
|
Sample Output
|
|
####################
|
|
|
|
|
|
.. tab-set::
|
|
|
|
.. tab-item:: Python
|
|
:sync: python
|
|
|
|
The application outputs performance results.
|
|
|
|
.. code-block:: console
|
|
|
|
[ INFO ] OpenVINO:
|
|
[ INFO ] Build ................................. <version>
|
|
[ INFO ] Count: 2333 iterations
|
|
[ INFO ] Duration: 10003.59 ms
|
|
[ INFO ] Latency:
|
|
[ INFO ] Median: 3.90 ms
|
|
[ INFO ] Average: 4.29 ms
|
|
[ INFO ] Min: 3.30 ms
|
|
[ INFO ] Max: 10.11 ms
|
|
[ INFO ] Throughput: 233.22 FPS
|
|
|
|
.. tab-item:: C++
|
|
:sync: cpp
|
|
|
|
The application outputs performance results.
|
|
|
|
.. code-block:: console
|
|
|
|
[ INFO ] OpenVINO:
|
|
[ INFO ] Build ................................. <version>
|
|
[ INFO ] Count: 992 iterations
|
|
[ INFO ] Duration: 15009.8 ms
|
|
[ INFO ] Latency:
|
|
[ INFO ] Median: 14.00 ms
|
|
[ INFO ] Average: 15.13 ms
|
|
[ INFO ] Min: 9.33 ms
|
|
[ INFO ] Max: 53.60 ms
|
|
[ INFO ] Throughput: 66.09 FPS
|
|
|
|
|
|
Additional Resources
|
|
####################
|
|
|
|
- :doc:`Integrate the OpenVINO™ Runtime with Your Application <../../openvino-workflow/running-inference/integrate-openvino-with-your-application>`
|
|
- :doc:`Get Started with Samples <get-started-demos>`
|
|
- :doc:`Using OpenVINO Samples <../openvino-samples>`
|
|
- :doc:`Convert a Model <../../documentation/legacy-features/transition-legacy-conversion-api/legacy-conversion-api>`
|
|
- `Sync Benchmark Python Sample on Github <https://github.com/openvinotoolkit/openvino/blob/master/samples/python/benchmark/sync_benchmark/README.md>`__
|
|
- `Sync Benchmark C++ Sample on Github <https://github.com/openvinotoolkit/openvino/blob/master/samples/cpp/benchmark/sync_benchmark/README.md>`__
|