Merge pull request #278 from asuhov/2019-r3
[platform/upstream/dldt.git] / README.md
1 # [OpenVINO™ Toolkit](https://01.org/openvinotoolkit) - Deep Learning Deployment Toolkit repository
2 [![Stable release](https://img.shields.io/badge/version-2019.R3-green.svg)](https://github.com/opencv/dldt/releases/tag/2019_R3)
3 [![Apache License Version 2.0](https://img.shields.io/badge/license-Apache_2.0-green.svg)](LICENSE)
4
5 This toolkit allows developers to deploy pre-trained deep learning models through a high-level C++ Inference Engine API integrated with application logic. 
6
7 This open source version includes two components, namely Model Optimizer and Inference Engine, as well as CPU, GPU and heterogeneous plugins to accelerate deep learning inferencing on Intel(R) CPUs and Intel(R) Processor Graphics. It supports pre-trained models from the [Open Model Zoo](https://github.com/opencv/open_model_zoo/) along with 100+ open source and public models in popular formats such as Caffe*, Tensorflow*, MXNet* and ONNX*. 
8
9 ## Repository components:
10 * [Inference Engine](https://software.intel.com/en-us/articles/OpenVINO-InferEngine)
11 * [Model Optimizer](https://software.intel.com/en-us/articles/OpenVINO-ModelOptimizer)
12
13 ## License
14 Deep Learning Deployment Toolkit is licensed under [Apache License Version 2.0](LICENSE).
15
16 ## Documentation
17 * [OpenVINO™ Release Notes](https://software.intel.com/en-us/articles/OpenVINO-RelNotes)
18 * [Inference Engine build instructions](inference-engine/README.md)
19 * [Get Started with Deep Learning Deployment Toolkit on Linux*](get-started-linux.md)
20 * [Introduction to Deep Learning Deployment Toolkit](https://docs.openvinotoolkit.org/latest/_docs_IE_DG_Introduction.html)
21 * [Inference Engine Developer Guide](https://docs.openvinotoolkit.org/latest/_docs_IE_DG_Deep_Learning_Inference_Engine_DevGuide.html)
22 * [Model Optimizer Developer Guide](https://docs.openvinotoolkit.org/latest/_docs_MO_DG_Deep_Learning_Model_Optimizer_DevGuide.html)
23
24
25 ## How to Contribute
26 We welcome community contributions to the Deep Learning Deployment Toolkit repository. If you have an idea how to improve the product, please share it with us doing the following steps:
27 * Make sure you can build the product and run all tests and samples with your patch
28 * In case of a larger feature, provide a relevant unit tests and sample
29 * Submit a pull request at https://github.com/opencv/dldt/pulls
30
31 We will review your contribution and, if any additional fixes or modifications are necessary, may give some feedback to guide you. When accepted, your pull request will be merged into GitHub* repositories.
32
33 Deep Learning Deployment Toolkit is licensed under Apache License, Version 2.0. By contributing to the project, you agree to the license and copyright terms therein and release your contribution under these terms.
34
35 ## Support
36 Please report questions, issues and suggestions using:
37 * [\#openvino](https://stackoverflow.com/search?q=%23openvino) tag on StackOverflow*
38 * [GitHub* Issues](https://github.com/opencv/dldt/issues) 
39 * [Forum](https://software.intel.com/en-us/forums/computer-vision)
40
41 ---
42 \* Other names and brands may be claimed as the property of others.