#4076: Add instructions for execution for programming_examples and fi…

…x one typo
tenstorrent · Dec 4, 2023 · 94c2821 · 94c2821
1 parent bc59206
commit 94c2821
Show file tree

Hide file tree

Showing 6 changed files with 63 additions and 1 deletion.
diff --git a/docs/source/tt_metal/examples/dram_loopback.rst b/docs/source/tt_metal/examples/dram_loopback.rst
@@ -12,6 +12,18 @@ full example program in
 ``tt_metal/programming_examples/loopback/loopback.cpp``, so you can follow
 along.
 
+To build and execute, you may use the following commands. Note that we include
+the necessary environment variables here, but you may possibly need more
+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/programming_examples/loopback
+
 Silicon accelerator setup
 -------------------------
 

diff --git a/docs/source/tt_metal/examples/eltwise_binary.rst b/docs/source/tt_metal/examples/eltwise_binary.rst
@@ -11,6 +11,18 @@ previous examples. Note that we have this exact, full example program in
 ``tt_metal/programming_examples/eltwise_binary/eltwise_binary.cpp``, so you can
 follow along.
 
+To build and execute, you may use the following commands. Note that we include
+the necessary environment variables here, but you may possibly need more
+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/programming_examples/eltwise_binary
+
 New buffers
 -----------
 

diff --git a/docs/source/tt_metal/examples/eltwise_sfpu.rst b/docs/source/tt_metal/examples/eltwise_sfpu.rst
@@ -11,6 +11,18 @@ previous examples. Note that we have this exact, full example program in
 ``tt_metal/programming_examples/eltwise_sfpu/eltwise_sfpu.cpp``, so you can
 follow along.
 
+To build and execute, you may use the following commands. Note that we include
+the necessary environment variables here, but you may possibly need more
+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/programming_examples/eltwise_sfpu
+
 Circular buffers for data movement to/from compute engine
 ---------------------------------------------------------
 

diff --git a/docs/source/tt_metal/examples/matmul_multi_core.rst b/docs/source/tt_metal/examples/matmul_multi_core.rst
@@ -17,7 +17,19 @@ All important ways we use the API different are in the new
 ``matmul_multi_core`` function.
 
 The full example program is in
-``tt_metal/programming_examples/matmul_single_core/matmul_multi_core.cpp``
+``tt_metal/programming_examples/matmul_multi_core/matmul_multi_core.cpp``
+
+To build and execute, you may use the following commands. Note that we include
+the necessary environment variables here, but you may possibly need more
+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/programming_examples/matmul_multi_core
 
 Accessing all the cores
 -----------------------

diff --git a/docs/source/tt_metal/examples/matmul_single_core.rst b/docs/source/tt_metal/examples/matmul_single_core.rst
@@ -10,6 +10,18 @@ the propram.
 The full example program is in
 ``tt_metal/programming_examples/matmul_single_core/matmul_single_core.cpp``
 
+To build and execute, you may use the following commands. Note that we include
+the necessary environment variables here, but you may possibly need more
+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/programming_examples/matmul_single_core
+
 Host Code
 ---------
 

diff --git a/tt_metal/programming_examples/module.mk b/tt_metal/programming_examples/module.mk
@@ -13,6 +13,8 @@ include $(TT_METAL_HOME)/tt_metal/programming_examples/matmul_multi_core/module.
 include $(TT_METAL_HOME)/tt_metal/programming_examples/matmul_multicore_reuse/module.mk
 include $(TT_METAL_HOME)/tt_metal/programming_examples/matmul_multicore_reuse_mcast/module.mk
 
+# Need to depend on set_up_kernels.
+
 PROFILER_TESTS += \
 		  programming_examples/profiler/test_custom_cycle_count\
 		  programming_examples/profiler/test_full_buffer