From 648c86ee9ac70113b613033eebef5c7c35a78c9a Mon Sep 17 00:00:00 2001 From: Andrey Zaytsev Date: Fri, 7 Aug 2020 15:29:18 +0300 Subject: [PATCH] Documentation updates for 2020.4 (#1672) * Doc updates * 2020.4 doc updates * Removed
tag * Minor fix * Minor fixes * Updated documentation for 2020.4 (#1434) * Updated documentation for 2020.4 * Updated Core::ReadNetwork documentation (#1178) * Fixed docs Co-authored-by: Ilya Churaev Co-authored-by: Ilya Lavrenov Co-authored-by: Ilya Churaev --- ...grate_with_customer_application_new_API.md | 2 +- docs/IE_DG/Samples_Overview.md | 8 +- docs/IE_DG/supported_plugins/FPGA.md | 18 +++ docs/Legal_Information.md | 6 +- docs/doxygen/ie_docs.xml | 118 +++++++++--------- .../installing-openvino-linux-fpga.md | 18 +++ .../installing-openvino-macos.md | 4 +- .../installing-openvino-raspbian.md | 2 +- .../installing-openvino-windows-fpga.md | 32 +++-- .../installing-openvino-windows.md | 16 +-- 10 files changed, 139 insertions(+), 85 deletions(-) diff --git a/docs/IE_DG/Integrate_with_customer_application_new_API.md b/docs/IE_DG/Integrate_with_customer_application_new_API.md index 07618a77a0a..2dee8b04317 100644 --- a/docs/IE_DG/Integrate_with_customer_application_new_API.md +++ b/docs/IE_DG/Integrate_with_customer_application_new_API.md @@ -295,7 +295,7 @@ It's allowed to specify additional build options (e.g. to build CMake project on > **NOTE**: Before running, make sure you completed **Set the Environment Variables** section in [OpenVINO Installation](../../inference-engine/samples/hello_nv12_input_classification/README.md) document so that the application can find the libraries. -To run compiled applications on Microsoft* Windows* OS, make sure that Microsoft* Visual C++ 2015 +To run compiled applications on Microsoft* Windows* OS, make sure that Microsoft* Visual C++ 2017 Redistributable and Intel® C++ Compiler 2017 Redistributable packages are installed and `/bin/intel64/Release/*.dll` files are placed to the application folder or accessible via `%PATH%` environment variable. diff --git a/docs/IE_DG/Samples_Overview.md b/docs/IE_DG/Samples_Overview.md index af60575f2aa..6f4411d47ba 100644 --- a/docs/IE_DG/Samples_Overview.md +++ b/docs/IE_DG/Samples_Overview.md @@ -51,7 +51,7 @@ The officially supported Linux* build environment is the following: * Ubuntu* 16.04 LTS 64-bit or CentOS* 7.4 64-bit * GCC* 5.4.0 (for Ubuntu* 16.04) or GCC* 4.8.5 (for CentOS* 7.4) -* CMake* version 2.8 or higher +* CMake* version 2.8.12 or higher To build the C or C++ sample applications for Linux, go to the `/inference_engine/samples/c` or `/inference_engine/samples/cpp` directory, respectively, and run the `build_samples.sh` script: ```sh @@ -98,8 +98,8 @@ for the debug configuration — in `/intel64/Debug/`. The recommended Windows* build environment is the following: * Microsoft Windows* 10 -* Microsoft Visual Studio* 2015, 2017, or 2019 -* CMake* version 2.8 or higher +* Microsoft Visual Studio* 2017, or 2019 +* CMake* version 2.8.12 or higher > **NOTE**: If you want to use Microsoft Visual Studio 2019, you are required to install CMake 3.14. @@ -110,7 +110,7 @@ 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. Optionally, you can also specify the preferred Microsoft Visual Studio version to be used by the script. Supported -versions are `VS2015`, `VS2017`, and `VS2019`. For example, to build the C++ samples using the Microsoft Visual Studio 2017, use the following command: +versions are `VS2017` and `VS2019`. For example, to build the C++ samples using the Microsoft Visual Studio 2017, use the following command: ```sh \inference_engine\samples\cpp\build_samples_msvc.bat VS2017 ``` diff --git a/docs/IE_DG/supported_plugins/FPGA.md b/docs/IE_DG/supported_plugins/FPGA.md index c7c080bb4cc..ee76253db04 100644 --- a/docs/IE_DG/supported_plugins/FPGA.md +++ b/docs/IE_DG/supported_plugins/FPGA.md @@ -1,6 +1,24 @@ FPGA Plugin {#openvino_docs_IE_DG_supported_plugins_FPGA} =========== +## Product Change Notice +Intel® Distribution of OpenVINO™ toolkit for Intel® Vision Accelerator Design with an Intel® Arria® 10 FPGA and the Intel® Programmable Acceleration Card with Intel® Arria® 10 GX FPGA + + + + + + + + + + +
Change Notice BeginsJuly 2020
Change DateOctober 2020
+ +Intel will be transitioning to the next-generation programmable deep-learning solution based on FPGAs in order to increase the level of customization possible in FPGA deep-learning. As part of this transition, future standard releases (i.e., non-LTS releases) of Intel® Distribution of OpenVINO™ toolkit will no longer include the Intel® Vision Accelerator Design with an Intel® Arria® 10 FPGA and the Intel® Programmable Acceleration Card with Intel® Arria® 10 GX FPGA. + +Intel® Distribution of OpenVINO™ toolkit 2020.3.X LTS release will continue to support Intel® Vision Accelerator Design with an Intel® Arria® 10 FPGA and the Intel® Programmable Acceleration Card with Intel® Arria® 10 GX FPGA. For questions about next-generation programmable deep-learning solutions based on FPGAs, please talk to your sales representative or contact us to get the latest FPGA updates. + ## Introducing FPGA Plugin The FPGA plugin provides an opportunity for high performance scoring of neural networks on Intel® FPGA devices. diff --git a/docs/Legal_Information.md b/docs/Legal_Information.md index 17c3788f9ea..4bcb046a890 100644 --- a/docs/Legal_Information.md +++ b/docs/Legal_Information.md @@ -2,11 +2,11 @@ This software and the related documents are Intel copyrighted materials, and your use of them is governed by the express license (the “License”) under which they were provided to you. No license (express or implied, by estoppel or otherwise) to any intellectual property rights is granted by this document. Unless the License provides otherwise, you may not use, modify, copy, publish, distribute, disclose or transmit this software or the related documents without Intel's prior written permission. This software and the related documents are provided as is, with no express or implied warranties, other than those that are expressly stated in the License. Intel disclaims all express and implied warranties, including without limitation, the implied warranties of merchantability, fitness for a particular purpose, and non-infringement, as well as any warranty arising from course of performance, course of dealing, or usage in trade. -This document contains information on products, services and/or processes in development. All information provided here is subject to change without notice. Contact your Intel representative to obtain the latest forecast, schedule, specifications and roadmaps. The products and services described may contain defects or errors known as errata which may cause deviations from published specifications. Current characterized errata are available on request. Copies of documents which have an order number and are referenced in this document may be obtained by calling 1-800-548-4725 or by visiting [www.intel.com/design/literature.htm](www.intel.com/design/literature.htm). +This document contains information on products, services and/or processes in development. All information provided here is subject to change without notice. Contact your Intel representative to obtain the latest forecast, schedule, specifications and roadmaps. The products and services described may contain defects or errors known as errata which may cause deviations from published specifications. Current characterized errata are available on request. Copies of documents which have an order number and are referenced in this document may be obtained by calling 1-800-548-4725 or by visiting [www.intel.com/design/literature.htm](https://www.intel.com/design/literature.htm). Software and workloads used in performance tests may have been optimized for performance only on Intel microprocessors. -Performance tests, such as SYSmark and MobileMark, are measured using specific computer systems, components, software, operations and functions. Any change to any of those factors may cause the results to vary. You should consult other information and performance tests to assist you in fully evaluating your contemplated purchases, including the performance of that product when combined with other products. For more complete information visit [www.intel.com/benchmarks](www.intel.com/benchmarks). +Performance tests, such as SYSmark and MobileMark, are measured using specific computer systems, components, software, operations and functions. Any change to any of those factors may cause the results to vary. You should consult other information and performance tests to assist you in fully evaluating your contemplated purchases, including the performance of that product when combined with other products. For more complete information visit [www.intel.com/benchmarks](https://www.intel.com/benchmarks). Performance results are based on testing as of dates shown in configurations and may not reflect all publicly available updates. See backup for configuration details. No product or component can be absolutely secure. @@ -14,4 +14,4 @@ Your costs and results may vary. Intel technologies may require enabled hardware, software or service activation. -© Intel Corporation. Intel, the Intel logo, and other Intel marks are trademarks of Intel Corporation or its subsidiaries. Other names and brands may be claimed as the property of others. +© Intel Corporation. Intel, the Intel logo, and other Intel marks are trademarks of Intel Corporation or its subsidiaries. \*Other names and brands may be claimed as the property of others. diff --git a/docs/doxygen/ie_docs.xml b/docs/doxygen/ie_docs.xml index c9b25381ea6..29a15f4fd59 100644 --- a/docs/doxygen/ie_docs.xml +++ b/docs/doxygen/ie_docs.xml @@ -288,69 +288,69 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + diff --git a/docs/install_guides/installing-openvino-linux-fpga.md b/docs/install_guides/installing-openvino-linux-fpga.md index 50e41b5922a..8841315a681 100644 --- a/docs/install_guides/installing-openvino-linux-fpga.md +++ b/docs/install_guides/installing-openvino-linux-fpga.md @@ -11,6 +11,24 @@ support, see [Installation Guide for Linux*](installing-openvino-linux.md). are not covered in this guide. - An internet connection is required to follow the steps in this guide. +## Product Change Notice +Intel® Distribution of OpenVINO™ toolkit for Intel® Vision Accelerator Design with an Intel® Arria® 10 FPGA and the Intel® Programmable Acceleration Card with Intel® Arria® 10 GX FPGA + + + + + + + + + + +
Change Notice BeginsJuly 2020
Change DateOctober 2020
+ +Intel will be transitioning to the next-generation programmable deep-learning solution based on FPGAs in order to increase the level of customization possible in FPGA deep-learning. As part of this transition, future standard releases (i.e., non-LTS releases) of Intel® Distribution of OpenVINO™ toolkit will no longer include the Intel® Vision Accelerator Design with an Intel® Arria® 10 FPGA and the Intel® Programmable Acceleration Card with Intel® Arria® 10 GX FPGA. + +Intel® Distribution of OpenVINO™ toolkit 2020.3.X LTS release will continue to support Intel® Vision Accelerator Design with an Intel® Arria® 10 FPGA and the Intel® Programmable Acceleration Card with Intel® Arria® 10 GX FPGA. For questions about next-generation programmable deep-learning solutions based on FPGAs, please talk to your sales representative or contact us to get the latest FPGA updates. + ## Introduction The Intel® Distribution of OpenVINO™ toolkit quickly deploys applications and solutions that emulate human vision. Based on Convolutional Neural Networks (CNN), the toolkit extends computer vision (CV) workloads across Intel® hardware, maximizing performance. The Intel® Distribution of OpenVINO™ toolkit includes the Intel® Deep Learning Deployment Toolkit (Intel® DLDT). diff --git a/docs/install_guides/installing-openvino-macos.md b/docs/install_guides/installing-openvino-macos.md index 9da8173f28f..f6aa72628fe 100644 --- a/docs/install_guides/installing-openvino-macos.md +++ b/docs/install_guides/installing-openvino-macos.md @@ -48,8 +48,8 @@ The development and target platforms have the same requirements, but you can sel **Software Requirements** -- CMake 3.4 or higher -- Python 3.5 or higher +- CMake 3.9 or higher +- Python 3.5 - 3.7 - Apple Xcode\* Command Line Tools - (Optional) Apple Xcode\* IDE (not required for OpenVINO, but useful for development) diff --git a/docs/install_guides/installing-openvino-raspbian.md b/docs/install_guides/installing-openvino-raspbian.md index d21855c92e1..a9398d2d5c6 100644 --- a/docs/install_guides/installing-openvino-raspbian.md +++ b/docs/install_guides/installing-openvino-raspbian.md @@ -190,4 +190,4 @@ If you want to use your model for inference, the model must be converted to the * [Installation Guide for Windows*](installing-openvino-windows.md) * [Installation Guide for Linux*](installing-openvino-linux.md) - For more information about how to use the Model Optimizer, see the [Model Optimizer Developer Guide](https://software.intel.com/articles/OpenVINO-ModelOptimizer) + For more information about how to use the Model Optimizer, see the [Model Optimizer Developer Guide](../MO_DG/Deep_Learning_Model_Optimizer_DevGuide.md). diff --git a/docs/install_guides/installing-openvino-windows-fpga.md b/docs/install_guides/installing-openvino-windows-fpga.md index d2ca21de7c4..1bfa3c94b57 100644 --- a/docs/install_guides/installing-openvino-windows-fpga.md +++ b/docs/install_guides/installing-openvino-windows-fpga.md @@ -7,6 +7,24 @@ support, see [Installation Guide for Windows*](installing-openvino-windows.md). - An internet connection is required to follow the steps in this guide. - [Intel® System Studio](https://software.intel.com/en-us/system-studio) is an all-in-one, cross-platform tool suite, purpose-built to simplify system bring-up and improve system and IoT device application performance on Intel® platforms. If you are using the Intel® Distribution of OpenVINO™ with Intel® System Studio, go to [Get Started with Intel® System Studio](https://software.intel.com/en-us/articles/get-started-with-openvino-and-intel-system-studio-2019). +## Product Change Notice +Intel® Distribution of OpenVINO™ toolkit for Intel® Vision Accelerator Design with an Intel® Arria® 10 FPGA and the Intel® Programmable Acceleration Card with Intel® Arria® 10 GX FPGA + + + + + + + + + + +
Change Notice BeginsJuly 2020
Change DateOctober 2020
+ +Intel will be transitioning to the next-generation programmable deep-learning solution based on FPGAs in order to increase the level of customization possible in FPGA deep-learning. As part of this transition, future standard releases (i.e., non-LTS releases) of Intel® Distribution of OpenVINO™ toolkit will no longer include the Intel® Vision Accelerator Design with an Intel® Arria® 10 FPGA and the Intel® Programmable Acceleration Card with Intel® Arria® 10 GX FPGA. + +Intel® Distribution of OpenVINO™ toolkit 2020.3.X LTS release will continue to support Intel® Vision Accelerator Design with an Intel® Arria® 10 FPGA and the Intel® Programmable Acceleration Card with Intel® Arria® 10 GX FPGA. For questions about next-generation programmable deep-learning solutions based on FPGAs, please talk to your sales representative or contact us to get the latest FPGA updates. + ## Introduction > **IMPORTANT**: @@ -19,10 +37,10 @@ Your installation is complete when these are all completed: 2. Install the dependencies: - - [Microsoft Visual Studio* with C++ **2019, 2017, or 2015** with MSBuild](http://visualstudio.microsoft.com/downloads/) - - [CMake **3.4 or higher** 64-bit](https://cmake.org/download/) + - [Microsoft Visual Studio* with C++ **2019 or 2017** with MSBuild](http://visualstudio.microsoft.com/downloads/) + - [CMake **2.8.12 or higher** 64-bit](https://cmake.org/download/) > **NOTE**: If you want to use Microsoft Visual Studio 2019, you are required to install CMake 3.14. - - [Python **3.6.5** 64-bit](https://www.python.org/downloads/release/python-365/) + - [Python **3.5**-**3.7** 64-bit](https://www.python.org/downloads/windows/) > **IMPORTANT**: As part of this installation, make sure you click the option to add the application to your `PATH` environment variable. 3. Set Environment Variables @@ -77,7 +95,7 @@ The development and target platforms have the same requirements, but you can sel * Intel Pentium® processor N4200/5, N3350/5, or N3450/5 with Intel® HD Graphics * Intel® Neural Compute Stick 2 * Intel® Vision Accelerator Design with Intel® Movidius™ VPUs -* Intel® Vision Accelerator Design with an Intel® Arria 10 FPGA (Mustang-F100-A10) SG2 +* Intel® Vision Accelerator Design with an Intel® Arria® 10 FPGA (Mustang-F100-A10) SG2 > **NOTE**: With OpenVINO™ 2020.4 release, Intel® Movidius™ Neural Compute Stick is no longer supported. @@ -93,8 +111,8 @@ The development and target platforms have the same requirements, but you can sel - Microsoft Windows 10*, 64-bit **Software** -- [Microsoft Visual Studio* with C++ **2019, 2017, or 2015** with MSBuild](http://visualstudio.microsoft.com/downloads/) -- [CMake **3.4 or higher** 64-bit](https://cmake.org/download/) +- [Microsoft Visual Studio* with C++ **2019 or 2017** with MSBuild](http://visualstudio.microsoft.com/downloads/) +- [CMake **2.8.12 or higher** 64-bit](https://cmake.org/download/) > **NOTE**: If you want to use Microsoft Visual Studio 2019, you are required to install CMake 3.14. - [Python **3.6.5** 64-bit](https://www.python.org/downloads/release/python-365/) @@ -355,7 +373,7 @@ To perform inference on Intel® Vision Accelerator Design with Intel® Movidius 1. Go to the `\deployment_tools\inference-engine\external\hddl\SMBusDriver` directory, where `` is the directory in which the Intel Distribution of OpenVINO toolkit is installed. 2. Right click on the `hddlsmbus.inf` file and choose **Install** from the pop up menu. - 2. Download and install Visual C++ Redistributable for Visual Studio 2015 + 2. Download and install Visual C++ Redistributable for Visual Studio 2017 You are done installing your device driver and are ready to use your Intel® Vision Accelerator Design with Intel® Movidius™ VPUs. diff --git a/docs/install_guides/installing-openvino-windows.md b/docs/install_guides/installing-openvino-windows.md index 6eb7e87da98..589f97dc71c 100644 --- a/docs/install_guides/installing-openvino-windows.md +++ b/docs/install_guides/installing-openvino-windows.md @@ -18,10 +18,10 @@ Your installation is complete when these are all completed: 2. Install the dependencies: - - [Microsoft Visual Studio* with C++ **2019, 2017, or 2015** with MSBuild](http://visualstudio.microsoft.com/downloads/) - - [CMake **3.4 or higher** 64-bit](https://cmake.org/download/) + - [Microsoft Visual Studio* with C++ **2019 or 2017** with MSBuild](http://visualstudio.microsoft.com/downloads/) + - [CMake **2.8.12 or higher** 64-bit](https://cmake.org/download/) > **NOTE**: If you want to use Microsoft Visual Studio 2019, you are required to install CMake 3.14. - - [Python **3.6.5** 64-bit](https://www.python.org/downloads/release/python-365/) + - [Python **3.5** - **3.7** 64-bit](https://www.python.org/downloads/windows/) > **IMPORTANT**: As part of this installation, make sure you click the option to add the application to your `PATH` environment variable. 3. Set Environment Variables @@ -90,10 +90,10 @@ The following components are installed by default: - Microsoft Windows\* 10 64-bit **Software** -- [Microsoft Visual Studio* with C++ **2019, 2017, or 2015** with MSBuild](http://visualstudio.microsoft.com/downloads/) -- [CMake **3.4 or higher** 64-bit](https://cmake.org/download/) +- [Microsoft Visual Studio* with C++ **2019 or 2017** with MSBuild](http://visualstudio.microsoft.com/downloads/) +- [CMake **2.8.12 or higher** 64-bit](https://cmake.org/download/) > **NOTE**: If you want to use Microsoft Visual Studio 2019, you are required to install CMake 3.14. -- [Python **3.6.5** 64-bit](https://www.python.org/downloads/release/python-365/) +- [Python **3.5** - **3.7** 64-bit](https://www.python.org/downloads/windows/) ## Installation Steps @@ -296,7 +296,7 @@ In this section, you saw a preview of the Intel® Distribution of OpenVINO™ to Congratulations. You have completed all the required installation, configuration, and build steps to work with your trained models using CPU. -If you want to use Intel® Processor graphics (GPU), Intel® Neural Compute Stick 2 or Intel® Vision Accelerator Design with Intel® Movidius™ (VPU), or add CMake* and Python* to your Windows* environment variables, read through the next section for additional steps. +If you want to use Intel® Processor graphics (GPU), Intel® Neural Compute Stick 2 or Intel® Vision Accelerator Design with Intel® Movidius™ VPUs, or add CMake* and Python* to your Windows* environment variables, read through the next section for additional steps. If you want to continue and run the Image Classification Sample Application on one of the supported hardware device, see the [Run the Image Classification Sample Application](#run-the-image-classification-sample-application) section. @@ -340,7 +340,7 @@ To perform inference on Intel® Vision Accelerator Design with Intel® Movidius 1. Go to the `\deployment_tools\inference-engine\external\hddl\SMBusDriver` directory, where `` is the directory in which the Intel Distribution of OpenVINO toolkit is installed. 2. Right click on the `hddlsmbus.inf` file and choose **Install** from the pop up menu. - 2. Download and install Visual C++ Redistributable for Visual Studio 2015 + 2. Download and install Visual C++ Redistributable for Visual Studio 2017 You are done installing your device driver and are ready to use your Intel® Vision Accelerator Design with Intel® Movidius™ VPUs.