Update docs, experimental and samples

Updates the documentation, scripts in `experimental` and the samples to reflect the renaming of the Python packages.
iree-org · Nov 7, 2024 · ff0233c · ff0233c
1 parent 98c0aef
commit ff0233c
Show file tree

Hide file tree

Showing 24 changed files with 63 additions and 61 deletions.
diff --git a/RELEASING.md b/RELEASING.md
@@ -32,8 +32,8 @@ A number of packages are produced automatically:
 * `iree-dist-*.tar.xz` (manylinux x86_64 and aarch64): Install image of the
   binaries and development assets needed to use or depend on the C/C++ parts
   of the project.
-* `iree-compiler`: Binary Python wheels
-* `iree-runtime`: Binary Python wheels
+* `iree-base-compiler`: Binary Python wheels
+* `iree-base-runtime`: Binary Python wheels
 * `iree-tools-tf` and `iree-tools-tflite`: Pure Python wheels
 
 #### Linux Builds
@@ -52,8 +52,8 @@ Windows builds are built using GitHub-hosted runners. Due to the cost, the
 project aims to target the most recent version of Python only while building
 version N-1 for the first year of the lifecycle of the next version.
 
-Only the Python `iree-compiler` and `iree-runtime` packages are built for
-Windows.
+Only the Python `iree-base-compiler` and `iree-base-runtime` packages are
+built for Windows.
 
 The release is published even if the Windows build fails. When this happens, it
 is fixed forward for the next snapshot.
@@ -64,8 +64,8 @@ MacOS builds are performed using GitHub-hosted runners. Due to the cost, the
 project aims to target the most recent version of Python only while building
 version N-1 for the first year of the lifecycle of the next version.
 
-Only the Python `iree-compiler` and `iree-runtime` packages are built for
-MacOS.
+Only the Python `iree-base-compiler` and `iree-base-runtime` packages are
+built for MacOS.
 
 The release is published even if the MacOS build fails. When this happens, it
 is fixed forward for the next snapshot.
@@ -82,14 +82,16 @@ release process:
 
 ### PyPI
 
-* https://pypi.org/project/iree-compiler/
-* https://pypi.org/project/iree-runtime/
+* https://pypi.org/project/iree-base-compiler/
+* https://pypi.org/project/iree-base-runtime/
 * https://pypi.org/project/iree-turbine/
 * https://pypi.org/project/iree-tools-tf/
 * https://pypi.org/project/iree-tools-tflite/
 
 Deprecated projects no longer updated:
 
+* https://pypi.org/project/iree-compiler/ (replaced by iree-base-compiler)
+* https://pypi.org/project/iree-runtime/ (replaced by iree-base-runtime)
 * https://pypi.org/project/iree-runtime-instrumented/ (functionality is
   included in the main iree-runtime package)
 * https://pypi.org/project/iree-tools-xla/ (functionality is no longer needed)

diff --git a/docs/website/docs/developers/debugging/integration-tests.md b/docs/website/docs/developers/debugging/integration-tests.md
@@ -74,7 +74,7 @@ All steps here assume starting from the IREE root directory.
     # Install packages from nightly releases
     # This should work for most cases, as the importers change infrequently
     python -m pip install \
-      iree-compiler iree-runtime iree-tools-tf iree-tools-tflite \
+      iree-base-compiler iree-base-runtime iree-tools-tf iree-tools-tflite \
       --find-links https://iree.dev/pip-release-links.html
     ```
 

diff --git a/docs/website/docs/developers/debugging/sanitizers.md b/docs/website/docs/developers/debugging/sanitizers.md
@@ -115,8 +115,8 @@ ASAN_SYMBOLIZER_PATH=/usr/lib/llvm-12/bin/llvm-symbolizer \
     `PYTHONPATH` pointing at your build directory:
 
     ```shell hl_lines="14-18"
-    python -m pip uninstall iree-runtime
-    python -m pip uninstall iree-compiler
+    python -m pip uninstall iree-base-runtime
+    python -m pip uninstall iree-base-compiler
     source iree-build/.env && export PYTHONPATH
 
     LD_PRELOAD=/usr/lib/llvm-12/lib/clang/12.0.0/lib/linux/libclang_rt.asan-x86_64.so \

diff --git a/docs/website/docs/developers/performance/profiling-with-tracy.md b/docs/website/docs/developers/performance/profiling-with-tracy.md
@@ -114,11 +114,11 @@ be built from source by using either the upstream CMake build or IREE's
 
     ??? tip - "Tip - Instrumented Python packages"
 
-        The `iree-runtime` Python package includes prebuilt instrumented tools.
+        The `iree-base-runtime` Python package includes prebuilt instrumented tools.
         Set the `IREE_PY_RUNTIME=tracy` environment variable to use them:
 
         ```shell
-        python -m pip install iree-runtime
+        python -m pip install iree-base-runtime
         IREE_PY_RUNTIME=tracy iree-run-module ...
         ```
 

diff --git a/docs/website/docs/guides/deployment-configurations/cpu.md b/docs/website/docs/guides/deployment-configurations/cpu.md
@@ -44,7 +44,7 @@ At runtime, CPU executables can be loaded using one of IREE's CPU HAL drivers:
 Python packages are regularly published to
 [PyPI](https://pypi.org/user/google-iree-pypi-deploy/). See the
 [Python Bindings](../../reference/bindings/python.md) page for more details.
-The core `iree-compiler` package includes the LLVM-based CPU compiler:
+The core `iree-base-compiler` package includes the LLVM-based CPU compiler:
 
 --8<-- "docs/website/docs/guides/deployment-configurations/snippets/_iree-compiler-from-release.md"
 
@@ -82,7 +82,7 @@ drivers:
 Python packages are regularly published to
 [PyPI](https://pypi.org/user/google-iree-pypi-deploy/). See the
 [Python Bindings](../../reference/bindings/python.md) page for more details.
-The core `iree-runtime` package includes the local CPU HAL drivers:
+The core `iree-base-runtime` package includes the local CPU HAL drivers:
 
 --8<-- "docs/website/docs/guides/deployment-configurations/snippets/_iree-runtime-from-release.md"
 

diff --git a/docs/website/docs/guides/deployment-configurations/gpu-cuda.md b/docs/website/docs/guides/deployment-configurations/gpu-cuda.md
@@ -31,7 +31,7 @@ If `nvidia-smi` does not exist, you will need to
 Python packages are regularly published to
 [PyPI](https://pypi.org/user/google-iree-pypi-deploy/). See the
 [Python Bindings](../../reference/bindings/python.md) page for more details.
-The core `iree-compiler` package includes the CUDA compiler:
+The core `iree-base-compiler` package includes the CUDA compiler:
 
 --8<-- "docs/website/docs/guides/deployment-configurations/snippets/_iree-compiler-from-release.md"
 
@@ -69,7 +69,7 @@ $ iree-run-module --list_devices
 Python packages are regularly published to
 [PyPI](https://pypi.org/user/google-iree-pypi-deploy/). See the
 [Python Bindings](../../reference/bindings/python.md) page for more details.
-The core `iree-runtime` package includes the CUDA HAL driver:
+The core `iree-base-runtime` package includes the CUDA HAL driver:
 
 --8<-- "docs/website/docs/guides/deployment-configurations/snippets/_iree-runtime-from-release.md"
 

diff --git a/docs/website/docs/guides/deployment-configurations/gpu-rocm.md b/docs/website/docs/guides/deployment-configurations/gpu-rocm.md
@@ -33,7 +33,7 @@ or [Linux](https://rocm.docs.amd.com/en/latest/deploy/linux/quick_start.html).
 Python packages are regularly published to
 [PyPI](https://pypi.org/user/google-iree-pypi-deploy/). See the
 [Python Bindings](../../reference/bindings/python.md) page for more details.
-The core `iree-compiler` package includes the ROCm compiler:
+The core `iree-base-compiler` package includes the ROCm compiler:
 
 --8<-- "docs/website/docs/guides/deployment-configurations/snippets/_iree-compiler-from-release.md"
 
@@ -71,7 +71,7 @@ $ iree-run-module --list_devices
 Python packages are regularly published to
 [PyPI](https://pypi.org/user/google-iree-pypi-deploy/). See the
 [Python Bindings](../../reference/bindings/python.md) page for more details.
-The core `iree-runtime` package includes the HIP HAL driver:
+The core `iree-base-runtime` package includes the HIP HAL driver:
 
 --8<-- "docs/website/docs/guides/deployment-configurations/snippets/_iree-runtime-from-release.md"
 

diff --git a/docs/website/docs/guides/deployment-configurations/gpu-vulkan.md b/docs/website/docs/guides/deployment-configurations/gpu-vulkan.md
@@ -81,7 +81,7 @@ the model must be compiled into.
 Python packages are regularly published to
 [PyPI](https://pypi.org/user/google-iree-pypi-deploy/). See the
 [Python Bindings](../../reference/bindings/python.md) page for more details.
-The core `iree-compiler` package includes the SPIR-V compiler:
+The core `iree-base-compiler` package includes the SPIR-V compiler:
 
 --8<-- "docs/website/docs/guides/deployment-configurations/snippets/_iree-compiler-from-release.md"
 
@@ -125,7 +125,7 @@ $ iree-run-module --list_devices
 Python packages are regularly published to
 [PyPI](https://pypi.org/user/google-iree-pypi-deploy/). See the
 [Python Bindings](../../reference/bindings/python.md) page for more details.
-The core `iree-runtime` package includes the Vulkan HAL drivers:
+The core `iree-base-runtime` package includes the Vulkan HAL drivers:
 
 --8<-- "docs/website/docs/guides/deployment-configurations/snippets/_iree-runtime-from-release.md"
 

diff --git a/...e/docs/guides/deployment-configurations/snippets/_iree-compiler-from-release.md b/...e/docs/guides/deployment-configurations/snippets/_iree-compiler-from-release.md
@@ -4,7 +4,7 @@
     [published to PyPI](https://pypi.org/user/google-iree-pypi-deploy/).
 
     ``` shell
-    python -m pip install iree-compiler
+    python -m pip install iree-base-compiler
     ```
 
 === ":material-alert: Nightly releases"
@@ -15,7 +15,7 @@
     ``` shell
     python -m pip install \
       --find-links https://iree.dev/pip-release-links.html \
-      --upgrade iree-compiler
+      --upgrade iree-base-compiler
     ```
 
 !!! tip

diff --git a/...te/docs/guides/deployment-configurations/snippets/_iree-runtime-from-release.md b/...te/docs/guides/deployment-configurations/snippets/_iree-runtime-from-release.md
@@ -4,7 +4,7 @@
     [published to PyPI](https://pypi.org/user/google-iree-pypi-deploy/).
 
     ``` shell
-    python -m pip install iree-runtime
+    python -m pip install iree-base-runtime
     ```
 
 === ":material-alert: Nightly releases"
@@ -15,5 +15,5 @@
     ``` shell
     python -m pip install \
       --find-links https://iree.dev/pip-release-links.html \
-      --upgrade iree-runtime
+      --upgrade iree-base-runtime
     ```
diff --git a/docs/website/docs/guides/ml-frameworks/onnx.md b/docs/website/docs/guides/ml-frameworks/onnx.md
@@ -64,8 +64,8 @@ graph LR
 
         ``` shell
         python -m pip install \
-          iree-compiler[onnx] \
-          iree-runtime
+          iree-base-compiler[onnx] \
+          iree-base-runtime
         ```
 
     === ":material-alert: Nightly releases"
@@ -77,8 +77,8 @@ graph LR
         python -m pip install \
           --find-links https://iree.dev/pip-release-links.html \
           --upgrade \
-          iree-compiler[onnx] \
-          iree-runtime
+          iree-base-compiler[onnx] \
+          iree-base-runtime
         ```
 
 ## :octicons-rocket-16: Quickstart

diff --git a/docs/website/docs/guides/ml-frameworks/tensorflow.md b/docs/website/docs/guides/ml-frameworks/tensorflow.md
@@ -66,8 +66,8 @@ graph LR
 
         ``` shell
         python -m pip install \
-          iree-compiler \
-          iree-runtime \
+          iree-base-compiler \
+          iree-base-runtime \
           iree-tools-tf
         ```
 
@@ -80,8 +80,8 @@ graph LR
         python -m pip install \
           --find-links https://iree.dev/pip-release-links.html \
           --upgrade \
-          iree-compiler \
-          iree-runtime \
+          iree-base-compiler \
+          iree-base-runtime \
           iree-tools-tf
         ```
 

diff --git a/docs/website/docs/guides/ml-frameworks/tflite.md b/docs/website/docs/guides/ml-frameworks/tflite.md
@@ -61,8 +61,8 @@ graph LR
 
         ``` shell
         python -m pip install \
-          iree-compiler \
-          iree-runtime \
+          iree-base-compiler \
+          iree-base-runtime \
           iree-tools-tflite
         ```
 
@@ -75,8 +75,8 @@ graph LR
         python -m pip install \
           --find-links https://iree.dev/pip-release-links.html \
           --upgrade \
-          iree-compiler \
-          iree-runtime \
+          iree-base-compiler \
+          iree-base-runtime \
           iree-tools-tflite
         ```
 

diff --git a/docs/website/docs/reference/bindings/python.md b/docs/website/docs/reference/bindings/python.md
@@ -15,11 +15,11 @@ components:
 
 | PIP package name             | Description                                                                 |
 |------------------------------|-----------------------------------------------------------------------------|
-| `iree-compiler`     | IREE's generic compiler tools and helpers                                   |
-| `iree-runtime`      | IREE's runtime, including CPU and GPU backends                              |
-| `iree-tools-tf`     | Tools for importing from [TensorFlow](https://www.tensorflow.org/)          |
-| `iree-tools-tflite` | Tools for importing from [TensorFlow Lite](https://www.tensorflow.org/lite) |
-| `iree-jax`          | Tools for importing from [JAX](https://github.com/google/jax)               |
+| `iree-base-compiler` | IREE's generic compiler tools and helpers                                   |
+| `iree-base-runtime`  | IREE's runtime, including CPU and GPU backends                              |
+| `iree-tools-tf`      | Tools for importing from [TensorFlow](https://www.tensorflow.org/)          |
+| `iree-tools-tflite`  | Tools for importing from [TensorFlow Lite](https://www.tensorflow.org/lite) |
+| `iree-jax`           | Tools for importing from [JAX](https://github.com/google/jax)               |
 
 Collectively, these packages allow for importing from frontends, compiling
 towards various targets, and executing compiled code on IREE's backends.
@@ -70,8 +70,8 @@ To use IREE's Python bindings, you will first need to install
 
     ``` shell
     python -m pip install \
-      iree-compiler \
-      iree-runtime
+      iree-base-compiler \
+      iree-base-runtime
     ```
 
 === ":material-alert: Nightly releases"
@@ -83,8 +83,8 @@ To use IREE's Python bindings, you will first need to install
     python -m pip install \
       --find-links https://iree.dev/pip-release-links.html \
       --upgrade \
-      iree-compiler \
-      iree-runtime
+      iree-base-compiler \
+      iree-base-runtime
     ```
 
 ### :material-hammer-wrench: Building from source
@@ -164,15 +164,15 @@ like `iree-compile` and `iree-run-module`.  After installing a package from
 pip, these should be added to your path automatically:
 
 ```console
-$ python -m pip install iree-runtime
+$ python -m pip install iree-base-runtime
 $ which iree-run-module
 
 /projects/.venv/Scripts/iree-run-module
 ```
 
 ## :material-chart-line: Profiling
 
-The tools in the `iree-runtime` package support variants:
+The tools in the `iree-base-runtime` package support variants:
 
 | Variant name | Description |
 | ------------ | ----------- |

diff --git a/experimental/web/generate_web_metrics.sh b/experimental/web/generate_web_metrics.sh
@@ -67,7 +67,7 @@ trap "deactivate 2> /dev/null" EXIT
 
 python -m pip install --upgrade \
   --find-links https://iree.dev/pip-release-links.html \
-  iree-compiler iree-tools-tflite
+  iree-base-compiler iree-tools-tflite
 
 ###############################################################################
 # Download program source files                                               #

diff --git a/experimental/web/sample_dynamic/build_sample.sh b/experimental/web/sample_dynamic/build_sample.sh
@@ -14,7 +14,7 @@
 # Sample usage:
 #   python -m venv .venv
 #   source .venv/bin/activate
-#   python -m pip install iree-compiler iree-runtime
+#   python -m pip install iree-base-compiler iree-base-runtime
 #   build_sample.sh .venv/bin && serve_sample.sh
 #
 # The build directory for the emscripten build is taken from the environment

diff --git a/experimental/web/sample_static/build_sample.sh b/experimental/web/sample_static/build_sample.sh
@@ -14,7 +14,7 @@
 # Sample usage:
 #   python -m venv .venv
 #   source .venv/bin/activate
-#   python -m pip install iree-compiler iree-runtime
+#   python -m pip install iree-base-compiler iree-base-runtime
 #   build_sample.sh .venv/bin && serve_sample.sh
 #
 # The build directory for the emscripten build is taken from the environment

diff --git a/experimental/web/sample_webgpu/build_sample.sh b/experimental/web/sample_webgpu/build_sample.sh
@@ -14,7 +14,7 @@
 # Sample usage:
 #   python -m venv .venv
 #   source .venv/bin/activate
-#   python -m pip install iree-compiler iree-runtime
+#   python -m pip install iree-base-compiler iree-base-runtime
 #   build_sample.sh .venv/bin && serve_sample.sh
 #
 # The build directory for the emscripten build is taken from the environment

diff --git a/experimental/web/testing/build_tests.sh b/experimental/web/testing/build_tests.sh
@@ -14,7 +14,7 @@
 # Sample usage:
 #   python -m venv .venv
 #   source .venv/bin/activate
-#   python -m pip install iree-compiler iree-runtime
+#   python -m pip install iree-base-compiler iree-base-runtime
 #   build_tests.sh .venv/bin && serve_tests.sh
 
 set -e

diff --git a/samples/custom_module/basic/README.md b/samples/custom_module/basic/README.md
@@ -30,10 +30,10 @@ are implemented using this mechanism.
 
 ## Instructions
 
-1. Build or install the `iree-compile` binary:
+1. Build or install the `iree-base-compiler` binary:
 
     ```
-    python -m pip install iree-compiler
+    python -m pip install iree-base-compiler
     ```
 
     [See here](https://iree.dev/reference/bindings/python/)

diff --git a/samples/custom_module/dynamic/README.md b/samples/custom_module/dynamic/README.md
@@ -25,10 +25,10 @@ dynamic modules should be carefully considered.
 
 ## Instructions
 
-1. Build or install the `iree-compile` binary:
+1. Build or install the `iree-base-compiler` binary:
 
     ```
-    python -m pip install iree-compiler
+    python -m pip install iree-base-compiler
     ```
 
     [See here](https://iree.dev/reference/bindings/python/)

diff --git a/samples/custom_module/static/README.md b/samples/custom_module/static/README.md
@@ -30,10 +30,10 @@ the same module code between all various modes with minor differences.
 
 ## Instructions
 
-1. Build or install the `iree-compile` binary:
+1. Build or install the `iree-base-compiler` binary:
 
     ```
-    python -m pip install iree-compiler
+    python -m pip install iree-base-compiler
     ```
 
     [See here](https://iree.dev/reference/bindings/python/)