Skip to content

Commit

Permalink
DOCS shift to rst - Install OpenVINO on macOS, Raspbian (#16506)
Browse files Browse the repository at this point in the history
  • Loading branch information
sgolebiewski-intel authored Mar 23, 2023
1 parent 9d0749a commit c89da1a
Show file tree
Hide file tree
Showing 5 changed files with 133 additions and 161 deletions.
81 changes: 36 additions & 45 deletions docs/install_guides/installing-openvino-brew.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,95 +2,85 @@

@sphinxdirective

With the OpenVINO™ 2022.3 release, you can install OpenVINO Runtime on macOS and Linux via `Homebrew <https://brew.sh/>`_. OpenVINO™ Development Tools can be installed via PyPI only. See :ref:`Installing Additional Components <intall additional components brew>` for more information.
With the OpenVINO™ 2022.3 release, you can install OpenVINO Runtime on macOS and Linux via `Homebrew <https://brew.sh/>`_. OpenVINO™ Development Tools can be installed via PyPI only. See `Installing Additional Components <#optional-installing-additional-components>`__ for more information.

See the `Release Notes <https://www.intel.com/content/www/us/en/developer/articles/release-notes/openvino-2022-3-lts-relnotes.html>`_ for more information on updates in the latest release.
See the `Release Notes <https://www.intel.com/content/www/us/en/developer/articles/release-notes/openvino-2022-3-lts-relnotes.html>`__ for more information on updates in the latest release.

Installing OpenVINO Runtime from Homebrew is recommended for C++ developers. If you are working with Python, the PyPI package has everything needed for Python development and deployment on CPU and GPUs. Visit the :doc:`Install OpenVINO from PyPI <openvino_docs_install_guides_installing_openvino_pip>` page for instructions on how to install OpenVINO Runtime for Python using PyPI.

.. note::
.. note::

Only CPU is supported for inference if you install OpenVINO via HomeBrew.

.. warning::
.. warning::

By downloading and using this container and the included software, you agree to the terms and conditions of the `software license agreements <https://software.intel.com/content/dam/develop/external/us/en/documents/intel-openvino-license-agreements.pdf>`_.
By downloading and using this container and the included software, you agree to the terms and conditions of the `software license agreements <https://software.intel.com/content/dam/develop/external/us/en/documents/intel-openvino-license-agreements.pdf>`__.

@endsphinxdirective

## Prerequisites

### System Requirements

@sphinxdirective

Full requirement listing is available on the `System Requirements Page <https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/system-requirements.html>`_
Prerequisites
####################

@endsphinxdirective
System Requirements
++++++++++++++++++++

### Software Requirements
Full requirement listing is available on the `System Requirements Page <https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/system-requirements.html>`__

@sphinxdirective
Software Requirements
+++++++++++++++++++++

.. tab:: macOS

* `Homebrew <https://brew.sh/>`_
* `CMake 3.13 or higher <https://cmake.org/download/>`_ (choose "macOS 10.13 or later"). Add `/Applications/CMake.app/Contents/bin` to path (for default installation).
* `Python 3.7 - 3.10 <https://www.python.org/downloads/mac-osx/>`_ (choose 3.7 - 3.10). Install and add it to path.
* Apple Xcode Command Line Tools. In the terminal, run `xcode-select --install` from any directory to install it.
* `CMake 3.13 or higher <https://cmake.org/download/>`__ (choose "macOS 10.13 or later"). Add ``/Applications/CMake.app/Contents/bin`` to path (for default installation).
* `Python 3.7 - 3.10 <https://www.python.org/downloads/mac-osx/>`__ (choose 3.7 - 3.10). Install and add it to path.
* Apple Xcode Command Line Tools. In the terminal, run ``xcode-select --install`` from any directory to install it.
* (Optional) Apple Xcode IDE (not required for OpenVINO™, but useful for development)

.. tab:: Linux

* `Homebrew <https://brew.sh/>`_
* `CMake 3.13 or higher, 64-bit <https://cmake.org/download/>`_
* `CMake 3.13 or higher, 64-bit <https://cmake.org/download/>`__
* GCC 7.5.0 (for Ubuntu 18.04) or GCC 9.3.0 (for Ubuntu 20.04)
* `Python 3.7 - 3.10, 64-bit <https://www.python.org/downloads/>`_

@endsphinxdirective
* `Python 3.7 - 3.10, 64-bit <https://www.python.org/downloads/>`__

## Installing OpenVINO Runtime

@sphinxdirective
Installing OpenVINO Runtime
###########################

1. Make sure that you have installed HomeBrew on your system. If not, follow the instructions on `the Homebrew website <https://brew.sh/>`_ to install and configure it.
1. Make sure that you have installed HomeBrew on your system. If not, follow the instructions on `the Homebrew website <https://brew.sh/>`__ to install and configure it.

2. Open a command prompt terminal window, and run the following command to install OpenVINO Runtime:

.. code-block:: sh

brew install openvino

Congratulations, you've finished the installation!

.. _intall additional components brew:

@endsphinxdirective

## (Optional) Installing Additional Components
Congratulations, you've finished the installation!

@sphinxdirective
(Optional) Installing Additional Components
###########################################

OpenVINO Development Tools is a set of utilities for working with OpenVINO and OpenVINO models. It provides tools like Model Optimizer, Benchmark Tool, Post-Training Optimization Tool, and Open Model Zoo Downloader. If you installed OpenVINO Runtime using Homebrew, OpenVINO Development Tools must be installed separately.

See **For C++ Developers** section on the :doc:`Install OpenVINO Development Tools <openvino_docs_install_guides_install_dev_tools>` page for instructions.

OpenCV is necessary to run demos from Open Model Zoo (OMZ). Some OpenVINO samples can also extend their capabilities when compiled with OpenCV as a dependency. To install OpenCV for OpenVINO, see the `instructions on GitHub <https://github.com/opencv/opencv/wiki/BuildOpenCV4OpenVINO>`_.

@endsphinxdirective

## Uninstalling OpenVINO
Uninstalling OpenVINO
#####################

To uninstall OpenVINO via HomeBrew, use the following command:
```sh
brew uninstall openvino
```

## What's Next?
.. code-block:: sh

@sphinxdirective
brew uninstall openvino


What's Next?
####################

Now that you've installed OpenVINO Runtime, you can try the following things:
Now that you've installed OpenVINO Runtime, you can try the following things:

* 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>`.
Expand All @@ -99,8 +89,9 @@ Now that you've installed OpenVINO Runtime, you can try the following things:
* See sample applications in :doc:`OpenVINO toolkit Samples Overview <openvino_docs_OV_UG_Samples_Overview>`.
* Take a glance at the OpenVINO product home page: https://software.intel.com/en-us/openvino-toolkit.

@endsphinxdirective
Additional Resources
####################

## Additional Resources
* `OpenVINO Installation Selector Tool <https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html>`__

- [OpenVINO Installation Selector Tool](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html)
@endsphinxdirective
Loading

0 comments on commit c89da1a

Please sign in to comment.