From c4c6fddf6f92da6ce7cec7672f6a1b6b9417572d Mon Sep 17 00:00:00 2001 From: Karol Blaszczak Date: Fri, 13 Oct 2023 18:44:48 +0200 Subject: [PATCH] [DOCS] - system requirements and resources reorg (#20088) --- docs/articles_en/about_openvino.md | 26 +++ .../about_openvino/additional_resources.md} | 28 +--- .../telemetry_information.md | 0 .../tensorflow_frontend.md | 0 .../compatibility_and_support.md | 25 +++ .../about_openvino/release_notes.md | 18 --- .../about_openvino/system_requirements.md | 151 ++++++++++++++++++ docs/articles_en/get_started.md | 1 + docs/home.rst | 4 +- 9 files changed, 205 insertions(+), 48 deletions(-) create mode 100644 docs/articles_en/about_openvino.md rename docs/{resources/resources.md => articles_en/about_openvino/additional_resources.md} (50%) rename docs/{resources => articles_en/about_openvino/additional_resources}/telemetry_information.md (100%) rename docs/{resources => articles_en/about_openvino/additional_resources}/tensorflow_frontend.md (100%) create mode 100644 docs/articles_en/about_openvino/compatibility_and_support.md delete mode 100644 docs/articles_en/about_openvino/release_notes.md create mode 100644 docs/articles_en/about_openvino/system_requirements.md diff --git a/docs/articles_en/about_openvino.md b/docs/articles_en/about_openvino.md new file mode 100644 index 00000000000..37545223e8b --- /dev/null +++ b/docs/articles_en/about_openvino.md @@ -0,0 +1,26 @@ +# About OpenVINO {#about_openvino} + +@sphinxdirective + +.. toctree:: + :maxdepth: 1 + :hidden: + + openvino_docs_performance_benchmarks + compatibility_and_support + Release Notes + prerelease_information + system_requirements + Additional Resources + +OpenVINO is a toolkit for simple and efficient deployment of various deep learning models. +In this section you will find information on the product itself, as well as the software +and hardware solutions it supports. + + + + + + + +@endsphinxdirective diff --git a/docs/resources/resources.md b/docs/articles_en/about_openvino/additional_resources.md similarity index 50% rename from docs/resources/resources.md rename to docs/articles_en/about_openvino/additional_resources.md index bc4a8240875..f824cbff435 100644 --- a/docs/resources/resources.md +++ b/docs/articles_en/about_openvino/additional_resources.md @@ -1,4 +1,4 @@ -# Resources {#resources} +# Additional Resources {#resources} @sphinxdirective @@ -7,21 +7,6 @@ :description: Learn more about OpenVINO from benchmark results, case studies and lists of supported models, operations and devices. -.. toctree:: - :maxdepth: 1 - :hidden: - - openvino_docs_performance_benchmarks - -.. toctree:: - :maxdepth: 1 - :hidden: - - openvino_docs_OV_UG_supported_plugins_Supported_Devices - openvino_supported_models - openvino_resources_supported_operations - openvino_resources_supported_operations_frontend - .. toctree:: :maxdepth: 1 :hidden: @@ -32,19 +17,8 @@ Case Studies -This section includes a variety of reference information focusing mostly on describing OpenVINO -and its proprietary model format, OpenVINO IR. - :doc:`Performance Benchmarks ` contain results from benchmarking models with OpenVINO on Intel hardware. -:doc:`Supported Devices ` is compatibility information about supported hardware accelerators. - -:doc:`Supported Models ` is a table of models officially supported by OpenVINO. - -:doc:`Supported Operations ` is a listing of framework layers supported by OpenVINO. - -:doc:`Supported Operations ` is a listing of layers supported by OpenVINO inference devices. - :doc:`Glossary ` contains terms used in OpenVINO. :doc:`Legal Information ` has trademark information and other legal statements. diff --git a/docs/resources/telemetry_information.md b/docs/articles_en/about_openvino/additional_resources/telemetry_information.md similarity index 100% rename from docs/resources/telemetry_information.md rename to docs/articles_en/about_openvino/additional_resources/telemetry_information.md diff --git a/docs/resources/tensorflow_frontend.md b/docs/articles_en/about_openvino/additional_resources/tensorflow_frontend.md similarity index 100% rename from docs/resources/tensorflow_frontend.md rename to docs/articles_en/about_openvino/additional_resources/tensorflow_frontend.md diff --git a/docs/articles_en/about_openvino/compatibility_and_support.md b/docs/articles_en/about_openvino/compatibility_and_support.md new file mode 100644 index 00000000000..904c4b7337d --- /dev/null +++ b/docs/articles_en/about_openvino/compatibility_and_support.md @@ -0,0 +1,25 @@ +# Compatibility and Support {#compatibility_and_support} + +@sphinxdirective + +.. toctree:: + :maxdepth: 1 + :hidden: + + openvino_supported_models + openvino_docs_OV_UG_supported_plugins_Supported_Devices + openvino_resources_supported_operations + openvino_resources_supported_operations_frontend + + +:doc:`Supported Devices ` - compatibility information for supported hardware accelerators. + +:doc:`Supported Models ` - a table of models officially supported by OpenVINO. + +:doc:`Supported Operations ` - a listing of framework layers supported by OpenVINO. + +:doc:`Supported Operations ` - a listing of layers supported by OpenVINO inference devices. + + + +@endsphinxdirective diff --git a/docs/articles_en/about_openvino/release_notes.md b/docs/articles_en/about_openvino/release_notes.md deleted file mode 100644 index 9d7427f919d..00000000000 --- a/docs/articles_en/about_openvino/release_notes.md +++ /dev/null @@ -1,18 +0,0 @@ -# Release Notes {#release_notes} - -@sphinxdirective - -.. raw:: html - - - - -.. toctree:: - :hidden: - - prerelease_information - -The official OpenVINO Release Notes are published at `www.intel.com `__ - - -@endsphinxdirective \ No newline at end of file diff --git a/docs/articles_en/about_openvino/system_requirements.md b/docs/articles_en/about_openvino/system_requirements.md new file mode 100644 index 00000000000..11cb8333265 --- /dev/null +++ b/docs/articles_en/about_openvino/system_requirements.md @@ -0,0 +1,151 @@ +# System Requirements {#system_requirements} + +@sphinxdirective + + +Certain hardware (including but not limited to GPU and GNA) requires manual +installation of specific drivers to work correctly. The drivers may also require +updates to the operating system, including Linux kernel. These updates need to +be handled by the user and are not part of OpenVINO installation. Refer to your +system's documentation for updating instructions. + + +Intel CPU processors +##################### + +.. tab-set:: + + .. tab-item:: Supported Hardware + + * Intel Atom® processor with Intel® SSE4.2 support + * Intel® Pentium® processor N4200/5, N3350/5, N3450/5 with Intel® HD Graphics + * 6th - 13th generation Intel® Core™ processors + * Intel® Xeon® Scalable Processors (code name Skylake) + * 2nd Generation Intel® Xeon® Scalable Processors (code name Cascade Lake) + * 3rd Generation Intel® Xeon® Scalable Processors (code name Cooper Lake and Ice Lake) + * 4th Generation Intel® Xeon® Scalable Processors (code name Sapphire Rapids) + + .. tab-item:: Required Operating Systems + + * Ubuntu 22.04 long-term support (LTS), 64-bit (Kernel 5.15+) + * Ubuntu 20.04 long-term support (LTS), 64-bit (Kernel 5.15+) + * Ubuntu 18.04 long-term support (LTS) with limitations, 64-bit (Kernel 5.4+) + * Windows* 10 + * Windows* 11 + * macOS* 10.15 and above, 64-bit + * Red Hat Enterprise Linux* 8, 64-bit + +Intel® Processor Graphics +########################################### + +.. tab-set:: + + .. tab-item:: Supported Hardware + + * Intel® HD Graphics + * Intel® UHD Graphics + * Intel® Iris® Pro Graphics + * Intel® Iris® Xe Graphics + * Intel® Iris® Xe Max Graphics + * Intel® Arc ™ GPU Series + * Intel® Data Center GPU Flex Series + + .. tab-item:: Required Operating Systems + + * Ubuntu* 22.04 long-term support (LTS), 64-bit + * Ubuntu* 20.04 long-term support (LTS), 64-bit + * Windows* 10, 64-bit + * Windows* 11, 64-bit + * Red Hat Enterprise Linux* 8, 64-bit + +.. note:: + + | Using a GPU requires installing drivers that are not included in the Intel® Distribution of OpenVINO™ toolkit. + | Not all Intel CPUs include the integrated graphics processor. See `Product Specifications `__ + for information about your processor. + | Although this release works with Ubuntu 20.04 for discrete graphic cards, the support is limited + due to discrete graphics drivers. + | Recommended `OpenCL™ driver `__ versions: + 22.43 for Ubuntu 22.04, 22.41 for Ubuntu 20.04 and 22.28 for Red Hat Enterprise Linux 8 + + +Intel® Gaussian & Neural Accelerator +########################################### + +Operating Systems: + +Ubuntu* 22.04 long-term support (LTS), 64-bit +Ubuntu* 20.04 long-term support (LTS), 64-bit +Windows* 10, 64-bit +Windows* 11, 64-bit + + +Operating system and developer environment requirements +############################################################ + +.. tab-set:: + + .. tab-item:: Linux OS + + * Ubuntu 22.04 with Linux kernel 5.15+ + * Ubuntu 20.04 with Linux kernel 5.15+ + * RHEL 8 with Linux kernel 5.4 + + A Linux OS build environment requires: + + * Python* 3.7-3.11 + * `Intel® HD Graphics Driver `__ + for inference on a GPU. + + GNU Compiler Collection and CMake are needed for building from source: + + * `GNU Compiler Collection (GCC) `__ + 8.4 (RHEL 8) 9.3 (Ubuntu 20) + * `CMake `__ 3.10 or higher + + To support CPU, GPU, GNA, or hybrid-core CPU capabilities, higher versions of kernel + might be required for 10th Gen Intel® Core™ Processor, + 11th Gen Intel® Core™ Processors, 11th Gen Intel® Core™ Processors S-Series Processors, + 12th Gen Intel® Core™ Processors, 13th Gen Intel® Core™ Processors,  or 4th Gen + Intel® Xeon® Scalable Processors. + + .. tab-item:: Windows* 10 and 11 + + A Windows OS build environment requires: + + * `Microsoft Visual Studio 2019 `__ + * `CMake `__ 3.14 or higher + * `Python 3.7-3.11 `__ + * `Intel® HD Graphics Driver `__ for inference on a GPU. + + .. tab-item:: macOS* 10.15 and above + + A macOS build environment requires: + + * `Xcode 10.3 `__ + * `Python 3.7-3.11 `__ + * `CMake 3.13 or higher `__ + + .. tab-item:: DL framework versions + + * TensorFlow 1.15, 2.12 + * MxNet 1.9 + * ONNX 1.13 + * PaddlePaddle* 2.4 + + Other DL Framework versions may be compatible with the current OpenVINO + release, but only the versions listed here are fully validated. + + +.. note:: + + OpenVINO Python binaries and binaries on Windows/CentOS7/MACOS(x86) are built + with oneTBB libraries. Other binaries on Ubuntu and Redhat OSes are built with + legacy TBB which is released by OS distribution. OpenVINO can be built with + either oneTBB or legacy TBB by the user on all OS systems listed. System + compatibility and performance are improved on Hybrid CPUs, + such as 12th Gen Intel Core and above. + + + +@endsphinxdirective \ No newline at end of file diff --git a/docs/articles_en/get_started.md b/docs/articles_en/get_started.md index d414afd80d8..54a6be18958 100644 --- a/docs/articles_en/get_started.md +++ b/docs/articles_en/get_started.md @@ -14,6 +14,7 @@ Install OpenVINO Additional Hardware Setup Troubleshooting + System Requirements .. raw:: html diff --git a/docs/home.rst b/docs/home.rst index dc3f721856c..9019b1600a2 100644 --- a/docs/home.rst +++ b/docs/home.rst @@ -143,6 +143,4 @@ Feature Overview LEARN OPENVINO OPENVINO WORKFLOW DOCUMENTATION - RESOURCES - RELEASE NOTES - + ABOUT OPENVINO \ No newline at end of file