Google Git
Sign in
opensecura / 3p / openxla / iree / 217904d28d5628f3a67d402bb2d1c4b1e0b53387
commit217904d28d5628f3a67d402bb2d1c4b1e0b53387[log] [tgz]
authorScott Todd <scotttodd@google.com>Thu Jun 04 13:38:32 2020 -0700
committerCopybara-Service <copybara-worker@google.com>Thu Jun 04 13:40:27 2020 -0700
treeba3b721939714034c58034dca820b9ff06de58a4
parent962b5bb6745fd182901b38c3c3f331c919cd88fb [diff]
Start on "dylib" HAL backend for running code from dynamic libraries.

The plan here is to use this for LLVM ahead-of-time (AOT) execution: a new compiler target will generate modules targeting this HAL backend that will contain ahead-of-time compiled platform/architecture-specific dynamic libraries (.so/.dll/.dylib).

This is modeled after iree/hal/llvmjit, but is intended to be generic and should not directly reference LLVM code or concepts. Existing restrictions on dynamic shapes, op coverage, etc. from llvmjit are mirrored here for the moment.

I've partially tested manually using some test .dll files and a (next PR) LLVMAOTTarget on the compiler side. I'd like to expand on `iree/hal/cts/` coverage soon.

Closes https://github.com/google/iree/pull/2099

COPYBARA_INTEGRATE_REVIEW=https://github.com/google/iree/pull/2099 from ScottTodd:dylib d6356b683104d9e6d9bbd9f592a983787013e716
PiperOrigin-RevId: 314794646
22 files changed
tree: ba3b721939714034c58034dca820b9ff06de58a4
  1. .github/
  2. bindings/
  3. build_tools/
  4. colab/
  5. docs/
  6. experimental/
  7. integrations/
  8. iree/
  9. kokoro/
  10. scripts/
  11. third_party/
  12. .bazelignore
  13. .bazelrc
  14. .bazelversion
  15. .clang-format
  16. .gitignore
  17. .gitmodules
  18. BUILD.bazel
  19. CMakeLists.txt
  20. configure_bazel.py
  21. CONTRIBUTING.md
  22. LICENSE
  23. README.md
  24. repo_utils.bzl
  25. SUBMODULE_VERSIONS
  26. WORKSPACE
README.md

IREE: Intermediate Representation Execution Environment

IREE (Intermediate Representation Execution Environment, pronounced as “eerie”) is an MLIR-based end-to-end compiler that lowers ML models to a unified IR optimized for real-time mobile/edge inference against heterogeneous hardware accelerators. IREE also provides flexible deployment solutions for the compiled ML models.

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 logisitics. 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.

Getting Started

For development, IREE supports both Bazel and CMake on Windows and Linux. We are working on enabling macOS support. For deployment, IREE aims to additionally cover Android and iOS.

Please see the Getting Started pages on IREE's documentation hub to configure, compile, and run IREE in your favorite development environment!

Documentation and Talks

IREE hosts all its documentation and project status dashboards on GitHub Pages. We are still building up the website; please feel free to create issues for the documentation you'd like to see!

We also have some public talks that explain IREE's concepts and architecture:

  • 2020-03-18: Interactive HAL IR Walkthrough (Ben Vanik and core team) (recording)
  • 2020-01-31: End-to-end MLIR Workflow in IREE (recording and slides)

Architecture and Goals

IREE adopts a holistic approach towards ML model compilation: the IR produced contains both the scheduling logic, required to communicate data dependencies to low-level parallel pipelined hardware/API like Vulkan, and the execution logic, encoding dense computation on the hardware in the form of hardware/API-specific binaries like SPIR-V.

The architecture of IREE is best illustrated by the following picture:

IREE Architecture

Being compilation-based means IREE does not have a traditional runtime that dispatches “ops” to their fat kernel implemenations. What IREE provides is a toolbox for different deployment scenarios. It scales from running generated code on a particular API (such as emitting C code calling external DSP kernels), to a HAL (Hardware Abstraction Layer) that allows the same generated code to target multiple APIs (like Vulkan and Direct3D 12), to a full VM allowing runtime model loading for flexible deployment options and heterogeneous execution.

IREE aims to

  • Support advanced models on mobile/edge devices. Dynamic shapes, dynamic flow control, dynamic multi-model dispatch, streaming models, tree-based search algorithms, and other are all good examples of exciting ML evolution. We are trying to build IREE from the ground-up to enable these models and run them efficiently on modern hardware, especially on mobile/edge devices.
  • Demonstrate MLIR‘s ability to develop non-traditional ML compiler backends and runtimes. MLIR enables IREE’s holistic approach of focusing on the math being performed and how that math is scheduled rather than graphs of “ops”.
  • Embrace standard-based ML via Vulkan. The graphics world is shifting towards favoring mordern explicit APIs for performance and predictability and Vulkan is emerging as the “compatibility” layer. We would love to allow hardware vendors to be able to make ML efficient on their hardware without the need for bespoke runtimes and special access. We also would love to let developers and users utilize all the hardware available on as many platforms as possible.

Roadmap and Milestones

IREE is still at its early stage; we have lots of exciting future plans. Please check out the long-term design roadmap and short-term focus areas.

We use GitHub Projects to track various IREE components and GitHub Milestones for major features and quarterly plans. Please check out for updated information.

Build Status

CI SystemBuild SystemPlatformComponentStatus
GitHub ActionsBazelLinuxIntegrationsWorkflow History
GitHub ActionsBazelLinuxOtherWorkflow History
KokoroBazelLinuxCore + Bindingskokoro-status-bazel-linux
KokoroCMakeLinuxCore + Bindingskokoro-status-cmake-linux

License

IREE is licensed under the terms of the Apache license. See LICENSE for more information.