IntenseWebs/openvino
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

minor edits (#15269)

Browse Source
This commit is contained in:
Sebastian Golebiewski
2023-01-23 22:23:09 +01:00
committed by GitHub
parent 3d8a418549
commit ea519f85db
5 changed files with 43 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
docs/OV_Runtime_UG/Samples_Overview.md
View File

@@ -1,4 +1,4 @@
# OpenVINO Samples {#openvino_docs_OV_UG_Samples_Overview}
# OpenVINO™ Samples {#openvino_docs_OV_UG_Samples_Overview}
@sphinxdirective
@@ -96,13 +96,13 @@ To run the sample, you can use [public](@ref omz_models_group_public) or [Intel'
### <a name="build-samples-linux"></a>Build the Sample Applications on Linux
The officially supported Linux* build environment is the following:
The officially supported Linux build environment is the following:
* Ubuntu* 18.04 LTS 64-bit or Ubuntu* 20.04 LTS 64-bit
* GCC* 7.5.0 (for Ubuntu* 18.04) or GCC* 9.3.0 (for Ubuntu* 20.04)
* CMake* version 3.10 or higher
* Ubuntu 18.04 LTS 64-bit or Ubuntu 20.04 LTS 64-bit
* GCC 7.5.0 (for Ubuntu 18.04) or GCC 9.3.0 (for Ubuntu 20.04)
* CMake version 3.10 or higher
> **NOTE**: For building samples from the open-source version of OpenVINO™ toolkit, see the [build instructions on GitHub](https://github.com/openvinotoolkit/openvino/wiki/BuildingCode).
> **NOTE**: For building samples from the open-source version of OpenVINO toolkit, see the [build instructions on GitHub](https://github.com/openvinotoolkit/openvino/wiki/BuildingCode).
To build the C or C++ sample applications for Linux, go to the `<INSTALL_DIR>/samples/c` or `<INSTALL_DIR>/samples/cpp` directory, respectively, and run the `build_samples.sh` script:
```sh
@@ -110,8 +110,9 @@ build_samples.sh
```
Once the build is completed, you can find sample binaries in the following folders:
* C samples: `~/openvino_c_samples_build/intel64/Release`
* C++ samples: `~/openvino_cpp_samples_build/intel64/Release`
* C samples: `~/openvino_c_samples_build/<architecture>/Release`
* C++ samples: `~/openvino_cpp_samples_build/<architecture>/Release`
where the <architecture> is the output of `uname -m`, for example, `intel64`, `armhf`, or `aarch64`.
You can also build the sample applications manually:
@@ -142,8 +143,8 @@ cd build
make
```
For the release configuration, the sample application binaries are in `<path_to_build_directory>/intel64/Release/`;
for the debug configuration — in `<path_to_build_directory>/intel64/Debug/`.
For the release configuration, the sample application binaries are in `<path_to_build_directory>/<architecture>/Release/`;
for the debug configuration — in `<path_to_build_directory>/<architecture>/Debug/`.
### <a name="build-samples-windows"></a>Build the Sample Applications on Microsoft Windows
@@ -162,22 +163,22 @@ build_samples_msvc.bat
By default, the script automatically detects the highest Microsoft Visual Studio version installed on the machine and uses it to create and build a solution for a sample code
Once the build is completed, you can find sample binaries in the following folders:
* C samples: `C:\Users\<user>\Documents\Intel\OpenVINO\openvino_c_samples_build\intel64\Release`
* C++ samples: `C:\Users\<user>\Documents\Intel\OpenVINO\openvino_cpp_samples_build\intel64\Release`
* C samples: `C:\Users\<user>\Documents\Intel\OpenVINO\openvino_c_samples_build\<architecture>\Release`
* C++ samples: `C:\Users\<user>\Documents\Intel\OpenVINO\openvino_cpp_samples_build\<architecture>\Release`
You can also build a generated solution manually. For example, if you want to build C++ sample binaries in Debug configuration, run the appropriate version of the
Microsoft Visual Studio and open the generated solution file from the `C:\Users\<user>\Documents\Intel\OpenVINO\openvino_cpp_samples_build\Samples.sln`
directory.
### <a name="build-samples-macos"></a>Build the Sample Applications on macOS*
### <a name="build-samples-macos"></a>Build the Sample Applications on macOS
The officially supported macOS* build environment is the following:
The officially supported macOS build environment is the following:
* macOS* 10.15 64-bit or higher
* Clang* compiler from Xcode* 10.1 or higher
* CMake* version 3.13 or higher
* macOS 10.15 64-bit or higher
* Clang compiler from Xcode 10.1 or higher
* CMake version 3.13 or higher
> **NOTE**: For building samples from the open-source version of OpenVINO™ toolkit, see the [build instructions on GitHub](https://github.com/openvinotoolkit/openvino/wiki/BuildingCode).
> **NOTE**: For building samples from the open-source version of OpenVINO toolkit, see the [build instructions on GitHub](https://github.com/openvinotoolkit/openvino/wiki/BuildingCode).
To build the C or C++ sample applications for macOS, go to the `<INSTALL_DIR>/samples/c` or `<INSTALL_DIR>/samples/cpp` directory, respectively, and run the `build_samples.sh` script:
```sh
@@ -185,8 +186,8 @@ build_samples.sh
```
Once the build is completed, you can find sample binaries in the following folders:
* C samples: `~/openvino_c_samples_build/intel64/Release`
* C++ samples: `~/openvino_cpp_samples_build/intel64/Release`
* C samples: `~/openvino_c_samples_build/<architecture>/Release`
* C++ samples: `~/openvino_cpp_samples_build/<architecture>/Release`
You can also build the sample applications manually:
@@ -223,12 +224,12 @@ cd build
make
```
For the release configuration, the sample application binaries are in `<path_to_build_directory>/intel64/Release/`;
for the debug configuration — in `<path_to_build_directory>/intel64/Debug/`.
For the release configuration, the sample application binaries are in `<path_to_build_directory>/<architecture>/Release/`;
for the debug configuration — in `<path_to_build_directory>/<architecture>/Debug/`.
## Get Ready for Running the Sample Applications
### Get Ready for Running the Sample Applications on Linux*
### Get Ready for Running the Sample Applications on Linux
Before running compiled binary files, make sure your application can find the
OpenVINO Runtime libraries.
@@ -237,8 +238,9 @@ Run the `setupvars` script to set all necessary environment variables:
source <INSTALL_DIR>/setupvars.sh
```
**(Optional)**: The OpenVINO environment variables are removed when you close the
shell. As an option, you can permanently set the environment variables as follows:
#### (Optional) Set Environment Variables Permanently
The OpenVINO environment variables are removed when you close the shell. As an option, you can permanently set the environment variables as follows:
1. Open the `.bashrc` file in `<user_home_directory>`:
```sh
@@ -257,7 +259,7 @@ You are ready to run sample applications. To learn about how to run a particular
sample, read the sample documentation by clicking the sample name in the samples
list above.
### Get Ready for Running the Sample Applications on Windows*
### Get Ready for Running the Sample Applications on Windows
Before running compiled binary files, make sure your application can find the
OpenVINO Runtime libraries.
@@ -284,4 +286,4 @@ sample, read the sample documentation by clicking the sample name in the samples
list above.
## See Also
* [OpenVINO™ Runtime User Guide](openvino_intro.md)
* [OpenVINO Runtime User Guide](openvino_intro.md)

2
docs/install_guides/configurations-for-intel-gpu.md
View File

@@ -22,6 +22,8 @@ If you have installed OpenVINO Runtime from the archive file, APT, or YUM, follo
```sh
sudo -E ./install_NEO_OCL_driver.sh
```
> **NOTE**: If you installed OpenVINO Runtime via PyPI, you can get this script from [the OpenVINO repository](https://github.com/openvinotoolkit/openvino/blob/master/scripts/install_dependencies/install_NEO_OCL_driver.sh).
> **NOTE**: To use the **Intel® Iris® Xe MAX Graphics**, see the [Intel® Iris® Xe MAX Graphics with Linux*](https://dgpu-docs.intel.com/devices/iris-xe-max-graphics/index.html) page for driver installation instructions.
The script compares the driver version on the system to the current version. If the driver version on the system is higher or equal to the current version, the script does

11
docs/install_guides/installing-openvino-pip.md
View File

@@ -35,19 +35,22 @@ To create a virtual environment, use the following command:
@sphinxdirective
.. tab:: On Linux and macOS
.. tab:: Linux and macOS
.. code-block:: sh
source openvino_env/bin/activate
.. tab:: On Windows
.. tab:: Windows
.. code-block:: sh
openvino_env\Scripts\activate
.. important::
The above command must be re-run every time a new command terminal window is opened.
@endsphinxdirective
### Step 3. Set Up and Update PIP to the Highest Version

3
docs/install_guides/troubleshooting-issues.md
View File

@@ -18,10 +18,11 @@ Users in China might encounter errors while downloading sources via PIP during O
pip install openvino-dev[tensorflow2] -i https://mirrors.aliyun.com/pypi/simple/
```
* For C++ developers, if you have installed OpenVINO Runtime via APT, YUM, or the installer, and then installed OpenVINO Development Tools via PyPI, you may run into issues. To resolve that, install the components in ``requirements.txt`` by using the following command:
* For C++ developers, if you have installed OpenVINO Runtime via APT, YUM, or the archive file, and then installed OpenVINO Development Tools via PyPI, you may run into issues. To resolve that, install the components in ``requirements.txt`` by using the following command:
``` sh
pip install -r <INSTALL_DIR>/tools/requirements.txt
```
For APT and YUM users, replace the `INSTALL_DIR` with `/usr/share/openvino`.
<!-- this part was from Docker installation -->

6
docs/install_guides/troubleshooting-steps.md
View File

@@ -35,12 +35,12 @@ python -m pip install --upgrade pip
## Check if required external dependencies are installed (for pre-2022.2 releases)
For OpenVINO releases prior to 2022.2:
- If you are using Ubuntu or RHEL 8 systems, and installed OpenVINO Runtime via the installer, APT, or YUM repository, and then decided to [install OpenVINO Development Tools](installing-model-dev-tools.md), make sure that you **Install External Software Dependencies** first by following the steps in the corresponding installation pages.
- If you are using Ubuntu or RHEL 8 systems, and installed OpenVINO Runtime via the archive file, APT, or YUM repository, and then decided to [install OpenVINO Development Tools](installing-model-dev-tools.md), make sure that you **Install External Software Dependencies** first by following the steps in the corresponding installation pages.
- For C++ developers with Windows systems, make sure that Microsoft Visual Studio 2019 with MSBuild and CMake 3.14 or higher (64-bit) are installed. While installing Microsoft Visual Studio 2019, make sure that you have selected **Desktop development with C++** in the **Workloads** tab. If not, launch the installer again to select that option. For more information on modifying the installation options for Microsoft Visual Studio, see its [official support page](https://docs.microsoft.com/en-us/visualstudio/install/modify-visual-studio?view=vs-2019).
## Check if environment variables are set correctly
- For Python developers, if you previously installed OpenVINO using the installer, and are now installing OpenVINO using PIP, remove all the PATH settings and the lines with `setupvars` from `.bashrc`. Note that if you installed OpenVINO with PIP in a virtual environment, you don't need to set any environment variables.
- For Python developers, if you previously installed OpenVINO using the archive file, and are now installing OpenVINO using PIP, remove all the PATH settings and the lines with `setupvars` from `.bashrc`. Note that if you installed OpenVINO with PIP in a virtual environment, you don't need to set any environment variables.
- If you have installed OpenVINO before, you probably have added `setupvars` to your `PATH /.bashrc` or Windows environment variables. After restarting your environment, you should see similar information as below:
```sh
[setupvars.sh] OpenVINO™ environment initialized
@@ -60,7 +60,7 @@ For OpenVINO releases prior to 2022.2:
If OpenVINO was successfully installed, nothing will happen. If not, an error will be displayed.
* If you installed OpenVINO Runtime using the installer, you can search "openvino" in Apps & Features on a Windows system, or check your installation directory on Linux to see if OpenVINO is there.
* If you installed OpenVINO Runtime using the archive file, you can search "openvino" in Apps & Features on a Windows system, or check your installation directory on Linux to see if OpenVINO is there.
* If you installed OpenVINO Runtime from APT, use the ``apt list --installed | grep openvino`` command to list the installed OpenVINO packages.