Skip to content

Update documentation for installation #2808

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hunhoffe merged 4 commits into from
Jan 14, 2026
Merged

Update documentation for installation #2808

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
22e5899
Update documentation for installation
hunhoffe Jan 12, 2026
b602d17
Clean up formatting a bit more
hunhoffe Jan 12, 2026
937d3d2
fix formatting more
hunhoffe Jan 12, 2026
a001b28
Merge branch 'main' into versioning-documentation
hunhoffe Jan 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 28 additions & 22 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Turn off SecureBoot (Allows for unsigned drivers to be installed):
> [0000:66:00.1] : NPU Strix
> ```

IRON requires that `xrt-smi` be in your path.
IRON requires that `xrt-smi` and associated tools be in your path.

### Install IRON and MLIR-AIE Prerequisites

Expand Down Expand Up @@ -109,34 +109,40 @@ Turn off SecureBoot (Allows for unsigned drivers to be installed):
python3 -m pip install --upgrade pip
```

1. Install IRON library, mlir-aie and llvm-aie compilers from wheels and dependencies:
1. Install IRON library by installing the `mlir-aie` wheels:

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).
For installing the `mlir-aie` wheels, there are 3 options. Note that for whichever path you take,
it is important to sync the `mlir-aie` wheels version, the github repo commit, and the requirements versions.
If you install from something other than the latest wheels, make sure
you use the repo commit -- and installation instructions -- from that point in time.

```bash
# Install IRON library and mlir-aie from a specific release,
# e.g., <verison> in the following command could be replaced with v1.1.3
python3 -m pip install mlir_aie -f https://github.com/Xilinx/mlir-aie/releases/expanded_assets/<version>
```
1. **Latest:** For the latest wheels (not necessarily a release):
```bash
# Install IRON library and mlir-aie from the latest wheel
python3 -m pip install mlir_aie -f https://github.com/Xilinx/mlir-aie/releases/expanded_assets/latest-wheels-2
```

Alternatively, you can install the latest released version of `mlir-aie`.
```bash
# Get the latest release version
latest_tag_with_v=$(curl -s "https://api.github.com/repos/Xilinx/mlir-aie/releases/latest" | jq -r '.tag_name')
latest_tag="${latest_tag_with_v#v}"
1. **Latest Release:** Alternatively, you can install the latest released version of `mlir-aie`.
```bash
# Get the latest release version
latest_tag_with_v=$(curl -s "https://api.github.com/repos/Xilinx/mlir-aie/releases/latest" | jq -r '.tag_name')
latest_tag="${latest_tag_with_v#v}"

# Install IRON library and mlir-aie from the latest stable release
python3 -m pip install mlir_aie==${latest_tag} -f https://github.com/Xilinx/mlir-aie/releases/expanded_assets/${latest_tag_with_v}
```
# Install IRON library and mlir-aie from the latest stable release
python3 -m pip install mlir_aie==${latest_tag} -f https://github.com/Xilinx/mlir-aie/releases/expanded_assets/${latest_tag_with_v}
git checkout $latest_tag_with_v
```

For the latest wheels (not necessarily a release):
```bash
# Install IRON library and mlir-aie from the latest wheel
python3 -m pip install mlir_aie -f https://github.com/Xilinx/mlir-aie/releases/expanded_assets/latest-wheels-2
```
1. **Any Release:** 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).

You will also need to install the `llvm-aie` wheel for the Peano compiler and the `mlir-aie` python extras.
```bash
# Install IRON library and mlir-aie from a specific release,
# e.g., <verison> in the following command could be replaced with v1.1.3
python3 -m pip install mlir_aie -f https://github.com/Xilinx/mlir-aie/releases/expanded_assets/<version>
git checkout <version>
```

1. Install the Peano compiler (the `llvm-aie` wheels) and dependencies:
```bash
# Install Peano from llvm-aie wheel
python3 -m pip install llvm-aie -f https://github.com/Xilinx/llvm-aie/releases/expanded_assets/nightly
Expand Down
50 changes: 28 additions & 22 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Turn off SecureBoot (Allows for unsigned drivers to be installed):
> [0000:66:00.1] : NPU Strix
> ```

IRON requires that `xrt-smi` be in your path.
IRON requires that `xrt-smi` and associated tools be in your path.

### Install IRON and MLIR-AIE Prerequisites

Expand Down Expand Up @@ -97,34 +97,40 @@ Turn off SecureBoot (Allows for unsigned drivers to be installed):
python3 -m pip install --upgrade pip
```

1. Install IRON library, mlir-aie and llvm-aie compilers from wheels and dependencies:
1. Install IRON library by installing the `mlir-aie` wheels:

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).
For installing the `mlir-aie` wheels, there are 3 options. Note that for whichever path you take,
it is important to sync the `mlir-aie` wheels version, the github repo commit, and the requirements versions.
If you install from something other than the latest wheels, make sure
you use the repo commit -- and installation instructions -- from that point in time.

```bash
# Install IRON library and mlir-aie from a specific release,
# e.g., <verison> in the following command could be replaced with v1.1.3
python3 -m pip install mlir_aie -f https://github.com/Xilinx/mlir-aie/releases/expanded_assets/<version>
```
1. **Latest:** For the latest wheels (not necessarily a release):
```bash
# Install IRON library and mlir-aie from the latest wheel
python3 -m pip install mlir_aie -f https://github.com/Xilinx/mlir-aie/releases/expanded_assets/latest-wheels-2
```

Alternatively, you can install the latest released version of `mlir-aie`.
```bash
# Get the latest release version
latest_tag_with_v=$(curl -s "https://api.github.com/repos/Xilinx/mlir-aie/releases/latest" | jq -r '.tag_name')
latest_tag="${latest_tag_with_v#v}"
1. **Latest Release:** Alternatively, you can install the latest released version of `mlir-aie`.
```bash
# Get the latest release version
latest_tag_with_v=$(curl -s "https://api.github.com/repos/Xilinx/mlir-aie/releases/latest" | jq -r '.tag_name')
latest_tag="${latest_tag_with_v#v}"

# Install IRON library and mlir-aie from the latest stable release
python3 -m pip install mlir_aie==${latest_tag} -f https://github.com/Xilinx/mlir-aie/releases/expanded_assets/${latest_tag_with_v}
```
# Install IRON library and mlir-aie from the latest stable release
python3 -m pip install mlir_aie==${latest_tag} -f https://github.com/Xilinx/mlir-aie/releases/expanded_assets/${latest_tag_with_v}
git checkout $latest_tag_with_v
```

For the latest wheels (not necessarily a release):
```bash
# Install IRON library and mlir-aie from the latest wheel
python3 -m pip install mlir_aie -f https://github.com/Xilinx/mlir-aie/releases/expanded_assets/latest-wheels-2
```
1. **Any Release:** 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).

You will also need to install the `llvm-aie` wheel for the Peano compiler and MLIR Python extras.
```bash
# Install IRON library and mlir-aie from a specific release,
# e.g., <verison> in the following command could be replaced with v1.1.3
python3 -m pip install mlir_aie -f https://github.com/Xilinx/mlir-aie/releases/expanded_assets/<version>
git checkout <version>
```

1. Install the Peano compiler (the `llvm-aie` wheels) and dependencies:
```bash
# Install Peano from llvm-aie wheel
python3 -m pip install llvm-aie -f https://github.com/Xilinx/llvm-aie/releases/expanded_assets/nightly
Expand Down
Loading