Skip to content

Commit

Permalink
Explain building runtime for a specified arch (#108)
Browse files Browse the repository at this point in the history
Explained how to build the runtime for a specified architecture
via ARCH_NAME environment variable, and related conditions.
  • Loading branch information
rjakovljevicTT authored Jul 9, 2024
1 parent c0b43fc commit 497a412
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/src/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,15 @@ cmake --build build
> - To enable the ttnn/metal runtime add `-DTTMLIR_ENABLE_RUNTIME=ON`
> - 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.
> - TTNN build is automatically integrated / handled by tt-mlir cmake build system. For debugging and further information regarding the TTNN backend build step, please refer to [TTNN Documentation](https://tenstorrent.github.io/tt-metal/latest/ttnn/ttnn/installing.html)
> - TTNN build is automatically integrated / handled by tt-mlir cmake build system. For debugging and further information regarding the TTNN backend build step, please refer to [TTNN Documentation](https://tenstorrent.github.io/tt-metal/latest/ttnn/ttnn/installing.html).
> - The runtime build step depends on the `ARCH_NAME` environment variable, which is set in the `env/activate` script.
> If you want to build the runtime for a different architecture, please set `ARCH_NAME` to the desired value
> (one of `grayskull`, `wormhole_b0`, or `blackhole`).
> Please note that the runtime is built only if `TTMLIR_ENABLE_RUNTIME=ON`.
> - In addition to `ARCH_NAME`, the runtime build depends on `TT_METAL_HOME` variable,
> which is also set in `env/activate` script.
> For more information, please refer to
> [TT-NN and TT-Metailium installation documentation](https://tenstorrent.github.io/tt-metal/latest/ttnn/ttnn/installing.html#step-4-install-and-start-using-tt-nn-and-tt-metalium).
| OS | Offline Compiler Only | Runtime Enabled Build |
|----|-----------------------|-----------------------|
Expand Down

0 comments on commit 497a412

Please sign in to comment.