Merge branch 'main' into shwetankTT/temp_fix_rn50

tenstorrent · May 30, 2024 · 60a238b · 60a238b
2 parents bec3cd4 + ae26f1e
commit 60a238b
Show file tree

Hide file tree

Showing 93 changed files with 230 additions and 2,176 deletions.
diff --git a/.github/actions/stress-build-and-run/action.yml b/.github/actions/stress-build-and-run/action.yml
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -11,7 +11,6 @@ Table of Contents
     - [Setting up Git](#setting-up-git)
     - [Setting logger level](#setting-logger-level)
     - [Building and viewing the documentation locally](#building-and-viewing-the-documentation-locally)
-    - [Cleaning the dev environment with `make nuke`](#cleaning-the-dev-environment-with-make-nuke)
   - [Tests in tt-metal](#tests-in-tt-metal)
     - [Running post-commit regressions](#running-post-commit-regressions)
     - [Adding post-commit tests](#adding-post-commit-tests)
@@ -174,14 +173,6 @@ $ cd ${TT_METAL_HOME} && ./docs/spellcheck.sh update
 Commit your changes and the personal dictionary, at docs/aspell-dictionary.pws,
 that is changed.
 
-### Cleaning the dev environment with `make nuke`
-
-Normally, `make clean` only clears out build artifacts. It does **not** delete
-the built Python dev environment stored at `build/python_env/`.
-
-To delete absolutely everything including the Python environment, use `make
-nuke`.
-
 ## Tests in tt-metal
 
 Ensure you're in a developer Python environment with necessary environment variables
@@ -201,8 +192,8 @@ You must run post-commit regressions before you commit something.
 These regressions will also run after every pushed commit to the GitHub repo.
 
 ```
-make build
-make tests
+cmake --build build --target install
+cmake --build build --target tests
 ./tests/scripts/run_tests.sh --tt-arch $ARCH_NAME --pipeline-type post_commit
 ```
 
@@ -252,7 +243,7 @@ a specific one you'd like to run.
 
 1. Build the API integration tests using the make command,
 ```
-make tests
+cmake --build build --target tests
 ```
 2. Run the test binaries from the path **${TT_METAL_HOME}/build/test/tt_metal**
 
@@ -268,7 +259,7 @@ fast dispatch, you can
 
 1. Build the unit tests:
    ```
-   make tests
+   cmake --build build --target tests
    ```
 2. Run the test:
    ```

diff --git a/INSTALLING.md b/INSTALLING.md
@@ -97,7 +97,8 @@ export TT_METAL_ENV=dev
 
 4. Build & activate.
 
-NEW!! CMake Support
+We use CMake for our build flows.
+
 ```sh
 ./build_metal.sh
 
@@ -110,13 +111,6 @@ Note about Python environments: You do not have to use `create_venv.sh`. If you
 are less familiar with Python and its various environment tools, just use
 `create_venv.sh` as shown above.
 
-Old Makefile Flow
-```sh
-make build
-
-source build/python_env/bin/activate
-```
-
 5. Start coding
 
 You are all set! Visit the [TT-NN Basic examples page](https://tenstorrent.github.io/tt-metal/latest/ttnn/ttnn/usage.html#basic-examples) or get started with [simple kernels on TT-Metalium](https://github.com/tenstorrent/tt-metal/blob/main/README.md)

diff --git a/Makefile b/Makefile
diff --git a/docs/source/tt-metalium/tt_metal/examples/dram_loopback.rst b/docs/source/tt-metalium/tt_metal/examples/dram_loopback.rst
@@ -20,8 +20,7 @@ depending on the most up-to-date installation methods.
 
     export ARCH_NAME=<arch name>
     export TT_METAL_HOME=<this repo dir>
-    make build
-    make programming_examples/loopback
+    ./build_metal.sh
     ./build/programming_examples/loopback
 
 Silicon accelerator setup

diff --git a/docs/source/tt-metalium/tt_metal/examples/eltwise_binary.rst b/docs/source/tt-metalium/tt_metal/examples/eltwise_binary.rst
@@ -19,8 +19,7 @@ depending on the most up-to-date installation methods.
 
     export ARCH_NAME=<arch name>
     export TT_METAL_HOME=<this repo dir>
-    make build
-    make programming_examples/eltwise_binary
+    ./build_metal.sh
     ./build/programming_examples/eltwise_binary
 
 New buffers

diff --git a/docs/source/tt-metalium/tt_metal/examples/eltwise_sfpu.rst b/docs/source/tt-metalium/tt_metal/examples/eltwise_sfpu.rst
@@ -19,8 +19,7 @@ depending on the most up-to-date installation methods.
 
     export ARCH_NAME=<arch name>
     export TT_METAL_HOME=<this repo dir>
-    make build
-    make programming_examples/eltwise_sfpu
+    ./build_metal.sh
     ./build/programming_examples/eltwise_sfpu
 
 Circular buffers for data movement to/from compute engine

diff --git a/docs/source/tt-metalium/tt_metal/examples/matmul_multi_core.rst b/docs/source/tt-metalium/tt_metal/examples/matmul_multi_core.rst
@@ -27,8 +27,7 @@ depending on the most up-to-date installation methods.
 
     export ARCH_NAME=<arch name>
     export TT_METAL_HOME=<this repo dir>
-    make build
-    make programming_examples/matmul_multi_core
+    ./build_metal.sh
     ./build/programming_examples/matmul_multi_core
 
 Accessing all the cores

diff --git a/docs/source/tt-metalium/tt_metal/examples/matmul_multi_core_optimized.rst b/docs/source/tt-metalium/tt_metal/examples/matmul_multi_core_optimized.rst
@@ -9,8 +9,7 @@ The Tensix core architecture's secret weapon is its full user control over memor
 
     export ARCH_NAME=<arch name>
     export TT_METAL_HOME=<this repo dir>
-    make build
-    make programming_examples/matmul_multi_core
+    ./build_metal.sh
     ./build/programming_examples/matmul_multi_core_reuse
     ./build/programming_examples/matmul_multi_core_reuse_mcast
 

diff --git a/docs/source/tt-metalium/tt_metal/examples/matmul_single_core.rst b/docs/source/tt-metalium/tt_metal/examples/matmul_single_core.rst
@@ -18,8 +18,7 @@ depending on the most up-to-date installation methods.
 
     export ARCH_NAME=<arch name>
     export TT_METAL_HOME=<this repo dir>
-    make build
-    make programming_examples/matmul_single_core
+    ./build_metal.sh
     ./build/programming_examples/matmul_single_core
 
 Host Code

diff --git a/infra/git_hooks/module.mk b/infra/git_hooks/module.mk
diff --git a/models/utility_functions.py b/models/utility_functions.py
@@ -117,6 +117,9 @@ def enable_persistent_kernel_cache():
     """
     Enables persistent compiled kernel caching - disables recompiling the kernels for the duration of running process if built_kernels/.../hash directory with kernel binaries is present.
     """
+    logger.warning(
+        "Persistent kernel cache is enabled. Cache invalidation may fail after a rebase and may require deleting the build directory."
+    )
     tt_lib.device.EnablePersistentKernelCache()
 
 

diff --git a/module.mk b/module.mk
diff --git a/tests/module.mk b/tests/module.mk