test-mass-forker-org-1 / tensorflow-directml-plugin

DirectML PluggableDevice plugin for TensorFlow 2

TensorFlow-DirectML-Plugin

TensorFlow is an end-to-end open source platform for machine learning. This repository is an implementation of TensorFlow's Pluggable Device API that leverages DirectML to provide cross-vendor hardware acceleration on Windows 10 and the Windows Subsystem for Linux (WSL). TensorFlow with DirectML enables training and inference of complex machine learning models on a wide range of DirectX 12-compatible hardware.

Questions, Issues, and Feedback

• Frequently asked questions: FAQ
• Ask a question: Discussions
• Report a bug: Issues

You can also contact us directly at [email protected].

Getting Started

TensorFlow DirectML Plugin is in early development and is not supported for production yet. For production scenarios, use TensorFlow 1.15 with DirectML instead.

The following resources provide additional background on DirectML and TensorFlow:

• DirectML GitHub
• RFC: TensorFlow on DirectML
• TensorFlow homepage

System Requirements

Windows 10

• Windows 10 Version 1709, 64-bit (Build 16299 or higher)
• Python x86-64 3.7, 3.8, 3.9 or 3.10¹
• One of the following supported GPUs:
  • AMD Radeon R5/R7/R9 2xx series or newer
  • Intel HD Graphics 5xx or newer
  • NVIDIA GeForce GTX 9xx series GPU or newer

Windows Subsystem for Linux

• Windows 10 Insider Preview, 64-bit (Build 20150 or higher)
• Python x86-64 3.7, 3.8, 3.9 or 3.10²
• One of the following supported GPUs:
  • AMD Radeon R5/R7/R9 2xx series or newer, and 20.20.01.05 WSL driver
  • Intel HD Graphics 6xx or newer, and 28.20.100.8322 WSL driver
  • NVIDIA GeForce GTX 9xx series GPU or newer, and 460.20 WSL driver

Contribute

If you would like to contribute to tensorflow-directml-plugin, please see our contribution guidelines and read the Microsoft Open Source Code of Conduct. We use GitHub issues for tracking requests and bugs. Please do not report security vulnerabilities through public GitHub issues. See SECURITY.md for more details.

See BUILD.md for instructions on how to produce private builds of tensorflow-directml-plugin.

Known Issues

• If you are using the plugin on WSL with an NVIDIA RTX 2060 or 2070 GPU, versions of WSL prior to 0.60.0 will encounter a segmentation fault upon process exit in certain preview builds of Windows 11. If you encounter this issue, please upgrade to the latest version of WSL (>= 0.60.0).

License

This project is licensed under MIT License.

Some files and code snippets originate from the TensorFlow repository and are licensed under the Apache License 2.0.

The tensorflow-directml-plugin Python wheel binary package includes a redistributable version of the DirectML library, which is downloaded automatically as a part of the build. The use of the redistributable DirectML library is governed by a separate license that is found as part of the package (found in tensorflow-plugins/directml/DirectML_LICENSE.txt when extracted).

Data Collection Notice

The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft's privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.

Disabling Telemetry

The official builds of tensorflow-directml-plugin (hosted on PyPI) have data collection enabled. This telemetry is enabled when building with --config=dml_telemetry (i.e. the --telemetry switch in build.py), but it is disabled by default for local builds.

Trademarks Notice

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

TensorFlow, the TensorFlow logo and any related marks are trademarks of Google Inc.