IntenseWebs/openvino
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Conan guide with fixes (#20259)

Browse Source
This commit is contained in:
Maciej Smyk
2023-10-05 13:01:42 +02:00
committed by GitHub
parent 4c868cc909
commit bb61694403
14 changed files with 139 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/install_guides/installing-openvino-apt.md
View File

@@ -12,6 +12,7 @@
* offers both C/C++ and Python APIs
* does not offer support for GNA and NPU inference
* is dedicated to Linux users only
* additionally includes code samples

98
docs/install_guides/installing-openvino-conan.md Normal file
View File

@@ -0,0 +1,98 @@
# Install OpenVINO™ Runtime from Conan Package Manager {#openvino_docs_install_guides_installing_openvino_conan}
@sphinxdirective
.. meta::
:description: Learn how to install OpenVINO™ Runtime on Windows, Linux, and
macOS operating systems, using Conan Package Manager.
.. note::
Note that the Conan Package Manager distribution:
* offers C/C++ API only
* does not offer support for GNA and NPU inference
* is dedicated to users of all major OSes: Windows, Linux, and macOS
(all x86_64 / arm64 architectures)
.. tab-set::
.. tab-item:: System Requirements
:sync: system-requirements
Full requirement listing is available in:
`System Requirements Page <https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/system-requirements.html>`__
.. tab-item:: Processor Notes
:sync: processor-notes
To see if your processor includes the integrated graphics technology and supports iGPU inference, refer to:
`Product Specifications <https://ark.intel.com/content/www/us/en/ark.html>`__
.. tab-item:: Software
:sync: software
There are many ways to work with Conan Package Manager. Before you proceed, learn more about it on the
`Conan distribution page <https://conan.io/downloads>`__
Installing OpenVINO Runtime with Conan Package Manager
############################################################
1. Install Conan 2.0.8 or higher:
.. code-block:: console
python3 -m pip install conan
2. Create a ``conanfile.txt`` file for your OpenVINO project and add "*openvino*" dependency in there:
.. code-block:: console
[requires]
openvino/2023.1.0
[generators]
CMakeDeps
CMakeToolchain
[layout]
cmake_layout
Run the command below to create ``conan_toolchain.cmake`` file, which will be used to compile your project with OpenVINO:
.. code-block:: console
conan install conanfile.txt --build=missing
By default, OpenVINO is statically compiled, together with all available
plugins and frontends. To build a version tailored to your needs, check
what options there are on the `Conan Package Manager page for OpenVINO <https://conan.io/center/recipes/openvino>`__
and extend the command, like so:
.. code-block:: console
conan install conanfile.txt --build=missing -o:h openvino/*:enable_intel_gpu=False -o:h openvino/*:enable_onnx_frontend=False' -o:h openvino/*:shared=True.
3. Configure and compile your project with OpenVINO:
.. code-block:: console
cmake -DCMAKE_TOOLCHAIN_FILE=<path to conan_toolchain.cmake> -DCMAKE_BUILD_TYPE=Release -S <path to CMakeLists.txt of your project> -B <build dir>
cmake --build <build dir> --parallel
.. note::
OpenVINO can be used with any build interface, as long as it is supported by Conan 2.0.
Additional Resources
########################
* `Conan Package Manager <https://conan.io>`__.
* Learn more about :doc:`OpenVINO Workflow <openvino_workflow>`.
* To prepare your models for working with OpenVINO, see :doc:`Model Preparation <openvino_docs_model_processing_introduction>`.
* Learn more about :doc:`Inference with OpenVINO Runtime <openvino_docs_OV_UG_OV_Runtime_User_Guide>`.
* See sample applications in :doc:`OpenVINO toolkit Samples Overview <openvino_docs_OV_UG_Samples_Overview>`.
* Check out the OpenVINO product `home page <https://software.intel.com/en-us/openvino-toolkit>`__.
@endsphinxdirective

4
docs/install_guides/installing-openvino-conda.md
View File

@@ -13,8 +13,8 @@
* offers both C/C++ and Python APIs
* does not offer support for GNA and NPU inference
* is dedicated to users of all major OSs: Windows, Linux, macOS and x86_64 / arm64 architectures
* is dedicated to users of all major OSes: Windows, Linux, and macOS
(all x86_64 / arm64 architectures)
.. tab-set::

20
docs/install_guides/installing-openvino-docker-linux.md
View File

@@ -6,7 +6,7 @@
:description: Learn how to use a prebuilt Docker image or create an image
manually to install OpenVINO™ Runtime on Linux and Windows operating systems.
This guide presents infromation on how to use a pre-built Docker image/create an image manually to install OpenVINO™ Runtime.
This guide presents information on how to use a pre-built Docker image/create an image manually to install OpenVINO™ Runtime.
Supported host operating systems for the Docker Base image:
@@ -22,7 +22,13 @@ You can get started easily with pre-built and published docker images, which are
* `Red Hat Ecosystem Catalog (development image) <https://catalog.redhat.com/software/containers/intel/openvino-dev/613a450dc9bc35f21dc4a1f7>`__
* `Azure Marketplace <https://azuremarketplace.microsoft.com/en-us/marketplace/apps/intel_corporation.openvino>`__
You can use the `available Dockerfiles on GitHub <https://github.com/openvinotoolkit/docker_ci/tree/master/dockerfiles>`__ or generate a Dockerfile with your settings via `DockerHub CI framework <https://github.com/openvinotoolkit/docker_ci/>`__ , which can generate a Dockerfile, build, test, and deploy an image using the Intel® Distribution of OpenVINO™ toolkit. You can reuse available Dockerfiles, add your layer and customize the OpenVINO™ image to your needs. Docker CI repository includes guides on how to how to `get started with docker images <https://github.com/openvinotoolkit/docker_ci/blob/master/get-started.md>`__ and how to use `OpenVINO™ Toolkit containers with GPU accelerators. <https://github.com/openvinotoolkit/docker_ci/blob/master/docs/accelerators.md>`__
You can use the `available Dockerfiles on GitHub <https://github.com/openvinotoolkit/docker_ci/tree/master/dockerfiles>`__
or generate a Dockerfile with your settings via `DockerHub CI framework <https://github.com/openvinotoolkit/docker_ci/>`__,
which can generate a Dockerfile, build, test, and deploy an image using the Intel® Distribution of OpenVINO™ toolkit.
You can reuse available Dockerfiles, add your layer and customize the OpenVINO™ image to your needs.
The Docker CI repository includes guides on how to
`get started with docker images <https://github.com/openvinotoolkit/docker_ci/blob/master/get-started.md>`__ and how to use
`OpenVINO™ Toolkit containers with GPU accelerators. <https://github.com/openvinotoolkit/docker_ci/blob/master/docs/accelerators.md>`__
To start using Dockerfiles the following conditions must be met:
@@ -32,13 +38,17 @@ To start using Dockerfiles the following conditions must be met:
.. note::
OpenVINO's `Docker <https://docs.docker.com/>`__ and :doc:`Bare Metal <openvino_docs_install_guides_overview>` distributions are identical, so the documentation applies to both.
OpenVINO's `Docker <https://docs.docker.com/>`__ and :doc:`Bare Metal <openvino_docs_install_guides_overview>`
distributions are identical, so the documentation applies to both.
.. note::
OpenVINO development environment in a docker container is also available in the `notebook repository <https://github.com/openvinotoolkit/openvino_notebooks>`__ . It can be implemented in `OpenShift RedHat OpenData Science (RHODS) <https://github.com/openvinotoolkit/operator/blob/main/docs/notebook_in_rhods.md>`__.
OpenVINO development environment in a docker container is also available in the
`notebook repository <https://github.com/openvinotoolkit/openvino_notebooks>`__. It can be implemented in
`OpenShift RedHat OpenData Science (RHODS) <https://github.com/openvinotoolkit/operator/blob/main/docs/notebook_in_rhods.md>`__.
More information about Docker CI for Intel® Distribution of OpenVINO™ toolset can be found `here <https://github.com/openvinotoolkit/docker_ci/blob/master/README.md>`__
More information about Docker CI for Intel® Distribution of OpenVINO™ toolset can be found
`here <https://github.com/openvinotoolkit/docker_ci/blob/master/README.md>`__
* `Docker CI framework for Intel® Distribution of OpenVINO™ toolkit <https://github.com/openvinotoolkit/docker_ci/blob/master/README.md>`__
* `Get Started with DockerHub CI for Intel® Distribution of OpenVINO™ toolkit <https://github.com/openvinotoolkit/docker_ci/blob/master/get-started.md>`__

2
docs/install_guides/installing-openvino-from-archive-linux.md
View File

@@ -13,7 +13,7 @@
* offers both C/C++ and Python APIs
* additionally includes code samples
* is dedicated to users of all major OSs: Windows, Linux, macOS and x86_64 / arm64 architectures
* is dedicated to Linux users (archives for other systems are also available)
* may offer different hardware support under different operating systems
(see the drop-down below for more details).

2
docs/install_guides/installing-openvino-from-archive-macos.md
View File

@@ -13,7 +13,7 @@
* offers both C/C++ and Python APIs
* additionally includes code samples
* is dedicated to users of all major OSs: Windows, Linux, macOS
* is dedicated to macOS users (archives for other systems are also available)
.. tab-set::

2
docs/install_guides/installing-openvino-from-archive-windows.md
View File

@@ -13,7 +13,7 @@
* offers both C/C++ and Python APIs
* additionally includes code samples
* is dedicated to users of all major OSs: Windows, Linux, macOS
* is dedicated to Windows users (archives for other systems are also available)
System Requirements

2
docs/install_guides/installing-openvino-linux-header.md
View File

@@ -19,6 +19,7 @@
Use Conda Forge <openvino_docs_install_guides_installing_openvino_conda>
Use vcpkg <openvino_docs_install_guides_installing_openvino_vcpkg>
Use Homebrew <openvino_docs_install_guides_installing_openvino_brew>
Use Conan <openvino_docs_install_guides_installing_openvino_conan>
Use Docker <openvino_docs_install_guides_installing_openvino_docker>
@@ -32,6 +33,7 @@ If you want to install OpenVINO™ Runtime on Linux, you have the following opti
* :doc:`Install OpenVINO using vcpkg <openvino_docs_install_guides_installing_openvino_vcpkg>`
* :doc:`Install OpenVINO using Homebrew <openvino_docs_install_guides_installing_openvino_brew>`
* :doc:`Install OpenVINO using Docker <openvino_docs_install_guides_installing_openvino_docker>`
* :doc:`Install OpenVINO using Conan Package Manager <openvino_docs_install_guides_installing_openvino_conan>`

2
docs/install_guides/installing-openvino-macos-header.md
View File

@@ -17,6 +17,7 @@
Use PyPI <openvino_docs_install_guides_installing_openvino_pip>
Use Conda Forge <openvino_docs_install_guides_installing_openvino_conda>
Use vcpkg <openvino_docs_install_guides_installing_openvino_vcpkg>
Use Conan <openvino_docs_install_guides_installing_openvino_conan>
If you want to install OpenVINO™ Runtime on macOS, you have the following options:
@@ -27,6 +28,7 @@ If you want to install OpenVINO™ Runtime on macOS, you have the following opti
* :doc:`Install OpenVINO using Conda Forge <openvino_docs_install_guides_installing_openvino_conda>`
* :doc:`Install OpenVINO using Homebrew <openvino_docs_install_guides_installing_openvino_brew>`
* :doc:`Install OpenVINO using vcpkg <openvino_docs_install_guides_installing_openvino_vcpkg>`
* :doc:`Install OpenVINO using Conan Package Manager <openvino_docs_install_guides_installing_openvino_conan>`

16
docs/install_guides/installing-openvino-overview.md
View File

@@ -47,14 +47,14 @@
.. dropdown:: Distribution Comparison for OpenVINO 2023.1
=============== ========== ====== ========= ======== ============ ==========
Device Archives PyPI APT/YUM Conda Homebrew vcpkg
=============== ========== ====== ========= ======== ============ ==========
CPU V V V V V V
GPU V V V V V V
GNA V n/a n/a n/a n/a n/a
NPU V n/a n/a n/a n/a n/a
=============== ========== ====== ========= ======== ============ ==========
=============== ========== ====== ========= ======== ============ ========== ==========
Device Archives PyPI APT/YUM Conda Homebrew vcpkg Conan
=============== ========== ====== ========= ======== ============ ========== ==========
CPU V V V V V V V
GPU V V V V V V V
GNA V n/a n/a n/a n/a n/a n/a
NPU V n/a n/a n/a n/a n/a n/a
=============== ========== ====== ========= ======== ============ ========== ==========
| **Build OpenVINO from source**
| OpenVINO Toolkit source files are available on GitHub as open source. If you want to build your own version of OpenVINO for your platform,

3
docs/install_guides/installing-openvino-pip.md
View File

@@ -13,7 +13,8 @@
* offers the Python API only
* does not offer support for GNA and NPU inference
* is dedicated to users of all major OSs: Windows, Linux, macOS and x86_64 / arm64 architectures
* is dedicated to users of all major OSes: Windows, Linux, and macOS
(all x86_64 / arm64 architectures)
.. tab-set::

3
docs/install_guides/installing-openvino-vcpkg.md
View File

@@ -12,7 +12,8 @@
* offers C/C++ API only
* does not offer support for GNA and NPU inference
* is dedicated to users of all major OSs: Windows, Linux, macOS and x86_64 / arm64 architectures.
* is dedicated to users of all major OSes: Windows, Linux, and macOS
(all x86_64 / arm64 architectures)
.. tab-set::

3
docs/install_guides/installing-openvino-windows-header.md
View File

@@ -17,6 +17,8 @@
Use Conda Forge <openvino_docs_install_guides_installing_openvino_conda>
Use vcpkg <openvino_docs_install_guides_installing_openvino_vcpkg>
Use Docker <openvino_docs_install_guides_installing_openvino_docker>
Use Conan <openvino_docs_install_guides_installing_openvino_conan>
If you want to install OpenVINO™ Runtime on Windows, you have the following options:
@@ -26,6 +28,7 @@ If you want to install OpenVINO™ Runtime on Windows, you have the following op
* :doc:`Install OpenVINO using Conda Forge <openvino_docs_install_guides_installing_openvino_conda>`
* :doc:`Install OpenVINO using vcpkg <openvino_docs_install_guides_installing_openvino_vcpkg>`
* :doc:`Install OpenVINO using Docker <openvino_docs_install_guides_installing_openvino_docker>`
* :doc:`Install OpenVINO using Conan Package Manager <openvino_docs_install_guides_installing_openvino_conan>`
@endsphinxdirective

1
docs/install_guides/installing-openvino-yum.md
View File

@@ -12,6 +12,7 @@
* offers C/C++ APIs only
* does not offer support for GNA and NPU inference
* is dedicated to Linux users only
* additionally includes code samples
.. tab-set::