Updated README.md

mpc-msri · May 29, 2024 · a3fa0e1 · a3fa0e1
1 parent 27e5da6
commit a3fa0e1
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 5 deletions.
diff --git a/GPU-MPC/README.md b/GPU-MPC/README.md
@@ -11,7 +11,7 @@ This project requires NVIDIA GPUs, and assumes that GPU drivers and the [NVIDIA
 
 Please note that Sytorch requires CMake version >= 3.17 and the build will fail if this depency is not met. 
 
-The code uses CUTLASS version 2.11 by default, so if you change the CUDA version, please make sure that the CUTLASS version being built is compatible with the new CUDA version. To change the version of CUTLASS being built, add `git checkout <branch>;` after line 31 (`cd ext/cutlass;`) of setup.sh.
+The code uses CUTLASS version 2.11 by default, so if you change the CUDA version, please make sure that the CUTLASS version being built is compatible with the new CUDA version.
 
 The last line of `setup.sh` tries to install `matplotlib`, which is needed for generating Figures 5a and 5b. In our experience, the installation fails if the versions of Python and `pip` do not match. In case the installation fails, please install `matplotlib` manually before running `run_experiment.py`.
 
@@ -22,12 +22,24 @@ export CUDA_VERSION=11.7
 export GPU_ARCH=86
 ```
 
-2. Set up the environment
+2. Set up the environment. 
 
 ```
-sh setup.sh
+sh setup.sh <CUTLASS branch>
 ```
 
+To change the version of CUTLASS being built, optionally include the CUTLASS branch that should be built as
+
+```
+sh setup.sh <CUTLASS branch>
+```
+For example, to build the main branch, run
+
+```
+sh setup.sh main
+```
+
+
 3. Make Orca
 
 ```

diff --git a/GPU-MPC/experiments/orca/README.md b/GPU-MPC/experiments/orca/README.md
@@ -12,7 +12,7 @@ This project requires NVIDIA GPUs, and assumes that GPU drivers and the [NVIDIA
 
 Please note that Sytorch requires CMake version >= 3.17 and the build will fail if this depency is not met. 
 
-The code uses CUTLASS version 2.11 by default, so if you change the CUDA version, please make sure that the CUTLASS version being built is compatible with the new CUDA version. To change the version of CUTLASS being built, add `git checkout <branch>;` after line 31 (`cd ext/cutlass;`) of setup.sh.
+The code uses CUTLASS version 2.11 by default, so if you change the CUDA version, please make sure that the CUTLASS version being built is compatible with the new CUDA version.
 
 The last line of `setup.sh` tries to install `matplotlib`, which is needed for generating Figures 5a and 5b. In our experience, the installation fails if the versions of Python and `pip` do not match. In case the installation fails, please install `matplotlib` manually before running `run_experiment.py`.
 
@@ -29,6 +29,17 @@ export GPU_ARCH=86
 sh setup.sh
 ```
 
+To change the version of CUTLASS being built, optionally include the CUTLASS branch that should be built as
+
+```
+sh setup.sh <CUTLASS branch>
+```
+For example, to build the main branch, run
+
+```
+sh setup.sh main
+```
+
 3. Make Orca
 
 ```

diff --git a/GPU-MPC/experiments/sigma/README.md b/GPU-MPC/experiments/sigma/README.md
@@ -11,7 +11,7 @@ This project requires NVIDIA GPUs, and assumes that GPU drivers and the [NVIDIA
 
 Please note that Sytorch requires CMake version >= 3.17 and the build will fail if this depency is not met. 
 
-The code uses CUTLASS version 2.11 by default, so if you change the CUDA version, please make sure that the CUTLASS version being built is compatible with the new CUDA version. To change the version of CUTLASS being built, add `git checkout <branch>;` after line 31 (`cd ext/cutlass;`) of setup.sh.
+The code uses CUTLASS version 2.11 by default, so if you change the CUDA version, please make sure that the CUTLASS version being built is compatible with the new CUDA version.
 
 The last line of `setup.sh` tries to install `matplotlib`, which is needed for generating Figure 10. In our experience, the installation fails if the versions of Python and `pip` do not match. In case the installation fails, please install `matplotlib` manually before running `run_experiment.py`.
 
@@ -28,6 +28,17 @@ export GPU_ARCH=86
 sh setup.sh
 ```
 
+To change the version of CUTLASS being built, optionally include the CUTLASS branch that should be built as
+
+```
+sh setup.sh <CUTLASS branch>
+```
+For example, to build the main branch, run
+
+```
+sh setup.sh main
+```
+
 3. Make SIGMA
 
 ```