41e7475731
* convert to doxygen comments * layouts and code comments * separate layout * Changed layouts * Removed FPGA from the documentation * Updated according to CVS-38225 * some changes * Made changes to benchmarks according to review comments * Added logo info to the Legal_Information, updated Ubuntu, CentOS supported versions * Updated supported Intel® Core™ processors list * Fixed table formatting * update api layouts * Added new index page with overview * Changed CMake and Python versions * Fixed links * some layout changes * some layout changes * some layout changes * COnverted svg images to png * layouts * update layout * Added a label for nGraph_Python_API.md * fixed links * Fixed image * removed links to ../IE_DG/Introduction.md * Removed links to tools overview page as removed * some changes * Remove link to Integrate_your_kernels_into_IE.md * remove openvino_docs_IE_DG_Graph_debug_capabilities from layout as it was removed * update layouts * Post-release fixes and installation path changes * Added PIP installation and Build from Source to the layout * Fixed formatting issue, removed broken link * Renamed section EXAMPLES to RESOURCES according to review comments * add mo faq navigation by url param * Removed DLDT description * Replaced wrong links * MInor fix for path to the cpp samples * fixes * Update ops.py * Fix style Co-authored-by: Nikolay Tyukaev <ntyukaev_lo@jenkins.inn.intel.com> Co-authored-by: Tyukaev <nikolay.tyukaev@intel.com> Co-authored-by: aalborov <alina.alborova@intel.com> Co-authored-by: Rafal Blaczkowski <rafal.blaczkowski@intel.com> Co-authored-by: Alexander Zhogov <alexander.zhogov@intel.com>
303 lines
18 KiB
XML
303 lines
18 KiB
XML
<doxygenlayout version="1.0" xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
<!-- Navigation index tabs for HTML output -->
|
|
<navindex>
|
|
<tab type="mainpage" title="OpenVINO Home" url="@ref index"/>
|
|
|
|
<!-- GET STARTED category -->
|
|
<tab type="usergroup" title="GET STARTED" url="index.html">
|
|
<!-- Install Directly -->
|
|
<tab type="usergroup" title="Install Directly" url=""><!--automatically generated-->
|
|
<tab type="usergroup" title="Linux" url="@ref openvino_docs_install_guides_installing_openvino_linux">
|
|
<tab type="user" title="Install Intel® Distribution of OpenVINO™ toolkit for Linux* OS" url="@ref openvino_docs_install_guides_installing_openvino_linux"/>
|
|
<tab type="user" title="[DEPRECATED] Install Intel® Distribution of OpenVINO™ toolkit for Linux with FPGA Support" url="@ref openvino_docs_install_guides_installing_openvino_linux_fpga"/>
|
|
</tab>
|
|
<tab type="usergroup" title="Windows" url="@ref openvino_docs_install_guides_installing_openvino_windows">
|
|
<tab type="user" title="Install Intel® Distribution of OpenVINO™ toolkit for Windows* 10" url="@ref openvino_docs_install_guides_installing_openvino_windows"/>
|
|
<tab type="user" title="[DEPRECATED] Install Intel® Distribution of OpenVINO™ toolkit for Windows* with FPGA support" url="@ref openvino_docs_install_guides_installing_openvino_windows_fpga"/>
|
|
</tab>
|
|
<tab type="user" title="macOS" url="@ref openvino_docs_install_guides_installing_openvino_macos"/>
|
|
<tab type="user" title="Raspbian OS" url="@ref openvino_docs_install_guides_installing_openvino_raspbian"/>
|
|
</tab>
|
|
<!-- Install From Images and Repositories -->
|
|
<tab type="usergroup" title="Install From Images and Repositories" url=""><!--automatically generated-->
|
|
<tab type="usergroup" title="Docker" url="@ref openvino_docs_install_guides_installing_openvino_docker_linux">
|
|
<tab type="user" title="Install Intel® Distribution of OpenVINO™ toolkit for Linux* from a Docker* Image" url="@ref openvino_docs_install_guides_installing_openvino_docker_linux"/>
|
|
<tab type="user" title="Install Intel® Distribution of OpenVINO™ toolkit for Windows* from a Docker* Image" url="@ref openvino_docs_install_guides_installing_openvino_docker_windows"/>
|
|
</tab>
|
|
<tab type="user" title="APT" url="@ref openvino_docs_install_guides_installing_openvino_apt"/>
|
|
<tab type="user" title="YUM" url="@ref openvino_docs_install_guides_installing_openvino_yum"/>
|
|
<tab type="user" title="Anaconda Cloud" url="@ref openvino_docs_install_guides_installing_openvino_conda"/>
|
|
<tab type="user" title="Yocto" url="@ref openvino_docs_install_guides_installing_openvino_yocto"/>
|
|
<tab type="user" title="PyPI" url="@ref openvino_docs_install_guides_installing_openvino_pip"/>
|
|
<tab type="user" title="Build from Source" url="https://github.com/openvinotoolkit/openvino/blob/master/build-instruction.md"/>
|
|
</tab>
|
|
<!-- Get Started Guides-->
|
|
<tab type="usergroup" title="Get Started Guides" url=""><!--automatically generated-->
|
|
<tab type="user" title="OpenVINO™ Toolkit Overview" url="@ref index"/>
|
|
<tab type="user" title="Linux" url="@ref openvino_docs_get_started_get_started_linux"/>
|
|
<tab type="user" title="Windows" url="@ref openvino_docs_get_started_get_started_windows"/>
|
|
<tab type="user" title="macOS" url="@ref openvino_docs_get_started_get_started_macos"/>
|
|
<tab type="user" title="Legal Information" url="@ref openvino_docs_Legal_Information"/>
|
|
</tab>
|
|
<!-- Configuration for Hardware -->
|
|
<tab type="usergroup" title="Configuration for Hardware" url=""><!--automatically generated-->
|
|
<tab type="usergroup" title="VPUs" url="@ref openvino_docs_install_guides_movidius_setup_guide">
|
|
<tab type="user" title="Configuration Guide for Intel® Vision Accelerator Design with Intel® Movidius™ VPUs on Linux" url="@ref openvino_docs_install_guides_installing_openvino_linux_ivad_vpu"/>
|
|
<tab type="user" title="Intel® Movidius™ VPUs Setup Guide" url="@ref openvino_docs_install_guides_movidius_setup_guide"/>
|
|
<tab type="user" title="Intel® Movidius™ VPUs Programming Guide" url="@ref openvino_docs_install_guides_movidius_programming_guide"/>
|
|
</tab>
|
|
<tab type="usergroup" title="[DEPRECATED] FPGAs" url="@ref openvino_docs_install_guides_VisionAcceleratorFPGA_Configure">
|
|
<tab type="user" title="[DEPRECATED] Configuration Guide for Intel® Vision Accelerator Design with an Intel® Arria 10 FPGA SG2 (IEIs Mustang-F100-A10) on Linux" url="@ref openvino_docs_install_guides_VisionAcceleratorFPGA_Configure"/>
|
|
<tab type="user" title="[DEPRECATED] Configuration Guide for Intel® Programmable Acceleration Card with Intel® Arria® 10 FPGA GX on CentOS or Ubuntu*" url="@ref openvino_docs_install_guides_PAC_Configure"/>
|
|
</tab>
|
|
</tab>
|
|
<!-- Security -->
|
|
<tab type="usergroup" title="Security" url="@ref openvino_docs_security_guide_introduction"><!--automatically generated-->
|
|
<tab type="user" title="Introduction" url="@ref openvino_docs_security_guide_introduction"/>
|
|
<tab type="user" title="Using DL Workbench Securely" url="@ref openvino_docs_security_guide_workbench"/>
|
|
<tab type="user" title="Using Encrypted Models" url="@ref openvino_docs_IE_DG_protecting_model_guide"/>
|
|
</tab>
|
|
</tab>
|
|
|
|
<!-- DOCUMENTATION category -->
|
|
<tab type="usergroup" title="DOCUMENTATION"><!--automatically generated-->
|
|
<!-- DLDT Documentation-->
|
|
<xi:include href="ie_docs.xml" xpointer="xpointer(//tab[@id='converting_and_preparing_models'])"/>
|
|
<xi:include href="ie_docs.xml" xpointer="xpointer(//tab[@id='intermediate_representaton_and_operations_sets'])"/>
|
|
<xi:include href="ie_docs.xml" xpointer="xpointer(//tab[@id='deploying_inference'])"/>
|
|
<!-- Workbench -->
|
|
<xi:include href="workbench_docs.xml" xpointer="xpointer(//tab[@id='deep_learning_workbench'])"/>
|
|
<!-- Optimization docs -->
|
|
<xi:include href="optimization_docs.xml" xpointer="xpointer(//tab[@id='tuning_for_performance'])"/>
|
|
<tab type="usergroup" title="Media Processing">
|
|
<!-- DL Streamer -->
|
|
<tab type="user" title="DL Streamer API Reference" url="https://openvinotoolkit.github.io/dlstreamer_gst/"/>
|
|
<!-- DL Streamer Examples -->
|
|
<tab type="usergroup" title="DL Streamer Examples" url="@ref gst_samples_README">
|
|
</tab>
|
|
<!-- OpenVX -->
|
|
<tab type="user" title="OpenVX Developer Guide" url="https://software.intel.com/en-us/openvino-ovx-guide"/>
|
|
<tab type="user" title="OpenVX API Reference" url="https://khronos.org/openvx"/>
|
|
<!-- OpenCV -->
|
|
<tab type="user" title="OpenCV* Developer Guide" url="https://docs.opencv.org/master/"/>
|
|
<!-- OpenCL -->
|
|
<tab type="user" title="OpenCL™ Developer Guide" url="https://software.intel.com/en-us/openclsdk-devguide"/>
|
|
</tab>
|
|
</tab>
|
|
|
|
<!-- RESOURCES category -->
|
|
<tab type="usergroup" title="RESOURCES">
|
|
<!-- Models and Demos Documentation-->
|
|
<xi:include href="omz_docs.xml" xpointer="xpointer(//tab[@id='trained_models'])"/>
|
|
<xi:include href="omz_docs.xml" xpointer="xpointer(//tab[@id='application_demos'])"/>
|
|
<!-- IE Code Samples -->
|
|
<tab type="usergroup" title="Inference Engine Code Samples" url="@ref openvino_docs_IE_DG_Samples_Overview">
|
|
<tab type="user" title="Image Classification C++ Sample Async" url="@ref openvino_inference_engine_samples_classification_sample_async_README"/>
|
|
<tab type="user" title="Image Classification Python* Sample Async" url="@ref openvino_inference_engine_ie_bridges_python_sample_classification_sample_async_README"/>
|
|
<tab type="user" title="Hello Classification C++ Sample" url="@ref openvino_inference_engine_samples_hello_classification_README"/>
|
|
<tab type="user" title="Hello Classification C Sample" url="@ref openvino_inference_engine_ie_bridges_c_samples_hello_classification_README"/>
|
|
<tab type="user" title="Image Classification Python* Sample" url="@ref openvino_inference_engine_ie_bridges_python_sample_classification_sample_README"/>
|
|
<tab type="user" title="Hello Reshape SSD C++ Sample" url="@ref openvino_inference_engine_samples_hello_reshape_ssd_README"/>
|
|
<tab type="user" title="Hello NV12 Input Classification C++ Sample" url="@ref openvino_inference_engine_samples_hello_nv12_input_classification_README"/>
|
|
<tab type="user" title="Hello NV12 Input Classification C Sample" url="@ref openvino_inference_engine_ie_bridges_c_samples_hello_nv12_input_classification_README"/>
|
|
<tab type="user" title="Hello Query Device C++ Sample" url="@ref openvino_inference_engine_samples_hello_query_device_README"/>
|
|
<tab type="user" title="Hello Query Device Python* Sample" url="@ref openvino_inference_engine_ie_bridges_python_sample_hello_query_device_README"/>
|
|
<tab type="user" title="nGraph Function C++ Sample" url="@ref openvino_inference_engine_samples_ngraph_function_creation_sample_README"/>
|
|
<tab type="user" title="Object Detection C++ Sample SSD" url="@ref openvino_inference_engine_samples_object_detection_sample_ssd_README"/>
|
|
<tab type="user" title="Object Detection Python* Sample SSD" url="@ref openvino_inference_engine_ie_bridges_python_sample_object_detection_sample_ssd_README"/>
|
|
<tab type="user" title="Object Detection C Sample SSD" url="@ref openvino_inference_engine_ie_bridges_c_samples_object_detection_sample_ssd_README"/>
|
|
<tab type="user" title="Automatic Speech Recognition C++ Sample" url="@ref openvino_inference_engine_samples_speech_sample_README"/>
|
|
<tab type="user" title="Neural Style Transfer C++ Sample" url="@ref openvino_inference_engine_samples_style_transfer_sample_README"/>
|
|
<tab type="user" title="Neural Style Transfer Python* Sample" url="@ref openvino_inference_engine_ie_bridges_python_sample_style_transfer_sample_README"/>
|
|
<tab type="user" title="Benchmark C++ App" url="@ref openvino_inference_engine_samples_benchmark_app_README"/>
|
|
<tab type="user" title="Benchmark Python* App" url="@ref openvino_inference_engine_tools_benchmark_tool_README"/>
|
|
</tab>
|
|
|
|
<!-- DL Streamer Examples -->
|
|
<tab type="usergroup" title="DL Streamer Examples" url="@ref gst_samples_README">
|
|
<tab type="usergroup" title="Command Line Samples" url="">
|
|
<tab type="user" title="Audio Detection Sample" url="@ref gst_samples_gst_launch_audio_detect_README"/>
|
|
<tab type="user" title="Face Detection And Classification Sample" url="@ref gst_samples_gst_launch_face_detection_and_classification_README"/>
|
|
<tab type="user" title="Vehicle and Pedestrian Tracking Sample" url="@ref gst_samples_gst_launch_vehicle_pedestrian_tracking_README"/>
|
|
<tab type="usergroup" title="Metadata Publishing Sample" url="@ref gst_samples_gst_launch_metapublish_README">
|
|
<tab type="user" title="MetaPublish Listeners" url="@ref gst_samples_gst_launch_metapublish_listener"/>
|
|
</tab>
|
|
<tab type="user" title="gvapython Sample" url="@ref gst_samples_gst_launch_gvapython_face_detection_and_classification_README"/>
|
|
</tab>
|
|
<tab type="user" title="Draw Face Attributes C++ Sample" url="@ref gst_samples_cpp_draw_face_attributes_README"/>
|
|
<tab type="user" title="Draw Face Attributes Python Sample" url="@ref gst_samples_python_draw_face_attributes_README"/>
|
|
<tab type="user" title="Benchmark Sample" url="@ref gst_samples_benchmark_README"/>
|
|
</tab>
|
|
</tab>
|
|
|
|
<!-- Chinese docs -->
|
|
<tab type="user" title="中文文件" url="https://docs.openvinotoolkit.org/cn/index.html"/>
|
|
</navindex>
|
|
|
|
<!-- Layout definition for a class page -->
|
|
<class>
|
|
<briefdescription visible="yes"/>
|
|
<includes visible="$SHOW_INCLUDE_FILES"/>
|
|
<inheritancegraph visible="$CLASS_GRAPH"/>
|
|
<collaborationgraph visible="$COLLABORATION_GRAPH"/>
|
|
<memberdecl>
|
|
<nestedclasses visible="yes" title=""/>
|
|
<publictypes title=""/>
|
|
<services title=""/>
|
|
<interfaces title=""/>
|
|
<publicslots title=""/>
|
|
<signals title=""/>
|
|
<publicmethods title=""/>
|
|
<publicstaticmethods title=""/>
|
|
<publicattributes title=""/>
|
|
<publicstaticattributes title=""/>
|
|
<protectedtypes title=""/>
|
|
<protectedslots title=""/>
|
|
<protectedmethods title=""/>
|
|
<protectedstaticmethods title=""/>
|
|
<protectedattributes title=""/>
|
|
<protectedstaticattributes title=""/>
|
|
<packagetypes title=""/>
|
|
<packagemethods title=""/>
|
|
<packagestaticmethods title=""/>
|
|
<packageattributes title=""/>
|
|
<packagestaticattributes title=""/>
|
|
<properties title=""/>
|
|
<events title=""/>
|
|
<privatetypes title=""/>
|
|
<privateslots title=""/>
|
|
<privatemethods title=""/>
|
|
<privatestaticmethods title=""/>
|
|
<privateattributes title=""/>
|
|
<privatestaticattributes title=""/>
|
|
<friends title=""/>
|
|
<related title="" subtitle=""/>
|
|
<membergroups visible="yes"/>
|
|
</memberdecl>
|
|
<detaileddescription title=""/>
|
|
<memberdef>
|
|
<inlineclasses title=""/>
|
|
<typedefs title=""/>
|
|
<enums title=""/>
|
|
<services title=""/>
|
|
<interfaces title=""/>
|
|
<constructors title=""/>
|
|
<functions title=""/>
|
|
<related title=""/>
|
|
<variables title=""/>
|
|
<properties title=""/>
|
|
<events title=""/>
|
|
</memberdef>
|
|
<allmemberslink visible="yes"/>
|
|
<usedfiles visible="$SHOW_USED_FILES"/>
|
|
<authorsection visible="yes"/>
|
|
</class>
|
|
<!-- Layout definition for a namespace page -->
|
|
<namespace>
|
|
<briefdescription visible="yes"/>
|
|
<memberdecl>
|
|
<nestednamespaces visible="yes" title=""/>
|
|
<constantgroups visible="yes" title=""/>
|
|
<classes visible="yes" title=""/>
|
|
<typedefs title=""/>
|
|
<enums title=""/>
|
|
<functions title=""/>
|
|
<variables title=""/>
|
|
<membergroups visible="yes"/>
|
|
</memberdecl>
|
|
<detaileddescription title=""/>
|
|
<memberdef>
|
|
<inlineclasses title=""/>
|
|
<typedefs title=""/>
|
|
<enums title=""/>
|
|
<functions title=""/>
|
|
<variables title=""/>
|
|
</memberdef>
|
|
<authorsection visible="yes"/>
|
|
</namespace>
|
|
<!-- Layout definition for a file page -->
|
|
<file>
|
|
<briefdescription visible="yes"/>
|
|
<includes visible="$SHOW_INCLUDE_FILES"/>
|
|
<includegraph visible="$INCLUDE_GRAPH"/>
|
|
<includedbygraph visible="$INCLUDED_BY_GRAPH"/>
|
|
<sourcelink visible="yes"/>
|
|
<memberdecl>
|
|
<classes visible="yes" title=""/>
|
|
<namespaces visible="yes" title=""/>
|
|
<constantgroups visible="yes" title=""/>
|
|
<defines title=""/>
|
|
<typedefs title=""/>
|
|
<enums title=""/>
|
|
<functions title=""/>
|
|
<variables title=""/>
|
|
<membergroups visible="yes"/>
|
|
</memberdecl>
|
|
<detaileddescription title=""/>
|
|
<memberdef>
|
|
<inlineclasses title=""/>
|
|
<defines title=""/>
|
|
<typedefs title=""/>
|
|
<enums title=""/>
|
|
<functions title=""/>
|
|
<variables title=""/>
|
|
</memberdef>
|
|
<authorsection/>
|
|
</file>
|
|
<!-- Layout definition for a group page -->
|
|
<group>
|
|
<briefdescription visible="yes"/>
|
|
<groupgraph visible="$GROUP_GRAPHS"/>
|
|
<memberdecl>
|
|
<nestedgroups visible="yes" title=""/>
|
|
<dirs visible="yes" title=""/>
|
|
<files visible="yes" title=""/>
|
|
<namespaces visible="yes" title=""/>
|
|
<classes visible="yes" title=""/>
|
|
<defines title=""/>
|
|
<typedefs title=""/>
|
|
<enums title=""/>
|
|
<enumvalues title=""/>
|
|
<functions title=""/>
|
|
<variables title=""/>
|
|
<signals title=""/>
|
|
<publicslots title=""/>
|
|
<protectedslots title=""/>
|
|
<privateslots title=""/>
|
|
<events title=""/>
|
|
<properties title=""/>
|
|
<friends title=""/>
|
|
<membergroups visible="yes"/>
|
|
</memberdecl>
|
|
<detaileddescription title=""/>
|
|
<memberdef>
|
|
<pagedocs/>
|
|
<inlineclasses title=""/>
|
|
<defines title=""/>
|
|
<typedefs title=""/>
|
|
<enums title=""/>
|
|
<enumvalues title=""/>
|
|
<functions title=""/>
|
|
<variables title=""/>
|
|
<signals title=""/>
|
|
<publicslots title=""/>
|
|
<protectedslots title=""/>
|
|
<privateslots title=""/>
|
|
<events title=""/>
|
|
<properties title=""/>
|
|
<friends title=""/>
|
|
</memberdef>
|
|
<authorsection visible="yes"/>
|
|
</group>
|
|
<!-- Layout definition for a directory page -->
|
|
<directory>
|
|
<briefdescription visible="yes"/>
|
|
<directorygraph visible="yes"/>
|
|
<memberdecl>
|
|
<dirs visible="yes"/>
|
|
<files visible="yes"/>
|
|
</memberdecl>
|
|
<detaileddescription title=""/>
|
|
</directory>
|
|
</doxygenlayout>
|