Skip to content

Commit f90771d

Browse files
ScottToddmarbre
andauthored
Refresh project status in README and website homepage. (iree-org#19482)
* Replace "IREE is still in its early phase." language with information about IREE being a sandbox project at the LF AI & Data Foundation. * Link to release notes via the non-prerelease releases page since the standard https://github.com/iree-org/iree/releases page is littered with nightly releases. Grouping prereleases under a single release like in iree-turbine and other projects would help here too. * Format "Presentations and talks" section with a table. We've had a few talks that aren't yet included here and the community meetings are now split between YouTube and Zoom (LF AI) ... not sure how best to organize them. * Add more icons to https://iree.dev/ homepage and expand on sections: ![image](https://github.com/user-attachments/assets/ecfc2fbb-46af-4d7c-bb19-f11d4d20f229) --------- Co-authored-by: Marius Brehler <[email protected]>
1 parent 3ab9d4b commit f90771d

File tree

4 files changed

+59
-36
lines changed

4 files changed

+59
-36
lines changed

README.md

Lines changed: 20 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,17 @@ guides, and instructions on building from source.
1515
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
1616
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8738/badge)](https://www.bestpractices.dev/projects/8738)
1717

18-
#### Project Status
18+
## Project news
1919

20-
IREE is still in its early phase. We have settled down on the overarching
21-
infrastructure and are actively improving various software components as well as
22-
project logistics. It is still quite far from ready for everyday use and is made
23-
available without any support at the moment. With that said, we welcome any kind
24-
of feedback on any [communication channels](#communication-channels)
20+
* 2024-05-23: [IREE joins the LF AI & Data Foundation as a sandbox-stage project](https://lfaidata.foundation/blog/2024/05/23/announcing-iree-a-new-initiative-for-machine-learning-deployment/)
21+
22+
## Project status
23+
24+
### Release status
25+
26+
Releases notes are
27+
[published on GitHub releases](https://github.com/iree-org/iree/releases?q=prerelease%3Afalse).
2528

26-
#### Release status
2729

2830
| Package | Release status |
2931
| -- | -- |
@@ -32,7 +34,7 @@ GitHub release (nightly) | [![GitHub Release](https://img.shields.io/github/v/re
3234
Python iree-base-compiler | [![PyPI version](https://badge.fury.io/py/iree-base-compiler.svg)](https://badge.fury.io/py/iree-base-compiler)
3335
Python iree-base-runtime | [![PyPI version](https://badge.fury.io/py/iree-base-runtime.svg)](https://badge.fury.io/py/iree-base-runtime)
3436

35-
#### Build status
37+
### Build status
3638

3739
[![CI](https://github.com/iree-org/iree/actions/workflows/ci.yml/badge.svg?query=branch%3Amain+event%3Apush)](https://github.com/iree-org/iree/actions/workflows/ci.yml?query=branch%3Amain+event%3Apush)
3840
[![PkgCI](https://github.com/iree-org/iree/actions/workflows/pkgci.yml/badge.svg?query=branch%3Amain+event%3Apush)](https://github.com/iree-org/iree/actions/workflows/pkgci.yml?query=branch%3Amain+event%3Apush)
@@ -46,7 +48,7 @@ Windows | [![CI - Windows x64 MSVC](https://github.com/iree-org/iree/actions/wor
4648
For the full list of workflows see
4749
https://iree.dev/developers/general/github-actions/.
4850

49-
## Communication Channels
51+
## Communication channels
5052

5153
* [GitHub issues](https://github.com/iree-org/iree/issues): Feature requests,
5254
bugs, and other work tracking
@@ -59,36 +61,31 @@ https://iree.dev/developers/general/github-actions/.
5961
* (Legacy) [iree-discuss email list](https://groups.google.com/forum/#!forum/iree-discuss):
6062
Announcements, general and low-priority discussion
6163

62-
#### Related Project Channels
64+
### Related project channels
6365

6466
* [MLIR topic within LLVM Discourse](https://llvm.discourse.group/c/llvm-project/mlir/31):
6567
IREE is enabled by and heavily relies on [MLIR](https://mlir.llvm.org). IREE
6668
sometimes is referred to in certain MLIR discussions. Useful if you are also
6769
interested in MLIR evolution.
6870

69-
## Architecture Overview
71+
## Architecture overview
7072

7173
<!-- TODO(scotttodd): switch to <picture> once better supported? https://github.blog/changelog/2022-05-19-specify-theme-context-for-images-in-markdown-beta/ -->
7274
![IREE Architecture](docs/website/docs/assets/images/iree_architecture_dark.svg#gh-dark-mode-only)
7375
![IREE Architecture](docs/website/docs/assets/images/iree_architecture.svg#gh-light-mode-only)
7476

7577
See [our website](https://iree.dev/) for more information.
7678

77-
## Presentations and Talks
79+
## Presentations and talks
7880

7981
Community meeting recordings: [IREE YouTube channel](https://www.youtube.com/@iree4356)
8082

81-
* 2021-06-09: IREE Runtime Design Tech Talk ([recording](https://drive.google.com/file/d/1p0DcysaIg8rC7ErKYEgutQkOJGPFCU3s/view) and [slides](https://drive.google.com/file/d/1ikgOdZxnMz1ExqwrAiuTY9exbe3yMWbB/view?usp=sharing))
82-
* 2020-08-20: IREE CodeGen: MLIR Open Design Meeting Presentation
83-
([recording](https://drive.google.com/file/d/1325zKXnNIXGw3cdWrDWJ1-bp952wvC6W/view?usp=sharing)
84-
and
85-
[slides](https://docs.google.com/presentation/d/1NetHjKAOYg49KixY5tELqFp6Zr2v8_ujGzWZ_3xvqC8/edit))
86-
* 2020-03-18: Interactive HAL IR Walkthrough
87-
([recording](https://drive.google.com/file/d/1_sWDgAPDfrGQZdxAapSA90AD1jVfhp-f/view?usp=sharing))
88-
* 2020-01-31: End-to-end MLIR Workflow in IREE: MLIR Open Design Meeting Presentation
89-
([recording](https://drive.google.com/open?id=1os9FaPodPI59uj7JJI3aXnTzkuttuVkR)
90-
and
91-
[slides](https://drive.google.com/open?id=1RCQ4ZPQFK9cVgu3IH1e5xbrBcqy7d_cEZ578j84OvYI))
83+
Date | Title | Recording | Slides
84+
---- | ----- | --------- | ------
85+
2021-06-09 | IREE Runtime Design Tech Talk | [recording](https://drive.google.com/file/d/1p0DcysaIg8rC7ErKYEgutQkOJGPFCU3s/view) | [slides](https://drive.google.com/file/d/1ikgOdZxnMz1ExqwrAiuTY9exbe3yMWbB/view?usp=sharing)
86+
2020-08-20 | IREE CodeGen (MLIR Open Design Meeting) | [recording](https://drive.google.com/file/d/1325zKXnNIXGw3cdWrDWJ1-bp952wvC6W/view?usp=sharing) | [slides](https://docs.google.com/presentation/d/1NetHjKAOYg49KixY5tELqFp6Zr2v8_ujGzWZ_3xvqC8/edit)
87+
2020-03-18 | Interactive HAL IR Walkthrough | [recording](https://drive.google.com/file/d/1_sWDgAPDfrGQZdxAapSA90AD1jVfhp-f/view?usp=sharing) |
88+
2020-01-31 | End-to-end MLIR Workflow in IREE (MLIR Open Design Meeting) | [recording](https://drive.google.com/open?id=1os9FaPodPI59uj7JJI3aXnTzkuttuVkR) | [slides](https://drive.google.com/open?id=1RCQ4ZPQFK9cVgu3IH1e5xbrBcqy7d_cEZ578j84OvYI)
9289

9390
## License
9491

docs/website/docs/developers/general/release-management.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ We periodically promote one of these candidates to a "stable" release by
1515
removing the "pre-release" status. This makes it show up as a "latest" release
1616
on GitHub. We also push the Python packages for this release to PyPI.
1717

18+
All stable (non-prerelease) releases can be viewed at
19+
<https://github.com/iree-org/iree/releases?q=prerelease%3Afalse>.
20+
1821
## Release status
1922

2023
| Package | Release status |

docs/website/docs/index.md

Lines changed: 35 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ lowers Machine Learning (ML) models to a unified IR that scales up to meet the
1111
needs of the datacenter and down to satisfy the constraints and special
1212
considerations of mobile and edge deployments.
1313

14-
## Key features
14+
## :octicons-sparkles-fill-16: Key features
1515

1616
<div class="grid cards" markdown>
1717

@@ -61,7 +61,7 @@ considerations of mobile and edge deployments.
6161

6262
</div>
6363

64-
## Support matrix
64+
## :material-table-star: Support matrix
6565

6666
IREE supports importing from a variety of ML frameworks:
6767

@@ -97,7 +97,7 @@ Support for hardware accelerators and APIs is also included:
9797
- [ ] AMD AIE (experimental)
9898
- [ ] WebGPU (experimental)
9999

100-
## Project architecture
100+
## :octicons-telescope-fill-24: Project architecture
101101

102102
IREE adopts a _holistic_ approach towards ML model compilation: the IR produced
103103
contains both the _scheduling_ logic, required to communicate data dependencies
@@ -109,7 +109,7 @@ like [SPIR-V](https://www.khronos.org/spir/).
109109
![IREE Architecture](./assets/images/iree_architecture_dark.svg#gh-dark-mode-only)
110110
![IREE Architecture](./assets/images/iree_architecture.svg#gh-light-mode-only)
111111

112-
## Workflow overview
112+
## :octicons-book-16: Workflow overview
113113

114114
Using IREE involves the following general steps:
115115

@@ -132,7 +132,7 @@ Using IREE involves the following general steps:
132132

133133
Use IREE's runtime components to execute your compiled model
134134

135-
### Importing models from ML frameworks
135+
### :octicons-package-dependents-16: Importing models from ML frameworks
136136

137137
IREE supports importing models from a growing list of
138138
[ML frameworks](./guides/ml-frameworks/index.md) and model formats:
@@ -143,7 +143,7 @@ IREE supports importing models from a growing list of
143143
* [:simple-tensorflow: TensorFlow](./guides/ml-frameworks/tensorflow.md) and
144144
[:simple-tensorflow: TensorFlow Lite](./guides/ml-frameworks/tflite.md)
145145

146-
### Selecting deployment configurations
146+
### :octicons-rocket-24: Selecting deployment configurations
147147

148148
IREE provides a flexible set of tools for various
149149
[deployment scenarios](./guides/deployment-configurations/index.md). Fully
@@ -159,7 +159,7 @@ runtime entirely or interface with custom accelerators.
159159
IREE supports the full set of these configurations using the same underlying
160160
technology.
161161

162-
### Compiling models
162+
### :octicons-file-code-24: Compiling models
163163

164164
Model compilation is performed ahead-of-time on a _host_ machine for any
165165
combination of _targets_. The compilation process converts from layers and
@@ -172,13 +172,27 @@ SPIR-V kernels and Vulkan API calls. For
172172
[CPU execution](./guides/deployment-configurations/cpu.md), native code with
173173
static or dynamic linkage and the associated function calls are generated.
174174

175-
### Running models
175+
### :octicons-terminal-24: Running models
176176

177177
IREE offers a low level C API, as well as several sets of
178178
[API bindings](./reference/bindings/index.md) for compiling and running programs
179179
using various languages.
180180

181-
## Communication channels
181+
## :octicons-people-24: Community
182+
183+
IREE is a [sandbox-stage project](https://lfaidata.foundation/projects/iree/)
184+
of [LF AI & Data Foundation](https://lfaidata.foundation/) made possible thanks
185+
to a growing community of developers.
186+
187+
See how IREE is used:
188+
189+
[:octicons-arrow-right-24: Community](./community/index.md)
190+
191+
### :material-newspaper: Project news
192+
193+
* 2024-05-23: [IREE joins the LF AI & Data Foundation as a sandbox-stage project](https://lfaidata.foundation/blog/2024/05/23/announcing-iree-a-new-initiative-for-machine-learning-deployment/)
194+
195+
### :octicons-broadcast-24: Communication channels
182196

183197
* :fontawesome-brands-github:
184198
[GitHub issues](https://github.com/iree-org/iree/issues): Feature requests,
@@ -193,10 +207,19 @@ using various languages.
193207
* :fontawesome-solid-envelope: (Legacy) [iree-discuss email list](https://groups.google.com/forum/#!forum/iree-discuss):
194208
Announcements, general and low-priority discussion
195209

196-
## Roadmap
210+
## :octicons-project-24: Project operations
211+
212+
### :octicons-book-24: Developer documentation
213+
214+
Interested in contributing to IREE? Check out our developer documentation:
215+
216+
[:octicons-arrow-right-24: Developers](./developers/index.md)
217+
218+
### :octicons-project-roadmap-24: Roadmap
197219

198-
IREE is in the early stages of development and is not yet ready for broad
199-
adoption. We use both
220+
IREE uses
221+
[GitHub Issues](https://github.com/iree-org/iree/issues) for most work
222+
planning. Some subprojects use both
200223
[GitHub Projects](https://github.com/iree-org/iree/projects) and
201224
[GitHub Milestones](https://github.com/iree-org/iree/milestones) to track
202225
progress.

docs/website/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
mkdocs-material==9.5.19
1+
mkdocs-material==9.5.48
22
mkdocs-redirects==1.2.1

0 commit comments

Comments
 (0)