This repository contains the code that interacts with Tenstorrent hardware to provide lower level functionalities. It should be automatically built as part of buda, meanwhile you may also build and test the individual modules.

Build

Setting up Docker container

It is highly recommended that you build and run buda within a container. Please refer to the documentation in pybuda.

Steps

1. Checkout the submodules.

git submodule update --init --recursive

2. Set up environment variables properly and run make. ARCH_NAME should be the name of the architecture of your Tenstorrent hardware, e.g. "grayskull". By default, the code is built in release mode. If necessary, you may use other values of CONFIG, including assert, debug, etc. A typical build command looks like:

export ARCH_NAME=grayskull

# Build backend
make -j16 build_hw

# Build a test runner
make -j16 verif/netlist_test

3. Clean up.

make clean

Running tests

Here are the commands to build budabackend and run a simple test on a grayskull board:

export ARCH_NAME=grayskull
make -j16 build_hw
make -j16 verif/graph_tests
./build/test/verif/graph_tests/test_graph --netlist verif/graph_tests/netlists/netlist_softmax_single_tile.yaml --silicon

Formatting C++ code with clang-format

Installing clang-format

If you're using an IRD docker, clang-format 19 should be already available. If you don't have clang-format in your working environment, follow the instructions on llvm website for installing it.

Formatting files

If working with VSCode, you can copy the provided default settings:

cp .vscode/default.settings.json .vscode/settings.json

From now on, c++ files will be formatted on save (given that clang-format is available).

If you want to format the whole repo, you can use this script:

ci/clang-format-repo.sh

Git pre-commit hook

You can link the existing script as a pre-commit hook, which will block the commit if the code is not properly formatted:

ln -s ../../ci/pre-commit.sh .git/hooks/pre-commit