Skip to content

Commit ddf9453

Browse files
authored
Update documentation on using wheels in README (#2729)
1 parent c5222f5 commit ddf9453

1 file changed

Lines changed: 18 additions & 23 deletions

File tree

README.md

Lines changed: 18 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -111,38 +111,33 @@ Turn off SecureBoot (Allows for unsigned drivers to be installed):
111111

112112
1. Install IRON library, mlir-aie and llvm-aie compilers from wheels and dependencies:
113113

114-
For release v1.1.0:
115-
```bash
116-
# Install IRON library and mlir-aie from a wheel
117-
python3 -m pip install mlir_aie -f https://github.com/Xilinx/mlir-aie/releases/expanded_assets/v1.1.0
118-
119-
# Install Peano from a llvm-aie wheel
120-
python3 -m pip install https://github.com/Xilinx/llvm-aie/releases/download/nightly/llvm_aie-20.0.0.2025090701+8c084497-py3-none-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
114+
You can install a specific version of `mlir-aie` from the release wheels. To see available versions, check out the [release page](https://github.com/Xilinx/mlir-aie/releases).
121115

122-
# Install MLIR Python Extras
123-
HOST_MLIR_PYTHON_PACKAGE_PREFIX=aie python3 -m pip install -r python/requirements_extras.txt
124-
```
125-
126-
For release v1.0:
127116
```bash
128-
# Install IRON library and mlir-aie from a wheel
129-
python3 -m pip install mlir_aie -f https://github.com/Xilinx/mlir-aie/releases/expanded_assets/v1.0
130-
131-
# Install Peano from a llvm-aie wheel
132-
python3 -m pip install https://github.com/Xilinx/llvm-aie/releases/download/nightly/llvm_aie-19.0.0.2025041501+b2a279c1-py3-none-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
117+
# Install IRON library and mlir-aie from a specific release,
118+
# e.g., <verison> in the following command could be replaced with v1.1.3
119+
python3 -m pip install mlir_aie -f https://github.com/Xilinx/mlir-aie/releases/expanded_assets/<version>
120+
```
133121

134-
# Install basic Python requirements (still needed for release v1.0, but is no longer needed for latest wheels)
135-
python3 -m pip install -r python/requirements.txt
122+
Alternatively, you can install the latest released version of `mlir-aie`.
123+
```bash
124+
# Get the latest release version
125+
latest_tag_with_v=$(curl -s "https://api.github.com/repos/Xilinx/mlir-aie/releases/latest" | jq -r '.tag_name')
126+
latest_tag="${latest_tag_with_v#v}"
136127
137-
# Install MLIR Python Extras
138-
HOST_MLIR_PYTHON_PACKAGE_PREFIX=aie python3 -m pip install -r python/requirements_extras.txt
128+
# Install IRON library and mlir-aie from the latest stable release
129+
python3 -m pip install mlir_aie==${latest_tag} -f https://github.com/Xilinx/mlir-aie/releases/expanded_assets/${latest_tag_with_v}
139130
```
140131

141-
For daily latest:
132+
For the latest wheels (not necessarily a release):
142133
```bash
143-
# Install IRON library and mlir-aie from a wheel
134+
# Install IRON library and mlir-aie from the latest wheel
144135
python3 -m pip install mlir_aie -f https://github.com/Xilinx/mlir-aie/releases/expanded_assets/latest-wheels-2
136+
```
137+
138+
You will also need to install the `llvm-aie` wheel for the Peano compiler and the `mlir-aie` python extras.
145139

140+
```bash
146141
# Install Peano from llvm-aie wheel
147142
python3 -m pip install llvm-aie -f https://github.com/Xilinx/llvm-aie/releases/expanded_assets/nightly
148143

0 commit comments

Comments
 (0)