Expose HAL low levels to Python and factor out a DeviceArray. (#8206)

* Expose the HAL Allocator and Buffer directly in the Python API.
* Supports explicit management of device memory and transfers.
* Reworks function dispatch to be based on this.
* Allows raw BufferViews to be passed into functions (vs an array) for expert control if needed.
* Exposes allocator statistics to python.
* Add a real DeviceArray class, implementing the numpy array and ufunc protocols.
* Rewire the VM layer to always work on BufferView and the Python layer to coerce in/out of DeviceArray.
  * This eliminates the implicit map to host memory that was happening on function return. Instead this will be done only if accesses are done to the DeviceArray that need it on the host.
* Generalize array input handling: DeviceArrays are not transferred back to the host to be passed to the next function and other framework __array__ implementations are coerced.
* Add iree.runtime.asdevicearray (casing matches numpy) as a quick shortcut for getting a device array when you aren't *that* concerned about the details.
* Support deepcopy/pickle (the TF tests use this).
* Implement DeviceArray.astype (needed for two tflite tests).
15 files changed
tree: 39d91b278f94bb4613002a0fbc3a907c79a3cbbc
  1. .github/
  2. benchmarks/
  3. bindings/
  4. build_tools/
  5. colab/
  6. docs/
  7. experimental/
  8. integrations/
  9. iree/
  10. llvm-external-projects/
  11. scripts/
  12. third_party/
  13. .bazelignore
  14. .bazelrc
  15. .bazelversion
  16. .clang-format
  17. .gitignore
  18. .gitmodules
  19. .pylintrc
  20. .style.yapf
  21. .yamllint.yml
  22. AUTHORS
  23. BUILD.bazel
  24. CMakeLists.txt
  25. configure_bazel.py
  26. CONTRIBUTING.md
  27. LICENSE
  28. README.md
  29. WORKSPACE
README.md

IREE: Intermediate Representation Execution Environment

IREE (Intermediate Representation Execution Environment, pronounced as “eerie”) is an MLIR-based end-to-end compiler and runtime that lowers Machine Learning (ML) models to a unified IR that scales up to meet the needs of the datacenter and down to satisfy the constraints and special considerations of mobile and edge deployments.

See our website for project details, user guides, and instructions on building from source.

Project Status

IREE is still in its early phase. We have settled down on the overarching infrastructure and are actively improving various software components as well as project logistics. It is still quite far from ready for everyday use and is made available without any support at the moment. With that said, we welcome any kind of feedback on any communication channels!

Communication Channels

Related Project Channels

  • MLIR topic within LLVM Discourse: IREE is enabled by and heavily relies on MLIR. IREE sometimes is referred to in certain MLIR discussions. Useful if you are also interested in MLIR evolution.

Build Status

CI SystemBuild SystemPlatformArchitectureConfiguration / ComponentStatus
KokoroBazelLinuxx86-64kokoro status bazel/linux/x86-swiftshader/core
KokoroCMake & BazelLinuxx86-64 (swiftshader)Integrationskokoro status cmake-bazel/linux/x86-swiftshader
KokoroCMake & BazelLinuxx86-64 (turing)Integrationskokoro status cmake-bazel/linux/x86-turing
KokoroCMakeLinuxx86-64 (swiftshader)kokoro status cmake/linux/x86-swiftshader
KokoroCMakeLinuxx86-64 (swiftshader)asankokoro status cmake/linux/x86-swiftshader-asan
KokoroCMakeLinuxx86-64 (turing)kokoro status cmake/linux/x86-turing
KokoroCMakeAndroidarm64-v8aRuntime (build only)kokoro status cmake/android/arm64-v8a
KokoroCMakeBare Metalrisc-v-32Runtimekokoro status cmake/baremetal/riscv32
KokoroCMakeLinuxrisc-v-64Runtimekokoro status cmake/linux/riscv64
BuildkiteCMakeAndroidarm64-v8aRuntimebuildkite status iree-android-arm64-v8a
BuildKiteCMakeAndroidarm64-v8aRuntime Benchmarksbuildkite status iree-benchmark
BuildKiteCMakeLinuxx86-64Tracing + Standalone Runtimebuildkite status iree-build-configurations

Architecture Overview

IREE Architecture

See our website for more information.

Presentations and Talks

  • 2021-06-09: IREE Runtime Design Tech Talk (recording and slides)
  • 2020-08-20: IREE CodeGen: MLIR Open Design Meeting Presentation (recording and slides)
  • 2020-03-18: Interactive HAL IR Walkthrough (recording)
  • 2020-01-31: End-to-end MLIR Workflow in IREE: MLIR Open Design Meeting Presentation (recording and slides)

License

IREE is licensed under the terms of the Apache 2.0 License with LLVM Exceptions. See LICENSE for more information.