Skip to content

Latest commit

 

History

History
127 lines (84 loc) · 3.88 KB

INSTALLING.md

File metadata and controls

127 lines (84 loc) · 3.88 KB
Raw

Install

These instructions will guide you through the installation of Tenstorrent system tools and drivers, followed by the installation of TT-Metalium and TT-NN.

Step 1. Driver & Firmware

Follow the Software Setup instructions for your specific board or system provided on our general docs.

If you have purchased a Grayskull card, you will find the instructions here.

Note the current compatability matrix:

Device OS Python Driver (TT-KMD) Firmware (TT-Flash) TT-SMI TT-Topology
Grayskull Ubuntu 20.04 3.8.10 v1.26 fw_pack-80.4.0.0_acec1267.tar.gz (v4.0.0) v2.1.0 or above N/A
Wormhole Ubuntu 20.04 3.8.10 v1.26 fw_pack-80.8.11.0.tar.gz (v80.8.11.0) v2.1.0 or above N/A
T3000 (Wormhole) Ubuntu 20.04 3.8.10 v1.26 fw_pack-80.8.11.0.tar.gz (v80.8.11.0) v2.1.0 or above v1.0.2 or above, mesh config

Step 2. System-level dependencies

sudo apt update
sudo apt install software-properties-common=0.99.9.12 build-essential=12.8ubuntu1.1 python3.8-venv=3.8.10-0ubuntu1~20.04.9 libgoogle-glog-dev=0.4.0-1build1 libyaml-cpp-dev=0.6.2-4ubuntu1 libboost-all-dev=1.71.0.0ubuntu2 libsndfile1=1.0.28-7ubuntu0.2 libhwloc-dev graphviz

Step 3. Huge Pages

  1. Download latest setup_hugepages.py script.
wget https://raw.githubusercontent.com/tenstorrent/tt-metal/main/infra/machine_setup/scripts/setup_hugepages.py
  1. Run first setup script.
sudo -E python3 setup_hugepages.py first_pass
  1. Reboot
sudo reboot now
  1. Run second setup script & check setup.
sudo -E python3 setup_hugepages.py enable && sudo -E python3 setup_hugepages.py check

Step 4. Build from source and start using TT-NN and TT-Metalium!

  1. Install git and git-lfs
sudo apt install git git-lfs
  1. Clone the repo.
git clone https://github.com/tenstorrent/tt-metal.git --recurse-submodules
cd tt-metal
git submodule foreach 'git lfs fetch --all && git lfs pull'
  1. Set up the environment variables. For Grayskull, use:
export ARCH_NAME=grayskull
export TT_METAL_HOME=$(pwd)
export PYTHONPATH=$(pwd)
export TT_METAL_ENV=dev

For Wormhole boards, use:

export ARCH_NAME=wormhole_b0
export TT_METAL_HOME=$(pwd)
export PYTHONPATH=$(pwd)
export TT_METAL_ENV=dev
  1. Build & activate

NEW!! CMake Support

./build_metal.sh

source python_env/bin/activate

Old Makefile Flow

make build

source build/python_env/bin/activate
  1. Start coding

You are all set! Visit the TT-NN Basic examples page or get started with simple kernels on TT-Metalium

Step 5. Software dependencies for codebase contributions

Please follow the next additional steps if you want to contribute to the codebase

  1. Install dependencies
sudo apt install clang-6.0=1:6.0.1-14 git git-lfs cmake=3.16.3-1ubuntu1.20.04.1 pandoc libtbb-dev libcapstone-dev pkg-config ninja-build

  1. Download and install Doxygen, (v1.9 or higher, but less than v1.10)

  2. Download and install gtest from source (v1.13)