Skip to content

Commit

Permalink
Pin iree-compiler pip version, update README and docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
ScottTodd committed Apr 29, 2024
1 parent bd24bb4 commit d1ed1e3
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build-and-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ jobs:
python-version: "3.11"
- name: Install IREE compiler
run: |
python -m pip install iree-compiler
python -m pip install iree-compiler==20240410.859
- name: Checkout repository
uses: actions/checkout@v2
- name: Initialize submodules
Expand Down
2 changes: 1 addition & 1 deletion .gitmodules
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[submodule "third_party/iree"]
path = third_party/iree
url = https://github.com/openxla/iree.git
url = https://github.com/iree-org/iree.git
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ If working in an existing repository then add the submodule and ensure it has
its submodules initialized:

```sh
$ git submodule add https://github.com/openxla/iree.git third_party/iree/
$ git submodule add https://github.com/iree-org/iree.git third_party/iree/
$ git submodule update --init --recursive
```

Expand All @@ -32,6 +32,7 @@ $ git \
-c submodule."third_party/llvm-project".update=none \
-c submodule."third_party/stablehlo".update=none \
-c submodule."third_party/torch-mlir".update=none \
-c submodule."third_party/torch-mlir".update=none \
submodule update --init --recursive
```

Expand All @@ -52,11 +53,11 @@ $ cmake --build build/ --target hello_world

### Compiling the Sample Module

This sample assumes that the latest IREE compiler release is installed and used
to compile the module. For many users upgrading their `iree-compiler` install
when they bump their submodule should be sufficient to ensure the compiler and
runtime are compatible. In the future the compiler and runtime will have more
support for version shifting.
This sample assumes that a compatible IREE compiler release is installed and
used to compile the module. For many users upgrading their `iree-compiler`
install when they bump their submodule should be sufficient to ensure the
compiler and runtime are compatible. In the future the compiler and runtime
will have more support for version shifting.

The sample currently assumes a CPU HAL driver and only produces a VMFB
supporting that. Additional compiler options can be used to change the target
Expand All @@ -67,7 +68,7 @@ can be accomplished with the `--iree-llvm-target-triple=` flag specifying the
CPU architecture.

```sh
$ python -m pip install iree-compiler --upgrade --user
$ python -m pip install iree-compiler==20240410.859 --upgrade --user
$ iree-compile \
--iree-hal-target-backends=llvm-cpu \
--iree-llvmcpu-target-triple=x86_64 \
Expand Down
2 changes: 1 addition & 1 deletion simple_mul.mlir
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
// framework (JAX, PyTorch, TFLite, etc).
//
// Refer to the documentation for frontend-specific instructions:
// https://openxla.github.io/iree/guides/ml-frameworks/
// https://iree.dev/guides/ml-frameworks/

// Simple elementwise multiply:
// %result = %lhs * %rhs
Expand Down

0 comments on commit d1ed1e3

Please sign in to comment.