Skip to content

Commit

Permalink
[DOCS] pdf reference guide (openvinotoolkit#23680)
Browse files Browse the repository at this point in the history
  • Loading branch information
kblaszczak-intel authored Mar 27, 2024
1 parent fc5da9d commit 3ba9ff1
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 26 deletions.
5 changes: 5 additions & 0 deletions docs/articles_en/get-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ GET STARTED
</p>
<div style="clear:both;"> </div>


For a quick reference, check out
`the Quick Start Guide [pdf] <https://docs.openvino.ai/2024/_static/download/OpenVINO_Quick_Start_Guide.pdf>`__


.. _quick-start-example:

1. Quick Start Example (No Installation Required)
Expand Down
3 changes: 3 additions & 0 deletions docs/articles_en/openvino-workflow/model-preparation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ The easiest way to obtain a model is to download it from an online database, suc
This option, while convenient, offers lower performance and stability, as well as fewer
optimization options.

For PyTorch models, you can use the dedicated :doc:`torch.compile <./torch-compile>`
implementation.

* Explicitly :doc:`convert the model to OpenVINO IR <model-preparation/convert-model-to-ir>`.
This approach offers the best possible results and is the recommended one, especially for
production-ready solutions. Consider storing your model in this format to minimize
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,11 @@ Integrate OpenVINO™ with Your Application
Runtime in an application.


Following these steps, you can implement a typical OpenVINO™ Runtime inference
pipeline in your application. Before proceeding, make sure you have
:doc:`installed OpenVINO Runtime <../../get-started/install-openvino>` and set environment variables (run ``<INSTALL_DIR>/setupvars.sh`` for Linux, ``setupvars.ps1`` for Windows PowerShell, or ``setupvars.bat`` for Windows CMD), otherwise, the ``OpenVINO_DIR`` variable won't be configured properly to pass ``find_package`` calls).
Following these steps, you can implement a typical OpenVINO™ Runtime inference pipeline in your
application. Before proceeding, make sure you have :doc:`installed OpenVINO Runtime <../../get-started/install-openvino>`
and set environment variables (run ``<INSTALL_DIR>/setupvars.sh`` for Linux, ``setupvars.ps1``
for Windows PowerShell, or ``setupvars.bat`` for Windows CMD). Otherwise, the ``OpenVINO_DIR``
variable won't be configured properly to pass ``find_package`` calls.


.. image:: ../../_static/images/IMPLEMENT_PIPELINE_with_API_C.svg
Expand All @@ -30,7 +32,8 @@ pipeline in your application. Before proceeding, make sure you have
Step 1. Create OpenVINO Runtime Core
####################################

Include next files to work with OpenVINO™ Runtime:
Include the necessary files to work with OpenVINO™ Runtime and create OpenVINO™ Core to manage
available devices and read model objects:

.. tab-set::

Expand All @@ -41,47 +44,34 @@ Include next files to work with OpenVINO™ Runtime:
:language: python
:fragment: [import]

.. tab-item:: C++
:sync: cpp

.. doxygensnippet:: docs/snippets/src/main.cpp
:language: cpp
:fragment: [include]

.. tab-item:: C
:sync: c

.. doxygensnippet:: docs/snippets/src/main.c
:language: cpp
:fragment: [include]


Use the following code to create OpenVINO™ Core to manage available devices and read model objects:

.. tab-set::

.. tab-item:: Python
:sync: py

.. doxygensnippet:: docs/snippets/src/main.py
:language: python
:fragment: [part1]

.. tab-item:: C++
:sync: cpp

.. doxygensnippet:: docs/snippets/src/main.cpp
:language: cpp
:fragment: [include]

.. doxygensnippet:: docs/snippets/src/main.cpp
:language: cpp
:fragment: [part1]

.. tab-item:: C
:sync: c

.. doxygensnippet:: docs/snippets/src/main.c
:language: cpp
:fragment: [include]

.. doxygensnippet:: docs/snippets/src/main.c
:language: cpp
:fragment: [part1]



Step 2. Compile the Model
#########################

Expand Down
Binary file not shown.

0 comments on commit 3ba9ff1

Please sign in to comment.