Blame - README.md - 3p/openxla/iree

blob: 5477ec6a67688910d253c566b823e63b1d34e43e [file] [log] [blame] [view]

Lei Zhang	c4cfa79	2020-04-08 14:55:41 -0700	[diff] [blame]	1	# IREE: Intermediate Representation Execution Environment
Ben Vanik	363fa07	2019-09-19 10:26:25 -0700	[diff] [blame]	2
Lei Zhang	c4cfa79	2020-04-08 14:55:41 -0700	[diff] [blame]	3	IREE (Intermediate Representation Execution Environment,
Stella Laurenzo	f165f60	2021-05-22 16:38:02 -0700	[diff] [blame]	4	pronounced as "eerie") is an [MLIR](https://mlir.llvm.org/)-based end-to-end
				5	compiler and runtime that lowers Machine Learning (ML) models to a unified IR
				6	that scales up to meet the needs of the datacenter and down to satisfy the
				7	constraints and special considerations of mobile and edge deployments.
Scott Todd	cb0727a	2021-05-07 15:01:01 -0700	[diff] [blame]	8
Scott Todd	c7b2912	2023-02-21 17:33:35 -0800	[diff] [blame]	9	See [our website](https://openxla.github.io/iree/) for project details, user
Scott Todd	cb0727a	2021-05-07 15:01:01 -0700	[diff] [blame]	10	guides, and instructions on building from source.
Ben Vanik	363fa07	2019-09-19 10:26:25 -0700	[diff] [blame]	11
Scott Todd	c7b2912	2023-02-21 17:33:35 -0800	[diff] [blame]	12	[![CI Status](https://github.com/openxla/iree/actions/workflows/ci.yml/badge.svg?query=branch%3Amain+event%3Apush)](https://github.com/openxla/iree/actions/workflows/ci.yml?query=branch%3Amain+event%3Apush)
Geoffrey Martin-Noble	0d87646	2022-08-11 13:20:20 -0700	[diff] [blame]	13
Lei Zhang	c4cfa79	2020-04-08 14:55:41 -0700	[diff] [blame]	14	#### Project Status
Ben Vanik	363fa07	2019-09-19 10:26:25 -0700	[diff] [blame]	15
Lei Zhang	c4cfa79	2020-04-08 14:55:41 -0700	[diff] [blame]	16	IREE is still in its early phase. We have settled down on the overarching
				17	infrastructure and are actively improving various software components as well as
phoenix-meadowlark	f81eef3	2020-06-10 11:02:21 -0700	[diff] [blame]	18	project logistics. It is still quite far from ready for everyday use and is made
				19	available without any support at the moment. With that said, we welcome any kind
				20	of feedback on any [communication channels](#communication-channels)!
Ben Vanik	363fa07	2019-09-19 10:26:25 -0700	[diff] [blame]	21
Stella Laurenzo	1121c5f	2020-03-18 15:01:20 -0700	[diff] [blame]	22	## Communication Channels
Geoffrey Martin-Noble	ec3c4a6	2019-12-18 14:47:42 -0800	[diff] [blame]	23
Scott Todd	c7b2912	2023-02-21 17:33:35 -0800	[diff] [blame]	24	* [GitHub issues](https://github.com/openxla/iree/issues): Feature requests,
Scott Todd	cb0727a	2021-05-07 15:01:01 -0700	[diff] [blame]	25	bugs, and other work tracking
				26	* [IREE Discord server](https://discord.gg/26P4xW4): Daily development
				27	discussions with the core team and collaborators
				28	* [iree-discuss email list](https://groups.google.com/forum/#!forum/iree-discuss):
				29	Announcements, general and low-priority discussion
Stella Laurenzo	1121c5f	2020-03-18 15:01:20 -0700	[diff] [blame]	30
Lei Zhang	c4cfa79	2020-04-08 14:55:41 -0700	[diff] [blame]	31	#### Related Project Channels
Stella Laurenzo	1121c5f	2020-03-18 15:01:20 -0700	[diff] [blame]	32
				33	* [MLIR topic within LLVM Discourse](https://llvm.discourse.group/c/llvm-project/mlir/31):
Lei Zhang	c4cfa79	2020-04-08 14:55:41 -0700	[diff] [blame]	34	IREE is enabled by and heavily relies on [MLIR](https://mlir.llvm.org). IREE
				35	sometimes is referred to in certain MLIR discussions. Useful if you are also
				36	interested in MLIR evolution.
				37
Ben Vanik	15cee8f	2021-09-15 11:31:59 -0700	[diff] [blame]	38	## Architecture Overview
				39
Scott Todd	0acd6ec	2022-05-23 15:53:30 -0700	[diff] [blame]	40	<!-- TODO(scotttodd): switch to <picture> once better supported? https://github.blog/changelog/2022-05-19-specify-theme-context-for-images-in-markdown-beta/ -->
				41	![IREE Architecture](docs/website/docs/assets/images/iree_architecture_dark.svg#gh-dark-mode-only)
				42	![IREE Architecture](docs/website/docs/assets/images/iree_architecture.svg#gh-light-mode-only)
Ben Vanik	15cee8f	2021-09-15 11:31:59 -0700	[diff] [blame]	43
Scott Todd	c7b2912	2023-02-21 17:33:35 -0800	[diff] [blame]	44	See [our website](https://openxla.github.io/iree/) for more information.
Geoffrey Martin-Noble	65e115b	2019-12-27 18:03:15 -0800	[diff] [blame]	45
Scott Todd	cb0727a	2021-05-07 15:01:01 -0700	[diff] [blame]	46	## Presentations and Talks
				47
Julian Walker	4d1a194	2021-12-10 14:13:50 -0800	[diff] [blame]	48	* 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))
Scott Todd	cb0727a	2021-05-07 15:01:01 -0700	[diff] [blame]	49	* 2020-08-20: IREE CodeGen: MLIR Open Design Meeting Presentation
				50	([recording](https://drive.google.com/file/d/1325zKXnNIXGw3cdWrDWJ1-bp952wvC6W/view?usp=sharing)
				51	and
				52	[slides](https://docs.google.com/presentation/d/1NetHjKAOYg49KixY5tELqFp6Zr2v8_ujGzWZ_3xvqC8/edit))
				53	* 2020-03-18: Interactive HAL IR Walkthrough
				54	([recording](https://drive.google.com/file/d/1_sWDgAPDfrGQZdxAapSA90AD1jVfhp-f/view?usp=sharing))
				55	* 2020-01-31: End-to-end MLIR Workflow in IREE: MLIR Open Design Meeting Presentation
				56	([recording](https://drive.google.com/open?id=1os9FaPodPI59uj7JJI3aXnTzkuttuVkR)
				57	and
				58	[slides](https://drive.google.com/open?id=1RCQ4ZPQFK9cVgu3IH1e5xbrBcqy7d_cEZ578j84OvYI))
				59
Ben Vanik	363fa07	2019-09-19 10:26:25 -0700	[diff] [blame]	60	## License
				61
Geoffrey Martin-Noble	552d3f8	2021-05-25 17:56:09 -0700	[diff] [blame]	62	IREE is licensed under the terms of the Apache 2.0 License with LLVM Exceptions.
				63	See [LICENSE](LICENSE) for more information.