Google Git
Sign in
opensecura / 3p / openxla / iree / a16baf087ff45a820f118dd9e7bd82ced5a7cd2f
commita16baf087ff45a820f118dd9e7bd82ced5a7cd2f[log] [tgz]
authorScott Todd <scotttodd@google.com>Fri Jul 28 11:31:21 2023 -0700
committerGitHub <noreply@github.com>Fri Jul 28 11:31:21 2023 -0700
treeed2b2d0b0dcb11c126c443c847162923af2f7f35
parent9902af7c989b26b8839daab2c183ec1624097c8c [diff]
Iterate on C/Python bindings documentation. (#14482)

Mostly updates to the C API page:

* Added code snippets for compiler and runtime APIs (real code minus
error handling, next to links to buildable templates/samples)
* Added more links to template repos and samples (including new
[iree-org/iree-template-compiler-cmake/](https://github.com/iree-org/iree-template-compiler-cmake/)
and
[iree-org/iree-template-runtime-cmake/](https://github.com/iree-org/iree-template-runtime-cmake/))
* Added diagram for runtime high level API concepts, simplified compiler
API concepts diagram
* Added more explanations about API concepts

Other changes:

* Tweaked Python bindings page to match C API bindings structure
* Enabled `navigation.tabs.sticky` mkdocs setting, keeping the
navigation tabs visible even after scrolling (since I expect users will
want to switch between guides and reference pages)

| | |
| -- | -- |
Current site | https://openxla.github.io/iree/reference/bindings/c-api/
Preview | https://scotttodd.github.io/iree/reference/bindings/c-api/
3 files changed
tree: ed2b2d0b0dcb11c126c443c847162923af2f7f35
  1. .devcontainer/
  2. .github/
  3. build_tools/
  4. compiler/
  5. docs/
  6. experimental/
  7. integrations/
  8. lib/
  9. llvm-external-projects/
  10. runtime/
  11. samples/
  12. tests/
  13. third_party/
  14. tools/
  15. .bazel_to_cmake.cfg.py
  16. .bazelignore
  17. .bazelrc
  18. .bazelversion
  19. .clang-format
  20. .dockerignore
  21. .git-blame-ignore-revs
  22. .gitignore
  23. .gitmodules
  24. .yamllint.yml
  25. AUTHORS
  26. BUILD.bazel
  27. CITATION.cff
  28. CMakeLists.txt
  29. configure_bazel.py
  30. CONTRIBUTING.md
  31. LICENSE
  32. README.md
  33. 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.

CI Status

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.

Architecture Overview

IREE Architecture 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.