openvino/inference-engine/thirdparty/clDNN

Compute Library for Deep Neural Networks (clDNN)

Compute Library for Deep Neural Networks (clDNN) is an open source performance library for Deep Learning (DL) applications intended for acceleration of DL Inference on Intel® Processor Graphics – including HD Graphics and Iris® Graphics. clDNN includes highly optimized building blocks for implementation of convolutional neural networks (CNN) with C++ interface.

License

clDNN is licensed is licensed under Apache License Version 2.0.

Attached licenses

clDNN uses 3^rd-party components licensed under following licenses:

• googletest under Google* License
• OpenCL™ ICD and C++ Wrapper under Khronos™ License
• RapidJSON under Tencent* License

Documentation

There is inline documentation available that can be generated with Doxygen.

Accelerate Deep Learning Inference with Intel® Processor Graphics whitepaper link.

Support

Please report issues and suggestions GitHub issues.

How to Contribute

We welcome community contributions to clDNN. If you have an idea how to improve the library:

• Share your proposal via GitHub issues
• Ensure you can build the product and run all the examples with your patch
• In the case of a larger feature, create a test
• Submit a pull request

We will review your contribution and, if any additional fixes or modifications are necessary, may provide feedback to guide you. When accepted, your pull request will be merged into our GitHub repository.

System Requirements

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 requires CPU with Intel® SSE/Intel® AVX support.

---

The software dependencies are:

• CMake* 3.5 or later
• C++ compiler with C++11 standard support compatible with:
  • GNU* Compiler Collection 4.8 or later
  • clang 3.5 or later
  • Intel® C++ Compiler 17.0 or later
  • Visual C++ 2015 (MSVC++ 19.0) or later

Intel® CPU intrinsics header (<immintrin.h>) must be available during compilation.

• python™ 2.7 or later (scripts are both compatible with python™ 2.7.x and python™ 3.x)
• (optional) Doxygen* 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* (2.38 or later) is also recommended to generate documentation with all embedded diagrams. (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* and GraphViz*.

Documentation templates and configuration files are stored in docs subdirectory. You can simply call:

    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.

* Other names and brands may be claimed as the property of others.

Copyright © 2020, Intel® Corporation