| commit | 573f5e91901ce54c594b0e82f894a98f9f9d53f7 | [log] [tgz] |
|---|---|---|
| author | Scott Todd <scotttodd@google.com> | Fri Nov 03 08:31:57 2023 -0700 |
| committer | GitHub <noreply@github.com> | Fri Nov 03 08:31:57 2023 -0700 |
| tree | 9ceaf3282304ea8dc0b820cbdffa111f321221bc | |
| parent | d354465a12182e59ed21918420b5b777b7a9b6db [diff] |
Merge docs/developers into docs/website/. (#15396) Fixes https://github.com/openxla/iree/issues/15116.  ## Notes for review | Location description | Preview URL | | --------- | -------------- | | source folder (GitHub markdown) | [`docs/website/docs/developers/` on my fork](https://github.com/ScottTodd/iree/tree/developer-docs-folder/docs/website/docs/developers) | | website (mkdocs site generator) | https://scotttodd.github.io/iree/developers | * I tried to split this change into multiple smaller PRs / reviewable commits, but the nature of moving so many files around and getting them integrated into the website made that tricky * I may have missed some URL renamings. mkdocs warns about broken links on the website itself, at least ## Overview This takes the existing [`/docs/developers/`](https://github.com/openxla/iree/tree/main/docs/developers) folder and merges it into [`docs/website/`](https://github.com/openxla/iree/tree/main/docs/website) for publishing on https://iree.dev/. The website has historically been primarily serving an ambiguous group of "users" (hoping to take a model authored in an ML framework and deploy it to some target). This broadens the scope of the website to also include developers (from established maintainers to new contributors). This change does a few things: * Moves existing pages across folders * Deletes some stale pages * Updates page style to match what the "mkdocs" site generator and "mkdocs material" framework use * Updates links across the project to use website URLs, relative links, or GitHub links as appropriate ## Detailed list of changes * Added "edit this page" buttons to all pages  * Merged `building_with_bazel_[linux, macos, windows]` into a single "Building with Bazel" page that uses content tabs  * Renamed files so alphabetical sorting highlights the category that each file belongs in  * Renamed files from using underscores to using dashes (more natural for URLs) * Merged some "debugging integration test" pages and deleted outdated information (pointing at old TensorFlow code that no longer exists) * Moved "developer tips" from the top level "Guides" category into the "General development topics" subsection under this new top level "Developers" category * Applied lint and style fixes to all files (e.g. max line length, `Subsection capitalization` instead of `Subsection Capitalization`) * Merged "contributor tips" into "contributing" * Redirected or removed references to docs/developers/ (e.g. website 404 page pointed there as another place to look for docs) * Deleted "codegen passes", "hal driver features", and "dynamic shapes" design docs (all were stale) * Removed references to old processes (quirks based on supporting Google's downstream monorepo) ## Future work This PR is focused primarily on moving pages over and making minor changes where appropriate. More work is needed to refresh the content on several pages. The "developer docs" should be seen as a wiki of sorts, so the support expectations are lower, but outdated or missing documentation can be worse than no documentation in some respects. Known issues to follow up on: * The "Contributing" page should be updated, perhaps with a separate page for "Infrastructure" forked out * We have many "benchmarking" and "profiling" pages. That's great, but people shouldn't need to read all of the pages to be productive * The design docs are _very_ outdated. I removed a few of them, but we should figure out if the remaining ones are worth keeping around. New pages would be nice too * These pages could have icons and other style tweaks, e.g. the sidebar shows icons but it looks better if all pages list them:  * mkdocs [material] supports showing revision dates on files. That would be useful for showing how fresh a file is, but files can be touched by refactorings and generated files don't have git information... need to think through that a bit
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.
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!
See our website for more information.
IREE is licensed under the terms of the Apache 2.0 License with LLVM Exceptions. See LICENSE for more information.
