Update iree-compile path in the website docs (#8909)
Update the iree-compiler path for the python installation option.
diff --git a/docs/website/docs/deployment-configurations/bare-metal.md b/docs/website/docs/deployment-configurations/bare-metal.md
index a7e2a64..0c65b59 100644
--- a/docs/website/docs/deployment-configurations/bare-metal.md
+++ b/docs/website/docs/deployment-configurations/bare-metal.md
@@ -24,11 +24,11 @@
## Compile the model for bare-metal
-The model can be compiled with the following command from the IREE compiler
-build directory
+The model can be compiled with the following command (assuming the path to
+`iree-compile` is in your system's `PATH`):
```shell
-iree/tools/iree-compile \
+iree-compile \
-iree-mlir-to-vm-bytecode-module \
-iree-stream-partitioning-favor=min-peak-memory \
-iree-hal-target-backends=dylib-llvm-aot \
diff --git a/docs/website/docs/deployment-configurations/cpu-dylib.md b/docs/website/docs/deployment-configurations/cpu-dylib.md
index 3664a1d..a92006a 100644
--- a/docs/website/docs/deployment-configurations/cpu-dylib.md
+++ b/docs/website/docs/deployment-configurations/cpu-dylib.md
@@ -53,9 +53,13 @@
```
!!! tip
- `iree-compile` is installed as `/path/to/python/site-packages/iree/tools/core/iree-compile`.
- You can find out the full path to the `site-packages` directory via the
- `python -m site` command.
+ `iree-compile` is 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}
+ ```
#### Build compiler from source
@@ -68,6 +72,10 @@
Ensure that the `IREE_TARGET_BACKEND_DYLIB_LLVM_AOT` CMake option is `ON` when
configuring for the host.
+!!! tip
+ `iree-compile` is under `iree-build/iree/tools/` directory. You may want to
+ include this path in your system's `PATH` environment variable.
+
## Compile and run the model
With the compiler and runtime for dynamic libraries, we can now compile a model
@@ -86,10 +94,11 @@
#### Compile using the command-line
-In the build directory, run the following command:
+Run the following command (assuming the path to `iree-compile` is in your
+system's `PATH`):
``` shell hl_lines="3"
-iree/tools/iree-compile \
+iree-compile \
-iree-mlir-to-vm-bytecode-module \
-iree-hal-target-backends=dylib-llvm-aot \
iree_input.mlir -o mobilenet-dylib.vmfb
diff --git a/docs/website/docs/deployment-configurations/gpu-cuda-rocm.md b/docs/website/docs/deployment-configurations/gpu-cuda-rocm.md
index 023aa24..0991014 100644
--- a/docs/website/docs/deployment-configurations/gpu-cuda-rocm.md
+++ b/docs/website/docs/deployment-configurations/gpu-cuda-rocm.md
@@ -44,7 +44,7 @@
`IREE_HAL_DRIVER_CUDA` option or the experimental ROCm HAL driver with the
`IREE_HAL_DRIVER_EXPERIMENTAL_ROCM` option.
-#### Download as Python package
+#### Download compiler as Python package
=== "Nvidia/CUDA"
@@ -57,9 +57,13 @@
```
!!! tip
- `iree-compile` is installed as `/path/to/python/site-packages/iree/tools/core/iree-compile`.
- You can find out the full path to the `site-packages` directory via the
- `python -m site` command.
+ `iree-compile` is 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}
+ ```
=== "AMD/ROCm"
@@ -93,9 +97,10 @@
IREE's TensorFlow importer. We can now compile them for each GPU by running the following command:
=== "Nvidia/CUDA"
+ Assuming the path to `iree-compiler` is in the system's `PATH` environment variable:
``` shell hl_lines="3-5"
- iree/tools/iree-compile \
+ iree-compile \
-iree-mlir-to-vm-bytecode-module \
-iree-hal-target-backends=cuda \
-iree-cuda-llvm-target-arch=<...> \
@@ -115,6 +120,7 @@
Nvidia A100 | `sm_80`
=== "AMD/ROCm"
+ In the build directory:
``` shell hl_lines="3-6"
iree/tools/iree-compile \
diff --git a/docs/website/docs/deployment-configurations/gpu-vulkan.md b/docs/website/docs/deployment-configurations/gpu-vulkan.md
index c107a8c..5557c23 100644
--- a/docs/website/docs/deployment-configurations/gpu-vulkan.md
+++ b/docs/website/docs/deployment-configurations/gpu-vulkan.md
@@ -105,9 +105,13 @@
```
!!! tip
- `iree-compile` is installed as `/path/to/python/site-packages/iree/tools/core/iree-compile`.
- You can find out the full path to the `site-packages` directory via the
- `python -m site` command.
+ `iree-compile` is 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}
+ ```
#### Build compiler from source
@@ -137,10 +141,11 @@
#### Compile using the command-line
-In the build directory, run the following command:
+Run the following command (assuming the path to `iree-compile` is in your
+system's `PATH`):
``` shell hl_lines="3 4"
-iree/tools/iree-compile \
+iree-compile \
-iree-mlir-to-vm-bytecode-module \
-iree-hal-target-backends=vulkan-spirv \
-iree-vulkan-target-triple=<...> \
