Google Git
Sign in
opensecura / 3p / openxla / iree / e2f8dc7e0c95d32c385c91795b9e4f2e550963f4
commite2f8dc7e0c95d32c385c91795b9e4f2e550963f4[log] [tgz]
authorScott Todd <scotttodd@google.com>Thu Nov 09 12:02:39 2023 -0800
committerGitHub <noreply@github.com>Thu Nov 09 12:02:39 2023 -0800
tree240a6ab0c6a33196bc15a95719caaff88841ea54
parentaa55bb6e9f48e134e4de514564111f9d956d23a6 [diff]
Merge CONTRIBUTING.md into website contributing guide. (#15449)

Following up on some ideas noted at
https://github.com/openxla/iree/issues/15116#issuecomment-1791036129.

We had previously split "contributing" docs between the root
`CONTRIBUTING.md` and a separate developer doc. Now that the developer
doc is published on our website at
https://iree.dev/developers/general/contributing/, we can move more of
the documentation there and just have the root file point at the
website.

Preview for review:
https://scotttodd.github.io/iree/developers/general/contributing/

* I rewrote and reordered most of the sections
* I have more ideas for how to streamline these docs... trying to not
spent too much time on this right now though 😛
* Separate "infrastructure" page explaining how to interact with the CI
(build/test/benchmark/etc.)
* Deemphasize "contributor tips" and/or add more tips (like how to set
up Visual Studio Code)

I took some inspiration from https://llvm.org/docs/Contributing.html and
https://llvm.org/docs/DeveloperPolicy.html.
2 files changed
tree: 240a6ab0c6a33196bc15a95719caaff88841ea54
  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

License

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