diff --git a/docs/install_guides/installing-openvino-apt.md b/docs/install_guides/installing-openvino-apt.md index 6dee8f9f19e..857f86f0143 100644 --- a/docs/install_guides/installing-openvino-apt.md +++ b/docs/install_guides/installing-openvino-apt.md @@ -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 diff --git a/docs/install_guides/installing-openvino-conan.md b/docs/install_guides/installing-openvino-conan.md new file mode 100644 index 00000000000..e264a557fa4 --- /dev/null +++ b/docs/install_guides/installing-openvino-conan.md @@ -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 `__ + + .. 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 `__ + + .. 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 `__ + +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 `__ + 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= -DCMAKE_BUILD_TYPE=Release -S -B + cmake --build --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 `__. +* Learn more about :doc:`OpenVINO Workflow `. +* To prepare your models for working with OpenVINO, see :doc:`Model Preparation `. +* Learn more about :doc:`Inference with OpenVINO Runtime `. +* See sample applications in :doc:`OpenVINO toolkit Samples Overview `. +* Check out the OpenVINO product `home page `__. + + +@endsphinxdirective + diff --git a/docs/install_guides/installing-openvino-conda.md b/docs/install_guides/installing-openvino-conda.md index dd76f8b980c..bed553e73ad 100644 --- a/docs/install_guides/installing-openvino-conda.md +++ b/docs/install_guides/installing-openvino-conda.md @@ -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:: diff --git a/docs/install_guides/installing-openvino-docker-linux.md b/docs/install_guides/installing-openvino-docker-linux.md index 740e3b0371e..6c7a98d5ea3 100644 --- a/docs/install_guides/installing-openvino-docker-linux.md +++ b/docs/install_guides/installing-openvino-docker-linux.md @@ -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) `__ * `Azure Marketplace `__ -You can use the `available Dockerfiles on GitHub `__ or generate a Dockerfile with your settings via `DockerHub CI framework `__ , 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 `__ and how to use `OpenVINO™ Toolkit containers with GPU accelerators. `__ +You can use the `available Dockerfiles on GitHub `__ +or generate a Dockerfile with your settings via `DockerHub CI framework `__, +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 `__ and how to use +`OpenVINO™ Toolkit containers with GPU accelerators. `__ 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 `__ and :doc:`Bare Metal ` distributions are identical, so the documentation applies to both. + OpenVINO's `Docker `__ and :doc:`Bare Metal ` + distributions are identical, so the documentation applies to both. .. note:: - OpenVINO development environment in a docker container is also available in the `notebook repository `__ . It can be implemented in `OpenShift RedHat OpenData Science (RHODS) `__. + OpenVINO development environment in a docker container is also available in the + `notebook repository `__. It can be implemented in + `OpenShift RedHat OpenData Science (RHODS) `__. -More information about Docker CI for Intel® Distribution of OpenVINO™ toolset can be found `here `__ +More information about Docker CI for Intel® Distribution of OpenVINO™ toolset can be found +`here `__ * `Docker CI framework for Intel® Distribution of OpenVINO™ toolkit `__ * `Get Started with DockerHub CI for Intel® Distribution of OpenVINO™ toolkit `__ diff --git a/docs/install_guides/installing-openvino-from-archive-linux.md b/docs/install_guides/installing-openvino-from-archive-linux.md index ace3fd5a424..c1fca784238 100644 --- a/docs/install_guides/installing-openvino-from-archive-linux.md +++ b/docs/install_guides/installing-openvino-from-archive-linux.md @@ -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). diff --git a/docs/install_guides/installing-openvino-from-archive-macos.md b/docs/install_guides/installing-openvino-from-archive-macos.md index c2d95fa7180..0a3928d985a 100644 --- a/docs/install_guides/installing-openvino-from-archive-macos.md +++ b/docs/install_guides/installing-openvino-from-archive-macos.md @@ -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:: diff --git a/docs/install_guides/installing-openvino-from-archive-windows.md b/docs/install_guides/installing-openvino-from-archive-windows.md index 2193e78df60..108d562942d 100644 --- a/docs/install_guides/installing-openvino-from-archive-windows.md +++ b/docs/install_guides/installing-openvino-from-archive-windows.md @@ -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 diff --git a/docs/install_guides/installing-openvino-linux-header.md b/docs/install_guides/installing-openvino-linux-header.md index a45b11d20e2..661e7694071 100644 --- a/docs/install_guides/installing-openvino-linux-header.md +++ b/docs/install_guides/installing-openvino-linux-header.md @@ -19,6 +19,7 @@ Use Conda Forge Use vcpkg Use Homebrew + Use Conan Use Docker @@ -32,6 +33,7 @@ If you want to install OpenVINO™ Runtime on Linux, you have the following opti * :doc:`Install OpenVINO using vcpkg ` * :doc:`Install OpenVINO using Homebrew ` * :doc:`Install OpenVINO using Docker ` +* :doc:`Install OpenVINO using Conan Package Manager ` diff --git a/docs/install_guides/installing-openvino-macos-header.md b/docs/install_guides/installing-openvino-macos-header.md index 2e0d70b61d0..aa9697f1a34 100644 --- a/docs/install_guides/installing-openvino-macos-header.md +++ b/docs/install_guides/installing-openvino-macos-header.md @@ -17,6 +17,7 @@ Use PyPI Use Conda Forge Use vcpkg + Use 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 ` * :doc:`Install OpenVINO using Homebrew ` * :doc:`Install OpenVINO using vcpkg ` +* :doc:`Install OpenVINO using Conan Package Manager ` diff --git a/docs/install_guides/installing-openvino-overview.md b/docs/install_guides/installing-openvino-overview.md index 13201da5f8f..c703ee38615 100644 --- a/docs/install_guides/installing-openvino-overview.md +++ b/docs/install_guides/installing-openvino-overview.md @@ -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, diff --git a/docs/install_guides/installing-openvino-pip.md b/docs/install_guides/installing-openvino-pip.md index 01fe7e50d21..1356373d1b5 100644 --- a/docs/install_guides/installing-openvino-pip.md +++ b/docs/install_guides/installing-openvino-pip.md @@ -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:: diff --git a/docs/install_guides/installing-openvino-vcpkg.md b/docs/install_guides/installing-openvino-vcpkg.md index eb508a520f2..8202d3f7fc1 100644 --- a/docs/install_guides/installing-openvino-vcpkg.md +++ b/docs/install_guides/installing-openvino-vcpkg.md @@ -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:: diff --git a/docs/install_guides/installing-openvino-windows-header.md b/docs/install_guides/installing-openvino-windows-header.md index 62e2fb01638..73b11591046 100644 --- a/docs/install_guides/installing-openvino-windows-header.md +++ b/docs/install_guides/installing-openvino-windows-header.md @@ -17,6 +17,8 @@ Use Conda Forge Use vcpkg Use Docker + Use 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 ` * :doc:`Install OpenVINO using vcpkg ` * :doc:`Install OpenVINO using Docker ` +* :doc:`Install OpenVINO using Conan Package Manager ` @endsphinxdirective diff --git a/docs/install_guides/installing-openvino-yum.md b/docs/install_guides/installing-openvino-yum.md index 0a71adce6b3..8c984c379b2 100644 --- a/docs/install_guides/installing-openvino-yum.md +++ b/docs/install_guides/installing-openvino-yum.md @@ -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::