From 103afb13a0e89756a388ed0f068de7e5dfad87e1 Mon Sep 17 00:00:00 2001 From: Maciej Smyk Date: Tue, 16 Apr 2024 14:55:04 +0200 Subject: [PATCH] [DOCS] Release Policy + torch.compile updates for 2024.0 (#24051) Port from https://github.com/openvinotoolkit/openvino/pull/22881 * Created new article about Release Policy, * Moved System Requirements Article under Release Notes. * Removed environment variables info from torch.compile article. Jira: 132590 --- docs/articles_en/about-openvino.rst | 3 +- .../supported-devices.rst | 2 +- .../about-openvino/release-notes-openvino.rst | 8 +- .../release-notes-openvino/release-policy.rst | 173 ++++++++++++++++++ .../system-requirements.rst | 10 +- .../install-openvino/install-openvino-apt.rst | 2 +- .../install-openvino-archive-linux.rst | 2 +- .../install-openvino-archive-macos.rst | 2 +- .../install-openvino-archive-windows.rst | 2 +- .../install-openvino-brew.rst | 2 +- .../install-openvino-conan.rst | 2 +- .../install-openvino-conda.rst | 2 +- .../install-openvino/install-openvino-pip.rst | 2 +- .../install-openvino-vcpkg.rst | 2 +- .../install-openvino/install-openvino-yum.rst | 2 +- .../openvino-samples/get-started-demos.rst | 2 +- .../openvino-workflow/torch-compile.rst | 16 -- 17 files changed, 195 insertions(+), 39 deletions(-) create mode 100644 docs/articles_en/about-openvino/release-notes-openvino/release-policy.rst rename docs/articles_en/about-openvino/{ => release-notes-openvino}/system-requirements.rst (97%) diff --git a/docs/articles_en/about-openvino.rst b/docs/articles_en/about-openvino.rst index 18b03eaec86..3d472fb55d4 100644 --- a/docs/articles_en/about-openvino.rst +++ b/docs/articles_en/about-openvino.rst @@ -10,7 +10,6 @@ About OpenVINO about-openvino/performance-benchmarks about-openvino/compatibility-and-support - about-openvino/system-requirements Release Notes Additional Resources @@ -40,7 +39,7 @@ OpenVINO accelerates deep learning models on various hardware platforms, ensurin * `Deployment on a server `__ -A model can be deployed either locally using OpenVINO Runtime or on a model server. Runtime is a set of C++ libraries with C and Python bindings providing a common API to deliver inference solutions. The model server enables quick model inference using external about-openvino/additional-resources. +A model can be deployed either locally using OpenVINO Runtime or on a model server. Runtime is a set of C++ libraries with C and Python bindings providing a common API to deliver inference solutions. The model server enables quick model inference using external resources. Architecture ############################################################## diff --git a/docs/articles_en/about-openvino/compatibility-and-support/supported-devices.rst b/docs/articles_en/about-openvino/compatibility-and-support/supported-devices.rst index a7b91efa0ca..0ef4fb1119f 100644 --- a/docs/articles_en/about-openvino/compatibility-and-support/supported-devices.rst +++ b/docs/articles_en/about-openvino/compatibility-and-support/supported-devices.rst @@ -16,7 +16,7 @@ deep learning models: :doc:`NPU <../../openvino-workflow/running-inference/inference-devices-and-modes/npu-device>`. | For their usage guides, see :doc:`Devices and Modes <../../openvino-workflow/running-inference/inference-devices-and-modes>`. -| For a detailed list of devices, see :doc:`System Requirements <../system-requirements>`. +| For a detailed list of devices, see :doc:`System Requirements <../release-notes-openvino/system-requirements>`. Beside running inference with a specific device, OpenVINO offers the option of running automated inference with the following inference modes: diff --git a/docs/articles_en/about-openvino/release-notes-openvino.rst b/docs/articles_en/about-openvino/release-notes-openvino.rst index ce6590ad4e2..d9d1d5331a0 100644 --- a/docs/articles_en/about-openvino/release-notes-openvino.rst +++ b/docs/articles_en/about-openvino/release-notes-openvino.rst @@ -3,11 +3,17 @@ OpenVINO Release Notes ============================= +.. toctree:: + :maxdepth: 1 + :hidden: + + release-notes-openvino/system-requirements + release-notes-openvino/release-policy 2024.0 - 06 March 2024 ############################# -:doc:`System Requirements <./system-requirements>` | :doc:`Installation Guides <./../get-started/install-openvino>` +:doc:`System Requirements <./release-notes-openvino/system-requirements>` | :doc:`Installation Guides <./../get-started/install-openvino>` What's new diff --git a/docs/articles_en/about-openvino/release-notes-openvino/release-policy.rst b/docs/articles_en/about-openvino/release-notes-openvino/release-policy.rst new file mode 100644 index 00000000000..40c86d022f0 --- /dev/null +++ b/docs/articles_en/about-openvino/release-notes-openvino/release-policy.rst @@ -0,0 +1,173 @@ +Release Policy +============================================================================= + +OpenVINO offers releases of three different types: Regular, Long-Term Support, and Nightly, +each targeting a different use case. + +| `Regular releases <#regular-releases>`__ +| OpenVINO™ is published multiple times a year. Each regular release is supported until the + next version arrives, making it suitable for: + +* Most typical use cases (the recommended release type). +* Products requiring frequent changes in supported hardware, libraries, operating systems, and models. + +| `Long-Term Support <#long-term-support-policy>`__: +| Each year’s final release becomes a Long-Term Support (LTS) version, which continues to + receive bug fixes and security updates, even after newer versions are published. + Therefore, LTS may be used for production environments where: + +* There is no need for frequent changes in hardware or model support. +* New optimizations are not prioritized. +* Upgrading is challenging, e.g., due to high software complexity. +* A legacy feature, discontinued in newer OpenVINO versions, is still required. + +| `Nightly <#nightly-releases>`__: +| OpenVINO also offers nightly releases, as a preview of the most recent changes. + Since their validation scope is limited, they should never be used for production purposes. + Instead, they may serve: + +* Early integration testing. +* Community contribution development and integration. +* Tracking development progress. + +Regular releases +#################### + +Regular releases are published when significant new features and bug fixes have been completed +and validated. For each of them, a dedicated development branch in GitHub is created. +Their target changes are: + +* New features of gold quality, as well as Beta features, labeled as “preview.” +* Key bug fixes. +* Newest hardware support. + +Long-Term Support Policy +########################### + +**LTS Lifecycle** + +* LTS is typically published at the end of every year cycle. +* LTS uses the branch of the last yearly regular release. +* LTS aim to receive an update once a year. +* Security updates are offered for the duration of the entire LTS period, which is two years + (or until superseded by two consecutive LTS versions). +* Updates targeting newly discovered bugs are offered for the period of one year. + +.. note:: + LTS releases may offer limited distribution options. + +**Components covered by LTS** + +Not all components associated with the OpenVINO™ toolkit are covered by the LTS policy. +The following elements are not guaranteed to receive updates: + +* Components in the deprecation period. +* Preview features (highlighted in the release notes). +* Components not directly connected to the OpenVINO™ workflow, such as: Samples, demos, and Jupyter notebooks. +* OpenVINO tools, such as NNCF and OVMS. +* Code samples used in component testing. + + +Nightly releases +########################### + +OpenVINO nightly packages are the first source of newly added features and ofpriority bug fixes +reported for the previous versions. They are: + +* Released every workday. +* Based on the master branch of the OpenVINO GitHub repository. +* Not fit for production environments. +* Offered with limited distribution options: + +.. tab-set:: + + .. tab-item:: Downloadable Archives + :sync: archives-s3 + + 1. Go to `OpenVINO Nightly Packages `__. + 2. Select a package you want to install. + 3. Download the archive for your platform. + 4. Unpack the archive in a convenient location. + 5. Once unpacked, proceed as with a regular OpenVINO archive (see :doc:`installation guides <../../../get-started/install-openvino>`). + + .. tab-item:: OV Wheels on S3 + :sync: wheels-s3 + + A PyPI repository deployed on AWS S3 (`see more details `__) + enables the use of regular PyPI without the need to rename wheels. Installation commands vary depending + on the branch: + + .. tab-set:: + + .. tab-item:: Master + :sync: master + + .. code-block:: py + + pip install --pre openvino --extra-index-url + https://storage.openvinotoolkit.org/simple/wheels/nightly + + .. tab-item:: Release + :sync: release + + * This command includes **Release Candidates**. + * To use ``extra-index-url``, you need to pass a link containing ``simple``. + * The ``--pre`` allows the installation of dev-builds. + + .. code-block:: py + + pip install --pre openvino --extra-index-url + https://storage.openvinotoolkit.org/simple/wheels/pre-release + + .. tab-item:: OV Wheels on PyPi (not recommended) + :sync: wheels-pypi + + + Install OV Wheels from PyPI: + + .. code-block:: py + + pip install openvino-nightly + + +Additional Information +######################### + +| **Determining the OpenVINO Version** +| If you need to operate on a specific OpenVINO release, and you are not sure which version + is included in the installed package, you can verify it in one of two ways: + +.. tab-set:: + + .. tab-item:: Python + :sync: python + + Execute the following command within the installed package: + + .. code-block:: python + + python3 -c "import openvino; print(openvino.__version__)" + + .. tab-item:: Archives + :sync: archives + + You can find the file version in: + + .. code-block:: text + + /runtime/version.txt + +| **Issue Reporting** +| To report issues, use the `Intel® Premier Support `__ + clearly stating the issue, impact, and the expected timeline. + +| **Distribution:** + +* `Selector tool `__ of all distribution options. +* Source code distribution: `GitHub `__ and + `Gitee `__ . +* Binary distribution: + + * Download from `OpenVINO storage `__ + * `pypi.org `__ + * `DockerHub* `__ diff --git a/docs/articles_en/about-openvino/system-requirements.rst b/docs/articles_en/about-openvino/release-notes-openvino/system-requirements.rst similarity index 97% rename from docs/articles_en/about-openvino/system-requirements.rst rename to docs/articles_en/about-openvino/release-notes-openvino/system-requirements.rst index a8a42e417a3..bb0e45b5a96 100644 --- a/docs/articles_en/about-openvino/system-requirements.rst +++ b/docs/articles_en/about-openvino/release-notes-openvino/system-requirements.rst @@ -92,10 +92,10 @@ Intel® Neural Processing Unit .. tab-item:: Additional considerations - * These Accelerators require :doc:`drivers <../get-started/configurations/configurations-intel-npu>` + * These Accelerators require :doc:`drivers <../../get-started/configurations/configurations-intel-npu>` that are not included in the Intel® Distribution of OpenVINO™ toolkit package. * Users can access the NPU plugin through the OpenVINO archives on - the :doc:`download page <../get-started/install-openvino>`. + the :doc:`download page <../../get-started/install-openvino>`. Operating systems and developer environment @@ -207,9 +207,3 @@ For more complete information about compiler optimizations, see our Optimization Performance varies by use, configuration and other factors. Learn more at `www.Intel.com/PerformanceIndex `__. - - - - - - diff --git a/docs/articles_en/get-started/install-openvino/install-openvino-apt.rst b/docs/articles_en/get-started/install-openvino/install-openvino-apt.rst index 26edf0c9deb..286d40ac3d9 100644 --- a/docs/articles_en/get-started/install-openvino/install-openvino-apt.rst +++ b/docs/articles_en/get-started/install-openvino/install-openvino-apt.rst @@ -23,7 +23,7 @@ Install Intel® Distribution of OpenVINO™ Toolkit for Linux Using APT Reposito :sync: system-requirements | Full requirement listing is available in: - | :doc:`System Requirements Page <../../../about-openvino/system-requirements>` + | :doc:`System Requirements Page <../../../about-openvino/release-notes-openvino/system-requirements>` .. tab-item:: Processor Notes :sync: processor-notes diff --git a/docs/articles_en/get-started/install-openvino/install-openvino-archive-linux.rst b/docs/articles_en/get-started/install-openvino/install-openvino-archive-linux.rst index caba783d826..6b800c277b9 100644 --- a/docs/articles_en/get-started/install-openvino/install-openvino-archive-linux.rst +++ b/docs/articles_en/get-started/install-openvino/install-openvino-archive-linux.rst @@ -40,7 +40,7 @@ Install OpenVINO™ Runtime on Linux from an Archive File :sync: system-requirements | Full requirement listing is available in: - | :doc:`System Requirements Page <../../../about-openvino/system-requirements>` + | :doc:`System Requirements Page <../../../about-openvino/release-notes-openvino/system-requirements>` .. tab-item:: Processor Notes :sync: processor-notes diff --git a/docs/articles_en/get-started/install-openvino/install-openvino-archive-macos.rst b/docs/articles_en/get-started/install-openvino/install-openvino-archive-macos.rst index ead54a0d2a3..c888ccd9d6d 100644 --- a/docs/articles_en/get-started/install-openvino/install-openvino-archive-macos.rst +++ b/docs/articles_en/get-started/install-openvino/install-openvino-archive-macos.rst @@ -25,7 +25,7 @@ Install OpenVINO™ Runtime on macOS from an Archive File :sync: system-requirements | Full requirement listing is available in: - | :doc:`System Requirements Page <../../../about-openvino/system-requirements>` + | :doc:`System Requirements Page <../../../about-openvino/release-notes-openvino/system-requirements>` .. tab-item:: Software Requirements :sync: software-requirements diff --git a/docs/articles_en/get-started/install-openvino/install-openvino-archive-windows.rst b/docs/articles_en/get-started/install-openvino/install-openvino-archive-windows.rst index 7d7ab4f8835..017c533090d 100644 --- a/docs/articles_en/get-started/install-openvino/install-openvino-archive-windows.rst +++ b/docs/articles_en/get-started/install-openvino/install-openvino-archive-windows.rst @@ -27,7 +27,7 @@ System Requirements :sync: system-requirements | Full requirement listing is available in: - | :doc:`System Requirements Page <../../../about-openvino/system-requirements>` + | :doc:`System Requirements Page <../../../about-openvino/release-notes-openvino/system-requirements>` .. tab-item:: Processor Notes :sync: processor-notes diff --git a/docs/articles_en/get-started/install-openvino/install-openvino-brew.rst b/docs/articles_en/get-started/install-openvino/install-openvino-brew.rst index eb57a5f1602..a5f5abeaf34 100644 --- a/docs/articles_en/get-started/install-openvino/install-openvino-brew.rst +++ b/docs/articles_en/get-started/install-openvino/install-openvino-brew.rst @@ -23,7 +23,7 @@ Install OpenVINO™ Runtime via Homebrew :sync: system-requirements | Full requirement listing is available in: - | :doc:`System Requirements Page <../../../about-openvino/system-requirements>` + | :doc:`System Requirements Page <../../../about-openvino/release-notes-openvino/system-requirements>` .. tab-item:: Processor Notes :sync: processor-notes diff --git a/docs/articles_en/get-started/install-openvino/install-openvino-conan.rst b/docs/articles_en/get-started/install-openvino/install-openvino-conan.rst index 538d5c1a612..19938831b17 100644 --- a/docs/articles_en/get-started/install-openvino/install-openvino-conan.rst +++ b/docs/articles_en/get-started/install-openvino/install-openvino-conan.rst @@ -24,7 +24,7 @@ Install OpenVINO™ Runtime from Conan Package Manager :sync: system-requirements | Full requirement listing is available in: - | :doc:`System Requirements Page <../../../about-openvino/system-requirements>` + | :doc:`System Requirements Page <../../../about-openvino/release-notes-openvino/system-requirements>` .. tab-item:: Processor Notes :sync: processor-notes diff --git a/docs/articles_en/get-started/install-openvino/install-openvino-conda.rst b/docs/articles_en/get-started/install-openvino/install-openvino-conda.rst index fce08337ea5..8fcd0bcab35 100644 --- a/docs/articles_en/get-started/install-openvino/install-openvino-conda.rst +++ b/docs/articles_en/get-started/install-openvino/install-openvino-conda.rst @@ -24,7 +24,7 @@ Install OpenVINO™ Runtime from Conda Forge :sync: system-requirements | Full requirement listing is available in: - | :doc:`System Requirements Page <../../../about-openvino/system-requirements>` + | :doc:`System Requirements Page <../../../about-openvino/release-notes-openvino/system-requirements>` .. tab-item:: Processor Notes diff --git a/docs/articles_en/get-started/install-openvino/install-openvino-pip.rst b/docs/articles_en/get-started/install-openvino/install-openvino-pip.rst index ddde5f39ef9..6d00c1bc0b0 100644 --- a/docs/articles_en/get-started/install-openvino/install-openvino-pip.rst +++ b/docs/articles_en/get-started/install-openvino/install-openvino-pip.rst @@ -24,7 +24,7 @@ Install Intel® Distribution of OpenVINO™ Toolkit from PyPI Repository :sync: system-requirements | Full requirement listing is available in: - | :doc:`System Requirements Page <../../../about-openvino/system-requirements>` + | :doc:`System Requirements Page <../../../about-openvino/release-notes-openvino/system-requirements>` | `PyPI OpenVINO page `__ diff --git a/docs/articles_en/get-started/install-openvino/install-openvino-vcpkg.rst b/docs/articles_en/get-started/install-openvino/install-openvino-vcpkg.rst index cb9866caa99..3074bd8135e 100644 --- a/docs/articles_en/get-started/install-openvino/install-openvino-vcpkg.rst +++ b/docs/articles_en/get-started/install-openvino/install-openvino-vcpkg.rst @@ -23,7 +23,7 @@ Install OpenVINO™ Runtime via vcpkg :sync: system-requirements | Full requirement listing is available in: - | :doc:`System Requirements Page <../../../about-openvino/system-requirements>` + | :doc:`System Requirements Page <../../../about-openvino/release-notes-openvino/system-requirements>` .. tab-item:: Processor Notes :sync: processor-notes diff --git a/docs/articles_en/get-started/install-openvino/install-openvino-yum.rst b/docs/articles_en/get-started/install-openvino/install-openvino-yum.rst index cb3bb9546ae..2d404187b16 100644 --- a/docs/articles_en/get-started/install-openvino/install-openvino-yum.rst +++ b/docs/articles_en/get-started/install-openvino/install-openvino-yum.rst @@ -23,7 +23,7 @@ Install OpenVINO™ Runtime on Linux From YUM Repository :sync: system-requirements | Full requirement listing is available in: - | :doc:`System Requirements Page <../../../about-openvino/system-requirements>` + | :doc:`System Requirements Page <../../../about-openvino/release-notes-openvino/system-requirements>` .. note:: diff --git a/docs/articles_en/learn-openvino/openvino-samples/get-started-demos.rst b/docs/articles_en/learn-openvino/openvino-samples/get-started-demos.rst index 3a7f86176f1..0ecc42b2a30 100644 --- a/docs/articles_en/learn-openvino/openvino-samples/get-started-demos.rst +++ b/docs/articles_en/learn-openvino/openvino-samples/get-started-demos.rst @@ -25,7 +25,7 @@ If you install OpenVINO Runtime via archive files, sample applications are creat .. note:: If you install OpenVINO without samples, you can still get them directly from `the OpenVINO repository `__. -Before you build samples, refer to the :doc:`system requirements <../../about-openvino/system-requirements>` page and make sure that all the prerequisites have been installed. Next, you can perform the following steps: +Before you build samples, refer to the :doc:`system requirements <../../about-openvino/release-notes-openvino/system-requirements>` page and make sure that all the prerequisites have been installed. Next, you can perform the following steps: 1. :ref:`Build Samples `. 2. :ref:`Select a Sample `. diff --git a/docs/articles_en/openvino-workflow/torch-compile.rst b/docs/articles_en/openvino-workflow/torch-compile.rst index 81b2c51f612..450539d8a61 100644 --- a/docs/articles_en/openvino-workflow/torch-compile.rst +++ b/docs/articles_en/openvino-workflow/torch-compile.rst @@ -104,22 +104,6 @@ You can also set OpenVINO specific configuration options by adding them as a dic model = torch.compile(model, backend="openvino", options=opts) -.. important:: - - The environment variables used in the previous release are still available but are not - recommended. They will be removed fully in future releases. - - .. dropdown:: Click to view the deprecated options. - - * ``OPENVINO_TORCH_BACKEND_DEVICE`` - enables selecting a specific hardware device to run the application. - By default, the OpenVINO backend for ``torch.compile`` runs PyTorch applications using the CPU. Setting - this variable to ``GPU.0``, for example, will make the application use the integrated graphics processor instead. - * ``OPENVINO_TORCH_MODEL_CACHING``- enables saving the optimized model files to a hard drive, after the first application run. - This makes them available for the following application executions, reducing the first-inference latency. - By default, this variable is set to ``False``. Setting it to ``True`` enables caching. - * ``OPENVINO_TORCH_CACHE_DIR``- enables defining a custom directory for the model files (if ``model_caching`` is set to ``True``). - By default, the OpenVINO IR is saved in the ``cache`` sub-directory, created in the application's root directory. - Windows support +++++++++++++++++++++