-
Notifications
You must be signed in to change notification settings - Fork 598
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[docs] Update and harmonize guids for deployment
This updates and harmonizes the guides for the different deployment configurations. Several identical sections are provided as snippets. * Updates docs regarding ROCm support * Adds a subsection on downloading the runtime from a release * Adds instructions on checking for CUDA and ROCm support This superseds #18173 and #18655. skip-ci: Doc updates only
- Loading branch information
Showing
7 changed files
with
132 additions
and
102 deletions.
There are no files selected for viewing
29 changes: 29 additions & 0 deletions
29
docs/website/docs/guides/deployment-configurations/_iree-compiler-from-release.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
=== "Stable releases" | ||
|
||
Stable release packages are | ||
[published to PyPI](https://pypi.org/user/google-iree-pypi-deploy/). | ||
|
||
``` shell | ||
python -m pip install iree-compiler iree-runtime | ||
``` | ||
|
||
=== ":material-alert: Nightly releases" | ||
|
||
Nightly releases are published on | ||
[GitHub releases](https://github.com/iree-org/iree/releases). | ||
|
||
``` shell | ||
python -m pip install \ | ||
--find-links https://iree.dev/pip-release-links.html \ | ||
--upgrade iree-compiler iree-runtime | ||
``` | ||
|
||
!!! tip | ||
`iree-compile` and other tools are installed to your python module | ||
installation path. If you pip install with the user mode, it is under | ||
`${HOME}/.local/bin`, or `%APPDATA%Python` on Windows. You may want to | ||
include the path in your system's `PATH` environment variable: | ||
|
||
```shell | ||
export PATH=${HOME}/.local/bin:${PATH} | ||
``` |
7 changes: 7 additions & 0 deletions
7
docs/website/docs/guides/deployment-configurations/_iree-run-module-driver-list.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
$ iree-run-module --list_drivers | ||
|
||
cuda: NVIDIA CUDA HAL driver (via dylib) | ||
hip: HIP HAL driver (via dylib) | ||
local-sync: Local execution using a lightweight inline synchronous queue | ||
local-task: Local execution using the IREE multithreading task system | ||
vulkan: Vulkan 1.x (dynamic) |
19 changes: 19 additions & 0 deletions
19
docs/website/docs/guides/deployment-configurations/_iree-runtime-from-release.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
=== "Stable releases" | ||
|
||
Stable release packages are | ||
[published to PyPI](https://pypi.org/user/google-iree-pypi-deploy/). | ||
|
||
``` shell | ||
python -m pip install iree-runtime | ||
``` | ||
|
||
=== ":material-alert: Nightly releases" | ||
|
||
Nightly releases are published on | ||
[GitHub releases](https://github.com/iree-org/iree/releases). | ||
|
||
``` shell | ||
python -m pip install \ | ||
--find-links https://iree.dev/pip-release-links.html \ | ||
--upgrade iree-runtime | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters