Update docs, experimental and samples (iree-org#19065)

Updates the documentation, scripts in `experimental` and the samples to reflect the renaming of the Python packages. Signed-off-by: Giacomo Serafini <[email protected]>
giacs-epic · Dec 4, 2024 · f8df954 · f8df954
1 parent 0d5ac50
commit f8df954
Show file tree

Hide file tree

Showing 29 changed files with 84 additions and 73 deletions.
diff --git a/.github/workflows/build_package.yml b/.github/workflows/build_package.yml
@@ -26,10 +26,10 @@ on:
         description: "Version of the package"
         required: true
       compiler_package_version:
-        description: "Version of the iree-compiler package"
+        description: "Version of the iree-base-compiler package"
         required: true
       runtime_package_version:
-        description: "Version of the iree-runtime package"
+        description: "Version of the iree-base-runtime package"
         required: true
       release_id:
         description: "Release id to upload artifacts to"
@@ -78,7 +78,7 @@ jobs:
           EOF
           cat ./c/version_local.json
 
-          echo "iree-compiler"
+          echo "iree-base-compiler"
           cat << EOF > ./c/compiler/version_local.json
           {
             "package-suffix": "${{ github.event.inputs.package_suffix }}",
@@ -88,7 +88,7 @@ jobs:
           EOF
           cat ./c/compiler/version_local.json
 
-          echo "iree-runtime"
+          echo "iree-base-runtime"
           cat << EOF > ./c/runtime/version_local.json
           {
             "package-suffix": "${{ github.event.inputs.package_suffix }}",

diff --git a/.github/workflows/oneshot_candidate_release.yml b/.github/workflows/oneshot_candidate_release.yml
@@ -27,11 +27,11 @@ jobs:
           legacy_package_version="$(printf '%(%Y%m%d)T.${{ github.run_number }}')"
           echo "legacy_package_version=${legacy_package_version}" >> $GITHUB_ENV
 
-          # iree-compiler version
+          # iree-base-compiler version
           compiler_package_version="$(python3 build_tools/python_deploy/compute_local_version.py compiler -rc)"
           echo "compiler_package_version=${compiler_package_version}" >> $GITHUB_ENV
 
-          # iree-runtime version
+          # iree-base-runtime version
           runtime_package_version="$(python3 build_tools/python_deploy/compute_local_version.py runtime -rc)"
           echo "runtime_package_version=${runtime_package_version}" >> $GITHUB_ENV
 

diff --git a/.github/workflows/schedule_candidate_release.yml b/.github/workflows/schedule_candidate_release.yml
@@ -48,11 +48,11 @@ jobs:
           legacy_package_version="$(printf '%(%Y%m%d)T.${{ github.run_number }}')"
           echo "legacy_package_version=${legacy_package_version}" >> $GITHUB_ENV
 
-          # iree-compiler version
+          # iree-base-compiler version
           compiler_package_version="$(python3 build_tools/python_deploy/compute_local_version.py compiler -rc)"
           echo "compiler_package_version=${compiler_package_version}" >> $GITHUB_ENV
 
-          # iree-runtime version
+          # iree-base-runtime version
           runtime_package_version="$(python3 build_tools/python_deploy/compute_local_version.py runtime -rc)"
           echo "runtime_package_version=${runtime_package_version}" >> $GITHUB_ENV
 

diff --git a/README.md b/README.md
@@ -29,8 +29,8 @@ of feedback on any [communication channels](#communication-channels)
 | -- | -- |
 GitHub release (stable) | [![GitHub Release](https://img.shields.io/github/v/release/iree-org/iree)](https://github.com/iree-org/iree/releases/latest)
 GitHub release (nightly) | [![GitHub Release](https://img.shields.io/github/v/release/iree-org/iree?include_prereleases)](https://github.com/iree-org/iree/releases)
-Python iree-compiler | [![PyPI version](https://badge.fury.io/py/iree-compiler.svg)](https://badge.fury.io/py/iree-compiler)
-Python iree-runtime | [![PyPI version](https://badge.fury.io/py/iree-runtime.svg)](https://badge.fury.io/py/iree-runtime)
+Python iree-base-compiler | [![PyPI version](https://badge.fury.io/py/iree-base-compiler.svg)](https://badge.fury.io/py/iree-base-compiler)
+Python iree-base-runtime | [![PyPI version](https://badge.fury.io/py/iree-base-runtime.svg)](https://badge.fury.io/py/iree-base-runtime)
 
 #### Build status
 

diff --git a/RELEASING.md b/RELEASING.md
@@ -31,8 +31,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
@@ -51,8 +51,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.
@@ -63,8 +63,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.
@@ -81,14 +81,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/api_docs/python/requirements.txt b/docs/api_docs/python/requirements.txt
@@ -12,5 +12,5 @@ sphinxcontrib-qthelp==1.0.3
 
 # IREE Python API
 -f https://iree.dev/pip-release-links.html
-iree-compiler
-iree-runtime
+iree-base-compiler
+iree-base-runtime
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
         ```