From 5d62c052da23e0f553720592aec6f817eeaa942f Mon Sep 17 00:00:00 2001 From: Raymond Kim Date: Tue, 23 Jan 2024 14:45:35 -0500 Subject: [PATCH] #0: Add notes about encouraging virtualenv in README + redirect users to hugepages section of cloud VM setup to complete setup their if they haven't done so yet by the hugepages section in README --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 64be3089363..058e2a1caa9 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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