Skip to content

Commit

Permalink
Update build docs; Ubuntu 22.04 + Clang 17 (#332)
Browse files Browse the repository at this point in the history
* Update build docs; Ubuntu 22.04 + Clang 17

* updates
  • Loading branch information
nsmithtt authored Aug 9, 2024
1 parent b67fba8 commit 9a91dea
Showing 1 changed file with 9 additions and 15 deletions.
24 changes: 9 additions & 15 deletions docs/src/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,12 @@ cmake --build env/build
```bash
source env/activate
cmake -G Ninja -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++
cmake -G Ninja -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_C_COMPILER=clang-17 -DCMAKE_CXX_COMPILER=clang++-17
cmake --build build
```
> - To enable the ttnn/metal runtime add `-DTTMLIR_ENABLE_RUNTIME=ON`
> - Clang 17 is the minimum required version when enabling the runtime.
> - To enable the ttnn/metal perf runtime add `-DTT_RUNTIME_ENABLE_PERF_TRACE=ON` and `export ENABLE_TRACY=1` to environment before building
> - To accelerate the builds with ccache use `-DCMAKE_CXX_COMPILER_LAUNCHER=ccache`
> - To accelerate builds further, if python bindings aren't needed, `-DTTMLIR_ENABLE_BINDINGS_PYTHON=OFF`. For some reason the python bindings link step is very slow.
Expand All @@ -48,8 +49,8 @@ cmake --build build
| OS | Offline Compiler Only | Runtime Enabled Build | Runtime + Perf Enabled Build |
|----|-----------------------|-----------------------| -----------------------------|
| Ubuntu 22.04 || | |
| Ubuntu 20.04 || | |
| Ubuntu 22.04 || | |
| Ubuntu 20.04 || | |
| MacOS ||||

## Test
Expand Down Expand Up @@ -132,21 +133,14 @@ pip install seaborn

### Ubuntu 22.04

We need to install Ninja which can be done with the following command
On Ubuntu 22.04 we need to install clang, ninja, and to update the version of cmake because 3.20 is the minimum required for this project.

```bash
sudo apt install ninja-build
```

### Ubuntu 20.04

On Ubuntu 20.04 we need to install clang and to update the version of cmake because 3.20 is the minimum required for this project.
sudo apt update
sudo apt upgrade

```bash
sudo apt-get update
sudo apt-get upgrade

sudo apt-get install clang
sudo apt install clang-17
sudo apt install ninja-build

sudo apt remove cmake -y
pip3 install cmake --upgrade
Expand Down

0 comments on commit 9a91dea

Please sign in to comment.