diff --git a/core/_static/assets/home/active-cooling-kit.png b/core/_static/assets/home/active-cooling-kit.png new file mode 100644 index 000000000..684dd6692 Binary files /dev/null and b/core/_static/assets/home/active-cooling-kit.png differ diff --git a/core/_static/assets/home/compliance.png b/core/_static/assets/home/compliance.png new file mode 100644 index 000000000..0e00a59ba Binary files /dev/null and b/core/_static/assets/home/compliance.png differ diff --git a/core/_static/assets/home/contact-us.png b/core/_static/assets/home/contact-us.png new file mode 100644 index 000000000..3bfde9fdb Binary files /dev/null and b/core/_static/assets/home/contact-us.png differ diff --git a/core/_static/assets/home/faq.png b/core/_static/assets/home/faq.png new file mode 100644 index 000000000..95a28041a Binary files /dev/null and b/core/_static/assets/home/faq.png differ diff --git a/core/_static/assets/home/grayskull.png b/core/_static/assets/home/grayskull.png new file mode 100644 index 000000000..e6be6f908 Binary files /dev/null and b/core/_static/assets/home/grayskull.png differ diff --git a/core/_static/assets/home/software-utilities.png b/core/_static/assets/home/software-utilities.png new file mode 100644 index 000000000..3f358076d Binary files /dev/null and b/core/_static/assets/home/software-utilities.png differ diff --git a/core/_static/assets/home/t1000.png b/core/_static/assets/home/t1000.png new file mode 100644 index 000000000..42bbd4595 Binary files /dev/null and b/core/_static/assets/home/t1000.png differ diff --git a/core/_static/assets/home/t7000.png b/core/_static/assets/home/t7000.png new file mode 100644 index 000000000..446dc5dd1 Binary files /dev/null and b/core/_static/assets/home/t7000.png differ diff --git a/core/_static/assets/home/tt-buda.png b/core/_static/assets/home/tt-buda.png new file mode 100644 index 000000000..d3fd9d50e Binary files /dev/null and b/core/_static/assets/home/tt-buda.png differ diff --git a/core/_static/assets/home/tt-loudbox.png b/core/_static/assets/home/tt-loudbox.png new file mode 100644 index 000000000..dc10b7eb0 Binary files /dev/null and b/core/_static/assets/home/tt-loudbox.png differ diff --git a/core/_static/assets/home/tt-metalium.png b/core/_static/assets/home/tt-metalium.png new file mode 100644 index 000000000..ecbb58d39 Binary files /dev/null and b/core/_static/assets/home/tt-metalium.png differ diff --git a/core/_static/assets/home/tt-mlir.png b/core/_static/assets/home/tt-mlir.png new file mode 100644 index 000000000..a6b831cbe Binary files /dev/null and b/core/_static/assets/home/tt-mlir.png differ diff --git a/core/_static/assets/home/tt-nn.png b/core/_static/assets/home/tt-nn.png new file mode 100644 index 000000000..5e2beba6f Binary files /dev/null and b/core/_static/assets/home/tt-nn.png differ diff --git a/core/_static/assets/home/tt-quietbox.png b/core/_static/assets/home/tt-quietbox.png new file mode 100644 index 000000000..c24a6223e Binary files /dev/null and b/core/_static/assets/home/tt-quietbox.png differ diff --git a/core/_static/assets/home/warp-100-bridge.png b/core/_static/assets/home/warp-100-bridge.png new file mode 100644 index 000000000..a50cf89da Binary files /dev/null and b/core/_static/assets/home/warp-100-bridge.png differ diff --git a/core/_static/assets/home/wormhole.png b/core/_static/assets/home/wormhole.png new file mode 100644 index 000000000..6c5000ec4 Binary files /dev/null and b/core/_static/assets/home/wormhole.png differ diff --git a/core/_static/assets/svg/arrowNE.svg b/core/_static/assets/svg/arrowNE.svg new file mode 100644 index 000000000..3af2c3f83 --- /dev/null +++ b/core/_static/assets/svg/arrowNE.svg @@ -0,0 +1,12 @@ + + + + \ No newline at end of file diff --git a/core/_templates/home.html b/core/_templates/home.html new file mode 100644 index 000000000..026f35f4e --- /dev/null +++ b/core/_templates/home.html @@ -0,0 +1,325 @@ + + + + Tenstorrent Documentation + + + +
+

Tenstorrent
Documentation

+ +
+

Getting Started

+
+ Welcome to Tenstorrent! This guide will walk you through setting up your + Tensix Processor, installing necessary software, and running your first + “Hello World” program. +
+ + Getting Started + + + + + +
+ +
+

Add-in Boards

+
+ + Grayskull™ +

Grayskull™

+ + + Wormhole™ +

Wormhole™

+ + + Warp 100 Bridge +

Warp 100 Bridge

+ + + Active Cooling Kit +

Active Cooling Kit

+ +
+
+ +
+

Systems

+
+ + TT-QuietBox +

TT-QuietBox

+ + + TT-LoudBox +

TT-LoudBox

+ + + T7000 +

T7000

+ + + T1000 +

T1000

+ +
+
+ +
+

Software

+
+ + TT-NN +

TT-NN

+ + + TT-Buda™ +

TT-Buda™

+ + + TT-Metalium™ +

TT-Metalium™

+ + + TT-MLIR +

TT-MLIR

+ +
+
+ +
+

Support

+
+ + FAQ +

FAQ

+ + + Compliance +

Compliance

+ + + Contact Us +

Contact Us

+ +
+
+
+ diff --git a/core/conf.py b/core/conf.py index a68bd1956..34254942e 100644 --- a/core/conf.py +++ b/core/conf.py @@ -8,7 +8,7 @@ import os project = 'Home' -copyright = '2024, Tenstorrent' +copyright = '2025, Tenstorrent' author = 'Tenstorrent' release = '1.0' @@ -25,7 +25,7 @@ html_theme = "sphinx_rtd_theme" html_logo = "../shared/images/tt_logo.svg" html_favicon = "../shared/images/favicon.png" -html_static_path = ['../shared/_static'] +html_static_path = ['../shared/_static', '_static/assets'] html_last_updated_fmt = "%b %d, %Y" html_context = { @@ -35,4 +35,4 @@ def setup(app): app.add_css_file("tt_theme.css") - + app.add_css_file("home.css") \ No newline at end of file diff --git a/core/quickstart.md b/core/getting-started/README.md similarity index 80% rename from core/quickstart.md rename to core/getting-started/README.md index a8e19c345..780a43097 100644 --- a/core/quickstart.md +++ b/core/getting-started/README.md @@ -21,14 +21,14 @@ Before you begin, ensure you have the following: - **Network access** to download software packages. - **Administrator privileges** on the host machine. -***NOTE**: The recommended OS for all Tenstorrent software is **Ubuntu 20.04 LTS (Focal Fossa)**. Each SDK may support newer distributions of Ubuntu; however, compatibility should be considered experimental at this time.* +**\*NOTE**: The recommended OS for all Tenstorrent software is **Ubuntu 20.04 LTS (Focal Fossa)**. Each SDK may support newer distributions of Ubuntu; however, compatibility should be considered experimental at this time.\* ## 2. Unboxing and Hardware Setup 1. **Unpack the hardware** and check all components against the provided list. 2. **Install the hardware** following the hardware installation manual and safety guidelines by product: - - [Add-In Boards / Cards](https://docs.tenstorrent.com/aibs/index.html) - - [Systems](https://docs.tenstorrent.com/systems/index.html) + - [Add-In Boards / Cards](https://docs.tenstorrent.com/aibs/index.html) + - [Systems](https://docs.tenstorrent.com/systems/index.html) 3. **Secure the hardware** in place, ensuring it is firmly seated and all connections are stable. ## 3. Software Installation @@ -43,15 +43,16 @@ This Starting Guide will reference each software utility where the latest versio Install git, wget, pip, and DKMS (Dynamic Kernel Module Support) by running the following command in your terminal according to your Linux distribution: -| Linux Distro | Installation Command | -|------------------------|-------------------------------------------------------------------------------------------| -| Debian, Ubuntu | `sudo apt update && sudo apt install -y wget git python3-pip dkms` | -| Fedora | `sudo dnf check-update && sudo dnf install -y wget git python3-pip dkms` | +| Linux Distro | Installation Command | +| ---------------------- | ------------------------------------------------------------------------------------------------------------ | +| Debian, Ubuntu | `sudo apt update && sudo apt install -y wget git python3-pip dkms` | +| Fedora | `sudo dnf check-update && sudo dnf install -y wget git python3-pip dkms` | | Enterprise Linux based | `sudo dnf install -y epel-release && sudo dnf check-update && sudo dnf install -y wget git python3-pip dkms` | -***NOTE**: Installation on non-Ubuntu distributions should be considered experimental at this time.* +**\*NOTE**: Installation on non-Ubuntu distributions should be considered experimental at this time.\* ### Step 2: Install the Kernel-Mode Driver (TT-KMD) + Install the driver (**[TT-KMD](https://github.com/tenstorrent/tt-kmd)**) by running these commands in the terminal: ```{code-block} bash @@ -74,9 +75,11 @@ To install **[TT-Flash](https://github.com/tenstorrent/tt-flash)**, run this com ```{code-block} bash pip install git+https://github.com/tenstorrent/tt-flash.git ``` -***NOTE:** If you are not using a Python virtual environment (venv), you may see an error `externally-managed-environment` when installing via `pip`. To resolve this, [create and/or activate a venv](https://docs.python.org/3/tutorial/venv.html) or use a tool like pipx.* + +**\*NOTE:** If you are not using a Python virtual environment (venv), you may see an error `externally-managed-environment` when installing via `pip`. To resolve this, [create and/or activate a venv](https://docs.python.org/3/tutorial/venv.html) or use a tool like pipx.\* #### Update Device Firmware + To update Tenstorrent device firmware using TT-Flash, run these commands in the terminal: ```{code-block} bash @@ -96,8 +99,8 @@ tt-flash --fw-tar fw_pack-80.13.2.0.fwbundle --force Then reboot the system. - ### Step 4: Setup HugePages + HugePages lets your system allocate dedicated memory to accelerate communication with Tenstorrent devices. Setup HugePages by running these commands in the terminal: ```{code-block} bash @@ -114,9 +117,10 @@ sudo systemctl enable --now 'dev-hugepages\x2d1G.mount' sudo reboot ``` -***NOTE:** This is a temporary solution for configuring hugepages. If the above fails, please check the latest available release from [TT-System-Tools](https://github.com/tenstorrent/tt-system-tools.git).* +**\*NOTE:** This is a temporary solution for configuring hugepages. If the above fails, please check the latest available release from [TT-System-Tools](https://github.com/tenstorrent/tt-system-tools.git).\* ### Step 5: Install the System Management Interface (TT-SMI) + Install the Tenstorrent Software Management Interface (**[TT-SMI](https://github.com/tenstorrent/tt-smi)**) by entering this command in the terminal: ``` @@ -131,7 +135,7 @@ Run the `tt-smi` utility. This should bring up a display that looks as below. -![tt-smi](./images/tt_smi.png) +![tt-smi](/images/tt_smi.png) This is the default mode where the user can see device information, telemetry, and firmware. If TT-smi runs without errors, congratulations! You're ready to use your Tenstorrent device. @@ -145,7 +149,7 @@ Tenstorrent provides three open-source SDKs for developing on Tensix Processors: Each SDK will have its own system dependency requirements and installation process. -To help you get started, check out these *First 5 Things* guides, which include installation steps, for TT-Buda and TT-Metalium. +To help you get started, check out these _First 5 Things_ guides, which include installation steps, for TT-Buda and TT-Metalium. - [First 5 Things](https://github.com/tenstorrent/tt-buda-demos/tree/main/first_5_steps) for **TT-Buda** - [First 5 Things](https://docs.tenstorrent.com/ttnn/latest/ttnn/get_started.html) for **TT-Metalium/TT-NN** diff --git a/core/index.rst b/core/index.rst index d1c454c41..faa66d4b3 100644 --- a/core/index.rst +++ b/core/index.rst @@ -1,14 +1,14 @@ Tenstorrent ============================== -.. include:: quickstart.md - :parser: myst_parser.sphinx_ +.. raw:: html + :file: _templates/home.html .. toctree:: :hidden: :caption: Getting Started - quickstart + getting-started/README .. toctree:: :hidden: diff --git a/pybuda/conf.py b/pybuda/conf.py index a0fad4fba..823318b70 100644 --- a/pybuda/conf.py +++ b/pybuda/conf.py @@ -3,7 +3,7 @@ # from ..conf import * project = 'TT Buda' -copyright = '2024, Tenstorrent' +copyright = '2025, Tenstorrent' author = 'Tenstorrent' root_doc = "toc" templates_path = ['../shared/_templates'] diff --git a/shared/_static/home.css b/shared/_static/home.css new file mode 100644 index 000000000..6bd34020c --- /dev/null +++ b/shared/_static/home.css @@ -0,0 +1,8 @@ +/* + For use in /core only (see /core/conf.py) + Hides sphinx generated homepage header (https://docs.tenstorrent.com/) +*/ + +#tenstorrent > h1 { + display: none !important; +} diff --git a/shared/example-conf.py b/shared/example-conf.py index 749a06045..2c6d7e259 100644 --- a/shared/example-conf.py +++ b/shared/example-conf.py @@ -8,7 +8,7 @@ import os project = 'Tenstorrent' -copyright = '2024, Tenstorrent' +copyright = '2025, Tenstorrent' author = 'Tenstorrent' templates_path = ['shared/_templates'] diff --git a/syseng/conf.py b/syseng/conf.py index f1f0d51a6..1f250be35 100644 --- a/syseng/conf.py +++ b/syseng/conf.py @@ -3,7 +3,7 @@ # from ..conf import * project = 'Software and Utilities' -copyright = '2024, Tenstorrent' +copyright = '2025, Tenstorrent' author = 'Tenstorrent' root_doc = "index" templates_path = ['../shared/_templates']