IntenseWebs/openvino
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Feature/azaytsev/cldnn doc fixes (#4593)

Browse Source 
* Legal fixes, removed the Generating docs section
* Removed info regarding generating docs
This commit is contained in:
Andrey Zaytsev 2021-03-03 20:52:10 +03:00 committed by GitHub
parent 8481e36e8a
commit 409cebc8e4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
inference-engine/thirdparty/clDNN/README.md vendored
View File

@ -21,7 +21,7 @@ clDNN uses 3<sup>rd</sup>-party components licensed under following licenses:
- *RapidJSON* under [Tencent\* License](https://github.com/Tencent/rapidjson/blob/master/license.txt) - *RapidJSON* under [Tencent\* License](https://github.com/Tencent/rapidjson/blob/master/license.txt)
## Documentation ## Documentation
There is inline documentation available that can be [generated with Doxygen](#generating-documentation). There is inline documentation available that can be generated with Doxygen.
Accelerate Deep Learning Inference with Intel® Processor Graphics whitepaper [link](https://software.intel.com/en-us/articles/accelerating-deep-learning-inference-with-intel-processor-graphics). Accelerate Deep Learning Inference with Intel® Processor Graphics whitepaper [link](https://software.intel.com/en-us/articles/accelerating-deep-learning-inference-with-intel-processor-graphics).
@ -45,7 +45,7 @@ request will be merged into our GitHub repository.
## System Requirements ## System Requirements
clDNN supports Intel® HD Graphics and Intel® Iris® Graphics and is optimized for Gen9-Gen12LP architectures clDNN supports Intel® HD Graphics and Intel® Iris® Graphics and is optimized for Gen9-Gen12LP architectures
clDNN currently uses OpenCL™ with multiple Intel® OpenCL™ extensions and requires Intel® Graphics Driver to run. clDNN currently uses OpenCL™ with multiple Intel OpenCL™ extensions and requires Intel® Graphics Driver to run.
clDNN requires CPU with Intel® SSE/Intel® AVX support. clDNN requires CPU with Intel® SSE/Intel® AVX support.
@ -62,32 +62,20 @@ The software dependencies are:
> Intel® CPU intrinsics header (`<immintrin.h>`) must be available during compilation. > Intel® CPU intrinsics header (`<immintrin.h>`) must be available during compilation.
- [python™](https://www.python.org/downloads/) 2.7 or later (scripts are both compatible with python™ 2.7.x and python™ 3.x) - [python™](https://www.python.org/downloads/) 2.7 or later (scripts are both compatible with python™ 2.7.x and python™ 3.x)
- *(optional)* [Doxygen\*](http://www.stack.nl/~dimitri/doxygen/download.html) 1.8.13 or later
Needed for manual generation of documentation from inline comments or running `docs` custom target which will generate it automatically.
> [GraphViz\*](http://www.graphviz.org/Download..php) (2.38 or later) is also recommended to generate documentation with all embedded diagrams. # Trademark Information
(Make sure that `dot` application is visible in the `PATH` environment variable.)
### Generating documentation
Documentation is provided inline and can be generated in HTML format with Doxygen. We recommend to use latest
[Doxygen\*](http://www.stack.nl/~dimitri/doxygen/download.html) and [GraphViz\*](http://www.graphviz.org/Download..php).
Documentation templates and configuration files are stored in `docs` subdirectory. You can simply call:
```shellscript
cd docs && doxygen
```
to generate HTML documentation in `docs/html` subdirectory.
There is also custom CMake target named `docs` which will generate documentation in `CLDNN__OUTPUT_BIN_DIR/html` directory. For example, when using Unix makefiles, you can run:
```
make docs
```
in order to create it.
Intel, the Intel logo, Intel Atom, Intel Core, Intel Xeon Phi, Iris, OpenVINO,
the OpenVINO logo, Pentium, VTune, and Xeon are trademarks
of Intel Corporation or its subsidiaries.
\* Other names and brands may be claimed as the property of others. \* Other names and brands may be claimed as the property of others.
Copyright © 2020, Intel® Corporation Microsoft, Windows, and the Windows logo are trademarks, or registered
trademarks of Microsoft Corporation in the United States and/or other
countries.
OpenCL and the OpenCL logo are trademarks of Apple Inc. used by permission
by Khronos.
Copyright © 2021, Intel Corporation