diff --git a/README.md b/README.md index cab42480c5a..80dc296d03c 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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., 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/ - ``` + 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., 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/ + git checkout + ``` +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 diff --git a/docs/README.md b/docs/README.md index 0be41a3c858..17e5ebbf1d8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 @@ -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., 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/ - ``` + 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., 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/ + git checkout + ``` +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