[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
This commit is contained in:
Maciej Smyk
GitHub
parent
a1e0c687f4
commit
103afb13a0
|
|
@ -10,7 +10,6 @@ About OpenVINO
|
|||
|
||||
about-openvino/performance-benchmarks
|
||||
about-openvino/compatibility-and-support
|
||||
about-openvino/system-requirements
|
||||
Release Notes <about-openvino/release-notes-openvino>
|
||||
Additional Resources <about-openvino/additional-resources>
|
||||
|
||||
|
|
@ -40,7 +39,7 @@ OpenVINO accelerates deep learning models on various hardware platforms, ensurin
|
|||
|
||||
* `Deployment on a server <https://github.com/openvinotoolkit/model_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
|
||||
##############################################################
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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 <https://storage.openvinotoolkit.org/repositories/openvino/packages/nightly/>`__.
|
||||
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 <https://peps.python.org/pep-0503/>`__)
|
||||
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
|
||||
|
||||
<UNZIPPED_ARCHIVE_ROOT>/runtime/version.txt
|
||||
|
||||
| **Issue Reporting**
|
||||
| To report issues, use the `Intel® Premier Support <https://www.intel.com/content/www/us/en/design/support/ips/training/welcome.html>`__
|
||||
clearly stating the issue, impact, and the expected timeline.
|
||||
|
||||
| **Distribution:**
|
||||
|
||||
* `Selector tool <https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html>`__ of all distribution options.
|
||||
* Source code distribution: `GitHub <https://github.com/openvinotoolkit/openvino>`__ and
|
||||
`Gitee <https://gitee.com/openvinotoolkit-prc/openvino>`__ .
|
||||
* Binary distribution:
|
||||
|
||||
* Download from `OpenVINO storage <https://storage.openvinotoolkit.org/repositories/openvino/packages/>`__
|
||||
* `pypi.org <https://pypi.org/project/openvino-dev/>`__
|
||||
* `DockerHub* <https://hub.docker.com/u/openvino>`__
|
||||
|
|
@ -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 <www.Intel.com/PerformanceIndex>`__.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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 <https://pypi.org/project/openvino/>`__
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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::
|
||||
|
||||
|
|
|
|||
|
|
@ -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 <https://github.com/openvinotoolkit/openvino/>`__.
|
||||
|
||||
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 <build-samples>`.
|
||||
2. :ref:`Select a Sample <select-sample>`.
|
||||
|
|
|
|||
|
|
@ -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
|
||||
+++++++++++++++++++++
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue