Skip to content

Commit

Permalink
#0: Add notes about encouraging virtualenv in README + redirect users…
Browse files Browse the repository at this point in the history
… to hugepages section of cloud VM setup to complete setup their if they haven't done so yet by the hugepages section in README
  • Loading branch information
tt-rkim committed Jan 23, 2024
1 parent cb88dc9 commit 5d62c05
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,9 @@ For Wormhole B0:

The instructions for installing TTKMD, `tt-flash`, and `tt-smi` follow.

As a suggestion, please install the dependencies in a **virtual environment**
to ensure that your system Python installation does not get polluted.

#### Installing TTKMD (kernel-mode driver)

Please refer to the Tenstorrent [tt-kmd](https://github.com/tenstorrent/tt-kmd) page to get the specific version you need and install.
Expand Down Expand Up @@ -140,7 +143,11 @@ sudo -E python3 setup_hugepages.py enable && sudo -E python3 setup_hugepages.py

**NOTE**: You may have to repeat the hugepages steps upon every reboot, depending on your system and other services that use hugepages.

4. If you are a developer, you should also go through the [section](#installing-developer-dependencies) on developer dependencies, in addition to accelerator-level dependencies.
4. If you are working on a Tenstorrent cloud machine, you may have additional steps to complete Hugepages setup. Please refer to the [Hugepages section](https://github.com/tenstorrent-metal/metal-internal-workflows/wiki/Installing-Metal-development-dependencies-on-a-TT-Cloud-VM#installing-hugepages-extra-steps) in the cloud machine setup instructions and come back to this step to continue.

If you are not working on a Tenstorrent cloud machine, please skip this step and continue reading.

5. If you are a developer, you should also go through the [section](#installing-developer-dependencies) on developer dependencies, in addition to accelerator-level dependencies.

### Step 4. Installing developer dependencies

Expand Down

0 comments on commit 5d62c05

Please sign in to comment.