Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/ntyukaev/separate layout #2629

Merged
merged 70 commits into from
Oct 14, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
70 commits
Select commit Hold shift + click to select a range
6b04629
convert to doxygen comments
Sep 22, 2020
092e47d
layouts and code comments
Sep 25, 2020
78f1fcf
Merge remote-tracking branch 'upstream/releases/2021/1' into feature/…
Sep 25, 2020
c063423
separate layout
Oct 1, 2020
5b16d26
Merge remote-tracking branch 'upstream/releases/2021/1' into feature/…
andrew-zaytsev Oct 1, 2020
af0ecd9
Changed layouts
andrew-zaytsev Oct 2, 2020
bb19e1c
Removed FPGA from the documentation
andrew-zaytsev Oct 2, 2020
36ab5d6
Updated according to CVS-38225
andrew-zaytsev Oct 2, 2020
a4d8958
some changes
Oct 2, 2020
ab5faa5
Merge branch 'feature/ntyukaev/separate-layout' of https://github.com…
Oct 2, 2020
2751606
Merge remote-tracking branch 'upstream/releases/2021/1' into feature/…
andrew-zaytsev Oct 3, 2020
dc08959
Made changes to benchmarks according to review comments
andrew-zaytsev Oct 3, 2020
6087c71
Merge branch 'feature/ntyukaev/separate-layout' of https://github.com…
Oct 5, 2020
7858330
Merge remote-tracking branch 'upstream/releases/2021/1' into feature/…
andrew-zaytsev Oct 5, 2020
312a33c
Added logo info to the Legal_Information, updated Ubuntu, CentOS supp…
andrew-zaytsev Oct 5, 2020
bc9ef3b
Updated supported Intel® Core™ processors list
andrew-zaytsev Oct 5, 2020
eb7e5bc
Fixed table formatting
andrew-zaytsev Oct 5, 2020
671f2d4
Merge remote-tracking branch 'upstream/releases/2021/1' into feature/…
Oct 5, 2020
182f53c
update api layouts
Oct 6, 2020
cd74562
Added new index page with overview
andrew-zaytsev Oct 6, 2020
fa23de8
Changed CMake and Python versions
andrew-zaytsev Oct 6, 2020
6e304df
Merge remote-tracking branch 'upstream/releases/2021/1' into feature/…
ntyukaev Oct 6, 2020
a308fa5
Merge remote-tracking branch 'zaytsev/feature/azaytsev/docs-2021-1' i…
Oct 6, 2020
94d5318
Fixed links
andrew-zaytsev Oct 6, 2020
0039126
some layout changes
Oct 6, 2020
fdc785d
some layout changes
Oct 6, 2020
59c93e5
some layout changes
Oct 6, 2020
f97cc10
Merge remote-tracking branch 'origin/feature/ntyukaev/ngraph-python-a…
Oct 6, 2020
2962a9d
COnverted svg images to png
andrew-zaytsev Oct 6, 2020
c2fa681
layouts
Oct 6, 2020
efe41e4
Merge remote-tracking branch 'zaytsev/feature/azaytsev/docs-2021-1' i…
Oct 6, 2020
6bc7be0
update layout
Oct 6, 2020
b7b5372
Merge remote-tracking branch 'upstream/releases/2021/1' into feature/…
andrew-zaytsev Oct 6, 2020
2cb0de9
Added a label for nGraph_Python_API.md
andrew-zaytsev Oct 6, 2020
f34c86f
fixed links
andrew-zaytsev Oct 6, 2020
5cf882d
Merge remote-tracking branch 'zaytsev/feature/azaytsev/docs-2021-1' i…
Oct 6, 2020
b86a8af
Fixed image
andrew-zaytsev Oct 6, 2020
c3f7659
Merge remote-tracking branch 'upstream/releases/2021/1' into feature/…
andrew-zaytsev Oct 6, 2020
a979303
Merge remote-tracking branch 'zaytsev/feature/azaytsev/docs-2021-1' i…
Oct 6, 2020
113a1b3
Merge remote-tracking branch 'upstream/releases/2021/1' into feature/…
Oct 6, 2020
f224e9c
removed links to ../IE_DG/Introduction.md
andrew-zaytsev Oct 6, 2020
b98e8d8
Removed links to tools overview page as removed
andrew-zaytsev Oct 6, 2020
7481a29
some changes
Oct 6, 2020
3225482
Merge branch 'feature/ntyukaev/separate-layout' of https://github.com…
Oct 6, 2020
984ea4c
Remove link to Integrate_your_kernels_into_IE.md
andrew-zaytsev Oct 6, 2020
5924bb1
Merge branch 'feature/ntyukaev/separate-layout' of https://github.com…
andrew-zaytsev Oct 6, 2020
f3cb0a4
Merge remote-tracking branch 'upstream/releases/2021/1' into feature/…
Oct 7, 2020
9300a69
Merge branch 'feature/ntyukaev/separate-layout' of https://github.com…
Oct 7, 2020
a72cfc0
remove openvino_docs_IE_DG_Graph_debug_capabilities from layout as it…
andrew-zaytsev Oct 7, 2020
6417ac8
Merge remote-tracking branch 'upstream/releases/2021/1' into feature/…
Oct 7, 2020
cb4ff59
update layouts
Oct 7, 2020
7fc1e9d
Post-release fixes and installation path changes
andrew-zaytsev Oct 8, 2020
b006667
Merge remote-tracking branch 'upstream/releases/2021/1' into feature/…
Oct 8, 2020
d3341d7
Merge branch 'feature/ntyukaev/separate-layout' of https://github.com…
Oct 8, 2020
a953fed
Added PIP installation and Build from Source to the layout
andrew-zaytsev Oct 9, 2020
c8ff950
Merge remote-tracking branch 'upstream/releases/2021/1' into feature/…
andrew-zaytsev Oct 9, 2020
c38c987
Fixed formatting issue, removed broken link
andrew-zaytsev Oct 9, 2020
fd0c196
Renamed section EXAMPLES to RESOURCES according to review comments
andrew-zaytsev Oct 9, 2020
541ca0a
add mo faq navigation by url param
Oct 9, 2020
32dd0b2
Merge branch 'feature/ntyukaev/separate-layout' of https://github.com…
Oct 9, 2020
4e65b75
Removed DLDT description
andrew-zaytsev Oct 12, 2020
d16a4d5
Merge remote-tracking branch 'ntyukaev/feature/ntyukaev/separate-layo…
andrew-zaytsev Oct 12, 2020
c961889
Replaced wrong links
aalborov Oct 12, 2020
6aa0d2b
MInor fix for path to the cpp samples
andrew-zaytsev Oct 12, 2020
1a0fa41
fixes
aalborov Oct 12, 2020
d2d44c1
Merge pull request #4 from aalborov/aalborov/38873/wrong-links
aalborov Oct 12, 2020
8c7db7d
Update ops.py
andrew-zaytsev Oct 13, 2020
8105d88
Fix style
rblaczkowski Oct 14, 2020
baa4c7c
Merge branch 'releases/2021/1' into feature/ntyukaev/separate-layout
Oct 14, 2020
7118058
Merge branch 'releases/2021/1' into feature/ntyukaev/separate-layout
andrew-zaytsev Oct 14, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/HOWTO/Custom_Layers_Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ For a step-by-step walk-through creating and executing a custom layer, see [Cust
- Intel® Distribution of OpenVINO™ toolkit home page: [https://software.intel.com/en-us/openvino-toolkit](https://software.intel.com/en-us/openvino-toolkit)
- OpenVINO™ toolkit online documentation: [https://docs.openvinotoolkit.org](https://docs.openvinotoolkit.org)
- [Model Optimizer Developer Guide](../MO_DG/Deep_Learning_Model_Optimizer_DevGuide.md)
- [Kernel Extensivility in the Inference Engine Developer Guide](../IE_DG/Integrate_your_kernels_into_IE.md)
- [Inference Engine Extensibility Mechanism](../IE_DG/Extensibility_DG/Intro.md)
- [Inference Engine Samples Overview](../IE_DG/Samples_Overview.md)
- [Overview of OpenVINO™ Toolkit Pre-Trained Models](@ref omz_models_intel_index)
- [Inference Engine Tutorials](https://github.com/intel-iot-devkit/inference-tutorials-generic)
Expand Down
4 changes: 1 addition & 3 deletions docs/IE_DG/Deep_Learning_Inference_Engine_DevGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,6 @@ inference of a pre-trained and optimized deep learning model and a set of sample

## Table of Contents

* [Introduction to Intel® Deep Learning Deployment Toolkit](Introduction.md)

* [Inference Engine API Changes History](API_Changes.md)

* [Introduction to Inference Engine](inference_engine_intro.md)
Expand Down Expand Up @@ -87,4 +85,4 @@ inference of a pre-trained and optimized deep learning model and a set of sample

* [Known Issues](Known_Issues_Limitations.md)

**Typical Next Step:** [Introduction to Intel® Deep Learning Deployment Toolkit](Introduction.md)
**Typical Next Step:** [Introduction to Inference Engine](inference_engine_intro.md)
2 changes: 1 addition & 1 deletion docs/IE_DG/PythonPackage_Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ The OpenVINO™ Python\* package includes the following sub-packages:
- `openvino.tools.benchmark` - Measure latency and throughput.

## See Also
* [Introduction to Intel's Deep Learning Inference Engine](Introduction.md)
* [Introduction to Inference Engine](inference_engine_intro.md)
2 changes: 1 addition & 1 deletion docs/IE_DG/Samples_Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,4 +183,4 @@ sample, read the sample documentation by clicking the sample name in the samples
list above.

## See Also
* [Introduction to Intel's Deep Learning Inference Engine](Introduction.md)
* [Introduction to Inference Engine](inference_engine_intro.md)
2 changes: 1 addition & 1 deletion docs/IE_DG/Tools_Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ The OpenVINO™ toolkit installation includes the following tools:


## See Also
* [Introduction to Deep Learning Inference Engine](Introduction.md)
* [Introduction to Inference Engine](inference_engine_intro.md)
5 changes: 3 additions & 2 deletions docs/IE_DG/supported_plugins/MYRIAD.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,12 @@ The Inference Engine MYRIAD plugin is developed for inference of neural networks

## Installation on Linux* OS

For installation instructions, refer to the [Installation Guide for Linux*](../../../inference-engine/samples/benchmark_app/README.md).
For installation instructions, refer to the [Installation Guide for Linux*](../../install_guides/installing-openvino-linux.md).


## Installation on Windows* OS

For installation instructions, refer to the [Installation Guide for Windows*](../../../inference-engine/samples/benchmark_app/README.md).
For installation instructions, refer to the [Installation Guide for Windows*](../../install_guides/installing-openvino-windows.md).

## Supported networks

Expand Down
4 changes: 1 addition & 3 deletions docs/MO_DG/Deep_Learning_Model_Optimizer_DevGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,6 @@ Model Optimizer produces an Intermediate Representation (IR) of the network, whi

## Table of Content

* [Introduction to OpenVINO™ Deep Learning Deployment Toolkit](../IE_DG/Introduction.md)

* [Preparing and Optimizing your Trained Model with Model Optimizer](prepare_model/Prepare_Trained_Model.md)
* [Configuring Model Optimizer](prepare_model/Config_Model_Optimizer.md)
* [Converting a Model to Intermediate Representation (IR)](prepare_model/convert_model/Converting_Model.md)
Expand Down Expand Up @@ -107,4 +105,4 @@ Model Optimizer produces an Intermediate Representation (IR) of the network, whi

* [Known Issues](Known_Issues_Limitations.md)

**Typical Next Step:** [Introduction to Intel® Deep Learning Deployment Toolkit](../IE_DG/Introduction.md)
**Typical Next Step:** [Preparing and Optimizing your Trained Model with Model Optimizer](prepare_model/Prepare_Trained_Model.md)
13 changes: 13 additions & 0 deletions docs/MO_DG/prepare_model/Model_Optimizer_FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -615,3 +615,16 @@ You need to specify values for each input of the model. For more information, re
#### 102. What does the message "Operation _contrib_box_nms is not supported ..." mean? <a name="question-102"></a>

It means that you trying to convert the topology which contains '_contrib_box_nms' operation which is not supported directly. However the sub-graph of operations including the '_contrib_box_nms' could be replaced with DetectionOutput layer if your topology is one of the gluoncv topologies. Specify '--enable_ssd_gluoncv' command line parameter for the Model Optimizer to enable this transformation.

\htmlonly

<script>
window.addEventListener('load', function(){
var questionID = getURLParameter('question'); /* this function is defined in openvino-layout.js */
if (questionID) {
window.location = window.location.pathname + '#' + encodeURI(questionID);
}
});
</script>

\endhtmlonly
2 changes: 1 addition & 1 deletion docs/benchmarks/performance_benchmarks.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ Testing by Intel done on: see test date for each HW platform below.

| | Intel® Core™ i5-8500 | Intel® Core™ i7-8700T | Intel® Core™ i9-10920X | 11th Gen Intel® Core™ i5-1145G7E |
| -------------------- | ---------------------------------- | ----------------------------------- |--------------------------------------|-----------------------------------|
| Motherboard | ASUS* PRIME Z370-A | GIGABYTE* Z370M DS3H-CF | ASUS* PRIME X299-A II | Intel Corporation /<br>TigerLake U DDR4 SODIMM RVP |
| Motherboard | ASUS* PRIME Z370-A | GIGABYTE* Z370M DS3H-CF | ASUS* PRIME X299-A II | Intel Corporation<br>internal/Reference Validation Platform |
| CPU | Intel® Core™ i5-8500 CPU @ 3.00GHz | Intel® Core™ i7-8700T CPU @ 2.40GHz | Intel® Core™ i9-10920X CPU @ 3.50GHz | 11th Gen Intel® Core™ i5-1145G7E @ 2.60GHz |
| Hyper Threading | OFF | ON | ON | ON |
| Turbo Setting | ON | ON | ON | ON |
Expand Down
11 changes: 4 additions & 7 deletions docs/benchmarks/performance_benchmarks_faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,19 +51,16 @@ We published a set of guidelines and recommendations to optimize your models ava
#### 9. Why are INT8 optimized models used for benchmarking on CPUs with no VNNI support?
The benefit of low-precision optimization using the OpenVINO™ toolkit model optimizer extends beyond processors supporting VNNI through Intel® DL Boost. The reduced bit width of INT8 compared to FP32 allows Intel® CPU to process the data faster and thus offers better throughput on any converted model agnostic of the intrinsically supported low-precision optimizations within Intel® hardware. Please refer to [INT8 vs. FP32 Comparison on Select Networks and Platforms](./performance_int8_vs_fp32.html) for comparison on boost factors for different network models and a selection of Intel® CPU architectures, including AVX-2 with Intel® Core™ i7-8700T, and AVX-512 (VNNI) with Intel® Xeon® 5218T and Intel® Xeon® 8270.

#### 10. Previous releases included benchmarks on googlenet-v1. Why is there no longer benchmarks on this neural network model?
We replaced googlenet-v1 to [resnet-18-pytorch](https://github.com/opencv/open_model_zoo/blob/master/models/public/resnet-18-pytorch/resnet-18-pytorch.md) due to changes in developer usage. The public model resnet-18 is used by many developers as an Image Classification model. This pre-optimized model was also trained on the ImageNet database, similar to googlenet-v1. Both googlenet-v1 and resnet-18 will remain part of the Open Model Zoo. Developers are encouraged to utilize resnet-18-pytorch for Image Classification use cases.

#### 11. Previous releases included benchmarks on googlenet-v1-CF (Caffe). Why is there no longer benchmarks on this neural network model?
#### 10. Previous releases included benchmarks on googlenet-v1-CF (Caffe). Why is there no longer benchmarks on this neural network model?
We replaced googlenet-v1-CF to resnet-18-pytorch due to changes in developer usage. The public model resnet-18 is used by many developers as an Image Classification model. This pre-optimized model was also trained on the ImageNet database, similar to googlenet-v1-CF. Both googlenet-v1-CF and resnet-18 will remain part of the Open Model Zoo. Developers are encouraged to utilize resnet-18-pytorch for Image Classification use cases.

#### 12. Why have resnet-50-CF, mobilenet-v1-1.0-224-CF, mobilenet-v2-CF and resnet-101-CF been removed?
#### 11. Why have resnet-50-CF, mobilenet-v1-1.0-224-CF, mobilenet-v2-CF and resnet-101-CF been removed?
The CAFFE version of resnet-50, mobilenet-v1-1.0-224 and mobilenet-v2 have been replaced with their TensorFlow and PyTorch counterparts. Resnet-50-CF is replaced by resnet-50-TF, mobilenet-v1-1.0-224-CF is replaced by mobilenet-v1-1.0-224-TF and mobilenet-v2-CF is replaced by mobilenetv2-PyTorch. Resnet-50-CF an resnet-101-CF are no longer maintained at their public source repos.

#### 13. Where can I search for OpenVINO™ performance results based on HW-platforms?
#### 12. Where can I search for OpenVINO™ performance results based on HW-platforms?
The web site format has changed in order to support the more common search approach of looking for the performance of a given neural network model on different HW-platforms. As opposed to review a given HW-platform's performance on different neural network models.

#### 14. How is Latency measured?
#### 13. How is Latency measured?
Latency is measured by running the OpenVINO™ inference engine in synchronous mode. In synchronous mode each frame or image is processed through the entire set of stages (pre-processing, inference, post-processing) before the next frame or image is processed. This KPI is relevant for applications where the inference on a single image is required, for example the analysis of an ultra sound image in a medical application or the analysis of a seismic image in the oil & gas industry. Other use cases include real-time or near real-time applications like an industrial robot's response to changes in its environment and obstacle avoidance for autonomous vehicles where a quick response to the result of the inference is required.

\htmlonly
Expand Down
2 changes: 1 addition & 1 deletion docs/benchmarks/performance_int8_vs_fp32.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The table below illustrates the speed-up factor for the performance gain by swit
<th>Intel® Xeon® <br>Gold <br>5218T</th>
<th>Intel® Xeon® <br>Platinum <br>8270</th>
<th>Intel® Core™ <br>i7-1065G7</th>
<th>Intel® Core™ <br>i7-1145G7E</th>
<th>Intel® Core™ <br>i5-1145G7E</th>
</tr>
<tr align="left">
<th>OpenVINO <br>benchmark <br>model name</th>
Expand Down
4 changes: 2 additions & 2 deletions docs/doxygen/doxy_md_filter.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,9 @@ def process(docs_folder):
md_folder = os.path.dirname(md_file)
with open(md_file, 'r', encoding='utf-8') as f:
content = f.read()
inline_links = set(re.findall(r'!?\[.*?\]\(([\w\/\-\.]+\.(md|png|jpg|gif))\)', content, flags=re.IGNORECASE))
inline_links = set(re.findall(r'!?\[.*?\]\(([\w\/\-\.]+\.(md|png|jpg|gif|svg))\)', content, flags=re.IGNORECASE))
github_md_links = set(re.findall(r'(\[(.+?)\]\((https:[\w\.\/-]+?\.md)\))', content, flags=re.IGNORECASE))
reference_links = set(re.findall(r'\[.+\]\:\s*?([\w\/\-\.]+\.(md|png|jpg|gif))', content, flags=re.IGNORECASE))
reference_links = set(re.findall(r'\[.+\]\:\s*?([\w\/\-\.]+\.(md|png|jpg|gif|svg))', content, flags=re.IGNORECASE))
content = replace_links(content, inline_links, md_folder, labels, docs_folder)
content = replace_links(content, reference_links, md_folder, labels, docs_folder)
content = process_github_md_links(content, github_md_links)
Expand Down
14 changes: 8 additions & 6 deletions docs/doxygen/ie_c_api.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@
<!-- Navigation index tabs for HTML output -->
<navindex>
<tab type="mainpage" title="OpenVINO Home" url="../index.html"/>
<tab type="user" title="GETTING STARTED" url="../index.html"/>
<tab type="user" title="HOW TOs" url="../openvino_docs_how_tos_how_to_links.html"/>
<tab type="user" title="GUIDES" url="../openvino_docs_IE_DG_Introduction.html"/>
<tab type="user" title="RESOURCES" url="../openvino_docs_resources_introduction.html"/>
<tab type="user" title="PERFORMANCE BENCHMARKS" url="../openvino_docs_performance_benchmarks.html"/>
<tab type="usergroup" title="API REFERENCES" url="../usergroup14.html">
<tab type="user" title="Get Started" url="../index.html"/>
<tab type="user" title="Documentation" url="../documentation.html"/>
<tab type="user" title="Examples" url="../examples.html"/>
<tab type="usergroup" title="API REFERENCES" url="../api_references.html">
<!-- OpenVX -->
<tab type="user" title="OpenVX Developer Guide" url="https://khronos.org/openvx"/>
<!-- OpenCV -->
Expand All @@ -31,6 +29,10 @@
<tab type="user" title="Inference Engine Python API Reference" url="../ie_python_api/annotated.html"/>
<!-- DL Streamer -->
<tab type="user" title="DL Streamer API Reference" url="https://openvinotoolkit.github.io/dlstreamer_gst/"/>
<!-- nGraph C++ API -->
<tab type="user" title="nGraph C++ API Reference" url="../ngraph_cpp_api/annotated.html"/>
<!-- nGraph Python API -->
<tab type="user" title="nGraph Python API Reference" url="../ngraph_python_api/files.html"/>
</tab>
<!-- Chinese docs -->
<tab type="user" title="中文文件" url="https://docs.openvinotoolkit.org/cn/index.html"/>
Expand Down
Loading