From 71cb582f2c2dbb672218419b0e03c58835139690 Mon Sep 17 00:00:00 2001 From: Emmanuel Ferdman Date: Wed, 11 Dec 2024 18:18:13 +0200 Subject: [PATCH] [skip ci] Update ttnn/tt-metalium docs references after separation (#15844) ### Ticket ### Problem description Small PR - Commit ac4a347549766c0632674763e4c12048f726e253 moved separated ttnn/tt-metalium docs. This PR adjusts sources to changes and fixes a few typos along the way. ### What's changed Describe the approach used to solve the problem. Summarize the changes made and its impact. ### Checklist - [x] Post commit CI passes - [ ] Blackhole Post commit (if applicable) - [ ] Model regression CI testing passes (if applicable) - [ ] Device performance regression CI testing passes (if applicable) - [ ] **(For models and ops writers)** Full [new models](https://github.com/tenstorrent/tt-metal/actions/workflows/full-new-models-suite.yaml) tests passes - [ ] New/Existing tests provide coverage for changes Signed-off-by: Emmanuel Ferdman --- CODEOWNERS | 2 +- CONTRIBUTING.md | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CODEOWNERS b/CODEOWNERS index 3b74d00a047..b683613df4f 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -165,7 +165,7 @@ models/perf/benchmarking_utils.py @skhorasganiTT # docs docs/Makefile @tenstorrent/metalium-developers-infra -docs/source/ttnn/dependencies/tt_lib.rst @eyonland @patrickroberts @yan-zaretskiy @ayerofieiev-tt +docs/source/ttnn/ttnn/dependencies/tt_lib.rst @eyonland @patrickroberts @yan-zaretskiy @ayerofieiev-tt docs/source/ttnn/ @eyonland @patrickroberts @yan-zaretskiy @ayerofieiev-tt @razorback3 @dongjin-na # misc diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e6b3a690fc2..ae1466f2aba 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -96,7 +96,7 @@ set up for users. Please refer to the [README](README.md) for source installation and environment setup instructions, then please read the [Getting Started -page](docs/source/get_started/get_started.rst). +page](docs/source/tt-metalium/get_started/get_started.rst). ### Setting logger level @@ -112,7 +112,7 @@ TT_METAL_LOGGER_LEVEL=Debug ./build/test/tt_metal/test_add_two_ints ### Building and viewing the documentation locally 1. First, ensure that you have [built the project and activated the Python -environment](docs/source/get_started/get_started.rst), along with any required +environment](docs/source/tt-metalium/get_started/get_started.rst), along with any required `PYTHONPATH` variables. 2. Build the HTML documentation. @@ -300,7 +300,7 @@ running such tests. - To debug the C++ binding file itself: - Ensure the python file you wish to debug is standalone and has a main function. - Run `gdb --args python ` - - Breakpoints can be added for future loaded libraries. For example, to add a breakpoint to `Device` object construtor: + - Breakpoints can be added for future loaded libraries. For example, to add a breakpoint to `Device` object constructor: ``` (gdb) b device.cpp:Device::Device No source file named device.cpp. @@ -353,7 +353,7 @@ TT_METAL_WATCHER=10 ./your_program - If no such error is reported, but the program is hanging, check the watcher log generated in `generated/watcher/watcher.log`. There is a legend at the top of the log showing how to interpret it, and a sample portion of a log is shown below: ``` Legend: - Comma separated list specifices waypoint for BRISC,NCRISC,TRISC0,TRISC1,TRISC2 + Comma separated list specifies waypoint for BRISC,NCRISC,TRISC0,TRISC1,TRISC2 I=initialization sequence W=wait (top of spin loop) R=run (entering kernel) @@ -528,7 +528,7 @@ To set up pre-commit on your local machine, follow these steps: on the link to [all post-commit workflows](https://github.com/tenstorrent/tt-metal/actions/workflows/all-post-commit-workflows.yaml), clicking "Run workflow", selecting your branch, and pressing "Run workflow". - ![Dropdown menu of all post-commit workflows and Run Workflow button](docs/source/_static/all-post-commit-workflows-button.png) + ![Dropdown menu of all post-commit workflows and Run Workflow button](docs/source/common/_static/all-post-commit-workflows-button.png) You can see the status of your CI run by clicking on the specific run you dispatched.