From e13748602d5874709860d4b56b6a667112949a34 Mon Sep 17 00:00:00 2001 From: Milan Kordic Date: Sun, 3 Dec 2023 02:19:18 +0000 Subject: [PATCH] Add FAQ & Troubleshooting markdown --- FAQ.md | 18 ++++++++++++++++++ README.md | 7 ++++++- model_demos/README.md | 12 ------------ 3 files changed, 24 insertions(+), 13 deletions(-) create mode 100644 FAQ.md diff --git a/FAQ.md b/FAQ.md new file mode 100644 index 00000000..f8cdf5c1 --- /dev/null +++ b/FAQ.md @@ -0,0 +1,18 @@ +# FAQ & Troubleshooting Guide + +## Resetting an accelerator board + +If a Tenstorrent chip seems to hang and/or is producing unexpected behaviour, +you may try a software reset of the board. + +For Grayskull: `tt-smi -tr all` + +If the software reset does not work, unfortunately you will have to power cycle +the board. This usually means rebooting the host of a board. + +## `PermissionError` on `/tmp/*.lock` files + +If multiple users are running on a system with a shared Tenstorrent device, +you may encounter a `PermissionError: [Errno 13] Permission denied: '/tmp/*.lock'`. + +You would need to remove these files between user sessions. diff --git a/README.md b/README.md index 70bf0720..460ca97b 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ - [First 5 Things To-Do](#first-5-things-to-do) - [Model Demos](#model-demos) - [Documentation](#documentation) +- [FAQ & Troubleshooting](#faq--troubleshooting) - [Communication](#communication) ## Introduction @@ -36,8 +37,12 @@ For additional example code for running some popular AI/ML models, please visit Please refer to the [official documentation website](https://docs.tenstorrent.com/tenstorrent/). +## FAQ & Troubleshooting + +We keep a running FAQ & troubleshoot guide to help you quickly resolve some of the most common issues at [FAQ & Troubleshooting](FAQ.md). + ## Communication If you would like to formally propose a new feature, report a bug, or have issues with permissions, please file through [GitHub issues](https://github.com/tenstorrent/tt-buda/issues). -Please access the [Discord community](https://discord.gg/YkjMXthQ) forum for updates, tips, troubleshooting support, and more! +Please access the [Discord community](https://discord.gg/YkjMXthQ) forum for updates, tips, live troubleshooting support, and more! diff --git a/model_demos/README.md b/model_demos/README.md index 6af27622..7839b9e3 100644 --- a/model_demos/README.md +++ b/model_demos/README.md @@ -25,18 +25,6 @@ export PYTHONPATH=. python cv_demos/resnet/pytorch_resnet.py ``` -## Hardware troubleshooting - -### Resetting an accelerator board - -If a Tenstorrent chip seems to hang and/or is producing unexpected behaviour, -you may try a software reset of the board. - -For Grayskull: `tt-smi -tr all` - -If the software reset does not work, unfortunately you will have to power cycle -the board. This usually means rebooting the host of a board. - ## Models Support Table | **Model** | **Supported Hardware**
GS - Grayskull
WH - Wormhole |