* Added info on DockerHub CI Framework
* Feature/azaytsev/change layout (#3295)
* Changes according to feedback comments
* Replaced @ref's with html links
* Fixed links, added a title page for installing from repos and images, fixed formatting issues
* Added links
* minor fix
* Added DL Streamer to the list of components installed by default
* Link fixes
* Link fixes
* ovms doc fix (#2988)
* added OpenVINO Model Server
* ovms doc fixes
Co-authored-by: Trawinski, Dariusz <dariusz.trawinski@intel.com>
* Updated openvino_docs.xml
* Updated the link to software license agreements
* Revert "Updated the link to software license agreements"
This reverts commit 706dac500e.
* Docs to Sphinx (#8151)
* docs to sphinx
* Update GPU.md
* Update CPU.md
* Update AUTO.md
* Update performance_int8_vs_fp32.md
* update
* update md
* updates
* disable doc ci
* disable ci
* fix index.rst
Co-authored-by: Andrey Zaytsev <andrey.zaytsev@intel.com>
# Conflicts:
# .gitignore
# docs/CMakeLists.txt
# docs/IE_DG/Deep_Learning_Inference_Engine_DevGuide.md
# docs/IE_DG/Extensibility_DG/Custom_ONNX_Ops.md
# docs/IE_DG/Extensibility_DG/VPU_Kernel.md
# docs/IE_DG/InferenceEngine_QueryAPI.md
# docs/IE_DG/Int8Inference.md
# docs/IE_DG/Integrate_with_customer_application_new_API.md
# docs/IE_DG/Model_caching_overview.md
# docs/IE_DG/supported_plugins/GPU_RemoteBlob_API.md
# docs/IE_DG/supported_plugins/HETERO.md
# docs/IE_DG/supported_plugins/MULTI.md
# docs/MO_DG/prepare_model/convert_model/Convert_Model_From_Caffe.md
# docs/MO_DG/prepare_model/convert_model/Convert_Model_From_Kaldi.md
# docs/MO_DG/prepare_model/convert_model/Convert_Model_From_MxNet.md
# docs/MO_DG/prepare_model/convert_model/Convert_Model_From_ONNX.md
# docs/MO_DG/prepare_model/convert_model/Converting_Model.md
# docs/MO_DG/prepare_model/convert_model/Converting_Model_General.md
# docs/MO_DG/prepare_model/convert_model/Cutting_Model.md
# docs/MO_DG/prepare_model/convert_model/pytorch_specific/Convert_RNNT.md
# docs/MO_DG/prepare_model/convert_model/tf_specific/Convert_EfficientDet_Models.md
# docs/MO_DG/prepare_model/convert_model/tf_specific/Convert_WideAndDeep_Family_Models.md
# docs/MO_DG/prepare_model/convert_model/tf_specific/Convert_YOLO_From_Tensorflow.md
# docs/doxygen/Doxyfile.config
# docs/doxygen/ie_docs.xml
# docs/doxygen/ie_plugin_api.config
# docs/doxygen/ngraph_cpp_api.config
# docs/doxygen/openvino_docs.xml
# docs/get_started/get_started_macos.md
# docs/get_started/get_started_raspbian.md
# docs/get_started/get_started_windows.md
# docs/img/cpu_int8_flow.png
# docs/index.md
# docs/install_guides/VisionAcceleratorFPGA_Configure.md
# docs/install_guides/VisionAcceleratorFPGA_Configure_Windows.md
# docs/install_guides/deployment-manager-tool.md
# docs/install_guides/installing-openvino-linux.md
# docs/install_guides/installing-openvino-macos.md
# docs/install_guides/installing-openvino-windows.md
# docs/optimization_guide/dldt_optimization_guide.md
# inference-engine/ie_bridges/c/include/c_api/ie_c_api.h
# inference-engine/ie_bridges/python/docs/api_overview.md
# inference-engine/ie_bridges/python/sample/ngraph_function_creation_sample/README.md
# inference-engine/ie_bridges/python/sample/speech_sample/README.md
# inference-engine/ie_bridges/python/src/openvino/inference_engine/ie_api.pyx
# inference-engine/include/ie_api.h
# inference-engine/include/ie_core.hpp
# inference-engine/include/ie_version.hpp
# inference-engine/samples/benchmark_app/README.md
# inference-engine/samples/speech_sample/README.md
# inference-engine/src/plugin_api/exec_graph_info.hpp
# inference-engine/src/plugin_api/file_utils.h
# inference-engine/src/transformations/include/transformations_visibility.hpp
# inference-engine/tools/benchmark_tool/README.md
# ngraph/core/include/ngraph/ngraph.hpp
# ngraph/frontend/onnx_common/include/onnx_common/parser.hpp
# ngraph/python/src/ngraph/utils/node_factory.py
# openvino/itt/include/openvino/itt.hpp
# thirdparty/ade
# tools/benchmark/README.md
* Cherry-picked remove font-family (#8211)
* Cherry-picked: Update get_started_scripts.md (#8338)
* doc updates (#8268)
* Various doc changes
* theme changes
* remove font-family (#8211)
* fix css
* Update uninstalling-openvino.md
* fix css
* fix
* Fixes for Installation Guides
Co-authored-by: Andrey Zaytsev <andrey.zaytsev@intel.com>
Co-authored-by: kblaszczak-intel <karol.blaszczak@intel.com>
# Conflicts:
# docs/IE_DG/Bfloat16Inference.md
# docs/IE_DG/InferenceEngine_QueryAPI.md
# docs/IE_DG/OnnxImporterTutorial.md
# docs/IE_DG/supported_plugins/AUTO.md
# docs/IE_DG/supported_plugins/HETERO.md
# docs/IE_DG/supported_plugins/MULTI.md
# docs/MO_DG/prepare_model/convert_model/Convert_Model_From_Kaldi.md
# docs/MO_DG/prepare_model/convert_model/tf_specific/Convert_YOLO_From_Tensorflow.md
# docs/install_guides/installing-openvino-macos.md
# docs/install_guides/installing-openvino-windows.md
# docs/ops/opset.md
# inference-engine/samples/benchmark_app/README.md
# inference-engine/tools/benchmark_tool/README.md
# thirdparty/ade
* Cherry-picked: doc script changes (#8568)
* fix openvino-sphinx-theme
* add linkcheck target
* fix
* change version
* add doxygen-xfail.txt
* fix
* AA
* fix
* fix
* fix
* fix
* fix
# Conflicts:
# thirdparty/ade
* Cherry-pick: Feature/azaytsev/doc updates gna 2021 4 2 (#8567)
* Various doc changes
* Reformatted C++/Pythob sections. Updated with info from PR8490
* additional fix
* Gemini Lake replaced with Elkhart Lake
* Fixed links in IGs, Added 12th Gen
# Conflicts:
# docs/IE_DG/supported_plugins/GNA.md
# thirdparty/ade
* Cherry-pick: Feature/azaytsev/doc fixes (#8897)
* Various doc changes
* Removed the empty Learning path topic
* Restored the Gemini Lake CPIU list
# Conflicts:
# docs/IE_DG/supported_plugins/GNA.md
# thirdparty/ade
* Cherry-pick: sphinx copybutton doxyrest code blocks (#8992)
# Conflicts:
# thirdparty/ade
* Cherry-pick: iframe video enable fullscreen (#9041)
# Conflicts:
# thirdparty/ade
* Cherry-pick: fix untitled titles (#9213)
# Conflicts:
# thirdparty/ade
* Cherry-pick: perf bench graph animation (#9045)
* animation
* fix
# Conflicts:
# thirdparty/ade
* Cherry-pick: doc pytest (#8888)
* docs pytest
* fixes
# Conflicts:
# docs/doxygen/doxygen-ignore.txt
# docs/scripts/ie_docs.xml
# thirdparty/ade
* Cherry-pick: restore deleted files (#9215)
* Added new operations to the doc structure (from removed ie_docs.xml)
* Additional fixes
* Update docs/IE_DG/InferenceEngine_QueryAPI.md
Co-authored-by: Helena Kloosterman <helena.kloosterman@intel.com>
* Update docs/IE_DG/Int8Inference.md
Co-authored-by: Helena Kloosterman <helena.kloosterman@intel.com>
* Update Custom_Layers_Guide.md
* Changes according to review comments
* doc scripts fixes
* Update docs/IE_DG/Int8Inference.md
Co-authored-by: Helena Kloosterman <helena.kloosterman@intel.com>
* Update Int8Inference.md
* update xfail
* clang format
* updated xfail
Co-authored-by: Trawinski, Dariusz <dariusz.trawinski@intel.com>
Co-authored-by: Nikolay Tyukaev <nikolay.tyukaev@intel.com>
Co-authored-by: kblaszczak-intel <karol.blaszczak@intel.com>
Co-authored-by: Yury Gorbachev <yury.gorbachev@intel.com>
Co-authored-by: Helena Kloosterman <helena.kloosterman@intel.com>
104 lines
4.2 KiB
ReStructuredText
104 lines
4.2 KiB
ReStructuredText
.. OpenVINO Toolkit documentation master file, created by
|
|
sphinx-quickstart on Wed Jul 7 10:46:56 2021.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
.. meta::
|
|
:google-site-verification: _YqumYQ98cmXUTwtzM_0WIIadtDc6r_TMYGbmGgNvrk
|
|
|
|
OpenVINO™ Documentation
|
|
=======================
|
|
|
|
.. raw:: html
|
|
|
|
<div class="section" id="welcome-to-openvino-toolkit-s-documentation">
|
|
|
|
<link rel="stylesheet" type="text/css" href="_static/css/homepage_style.css">
|
|
<div style="clear:both;"> </div>
|
|
|
|
<p>
|
|
OpenVINO™ is an open-source toolkit for optimizing and deploying AI inference.
|
|
<ul>
|
|
<li>Boost deep learning performance in computer vision, automatic speech recognition, natural language processing and other common tasks </li>
|
|
<li>Use models trained with popular frameworks like TensorFlow, PyTorch and more </li>
|
|
<li>Reduce resource demands and efficiently deploy on a range of Intel® platforms from edge to cloud </li>
|
|
</ul>
|
|
</p>
|
|
|
|
<img class="HP_img_chart" src="_static/images/ov_chart.png"
|
|
alt="OpenVINO allows to process models built with Caffe, Keras, mxnet, TensorFlow, ONNX, and PyTorch. They can be easily optimized and deployed on devices running Windows, Linux, or MacOS." />
|
|
<div style="clear:both;"> </div>
|
|
<p>Check the full range of supported hardware in the
|
|
<a href="openvino_docs_IE_DG_supported_plugins_Supported_Devices.html"> Supported Devices page</a> and see how it stacks up in our
|
|
<a href="openvino_docs_performance_benchmarks.html"> Performance Benchmarks page.</a> <br />
|
|
Supports deployment on Windows, Linux, and macOS.
|
|
</p>
|
|
<div class="HP_separator-header">
|
|
<p> Train, Optimize, Deploy </p>
|
|
</div>
|
|
<div style="clear:both;"> </div>
|
|
<img class="HP_img_chart" src="_static/images/HP_ov_flow.svg" alt="" />
|
|
<p>* The ONNX format is also supported, but conversion to OpenVINO is recommended for better performance.</p>
|
|
<div style="clear:both;"> </div>
|
|
|
|
<div style="clear:both;"> </div>
|
|
<div class="HP_separator-header">
|
|
<p> Want to know more? </p>
|
|
</div>
|
|
<div style="clear:both;"> </div>
|
|
|
|
<div class="HP_infoboxes">
|
|
<a href="get_started.html">
|
|
<h3>Get Started </H3>
|
|
<p> Learn how to download, install, and configure OpenVINO. </p>
|
|
</a>
|
|
<a href="model_zoo.html" >
|
|
<h3>Open Model Zoo </h3>
|
|
<p> Browse through over 200 publicly available neural networks and pick the right one for your solution. </p>
|
|
</a>
|
|
<a href="openvino_docs_MO_DG_Deep_Learning_Model_Optimizer_DevGuide.html" >
|
|
<h3>Model Optimizer </h3>
|
|
<p> Learn how to convert your model and optimize it for use with OpenVINO. </p>
|
|
</a>
|
|
<a href="tutorials.html" >
|
|
<h3>Tutorials </h3>
|
|
<p> Learn how to use OpenVINO based on our training material. </p>
|
|
</a>
|
|
<a href="openvino_docs_IE_DG_Samples_Overview.html" >
|
|
<h3>Samples </h3>
|
|
<p> Try OpenVINO using ready-made applications explaining various use cases. </p>
|
|
</a>
|
|
<a href="workbench_docs_Workbench_DG_Introduction.html" >
|
|
<h3>DL Workbench </h3>
|
|
<p> Learn about the alternative, web-based version of OpenVINO. DL Workbench container installation Required. </p>
|
|
</a>
|
|
<a href="openvino_docs_IE_DG_Deep_Learning_Inference_Engine_DevGuide.html" >
|
|
<h3>Inference Engine </h3>
|
|
<p> Learn about OpenVINO's inference mechanism which executes the IR and ONNX models on target devices. </p>
|
|
</a>
|
|
<a href="openvino_docs_optimization_guide_dldt_optimization_guide.html" >
|
|
<h3>Tune & Optimize </h3>
|
|
<p> Use quantization, pruning, and sparsity algorithms to make your application as efficient as possible. </p>
|
|
</a>
|
|
<a href="openvino_docs_performance_benchmarks.html" >
|
|
<h3>Performance<br /> Benchmarks </h3>
|
|
<p> View performance benchmark results for various models on Intel platforms. </p>
|
|
</a>
|
|
</div>
|
|
<div style="clear:both;"> </div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:hidden:
|
|
|
|
get_started
|
|
documentation
|
|
tutorials
|
|
api/api_reference
|
|
model_zoo
|
|
resources
|