tenstorrent / tt-metal

:metal: TT-NN operator library, and TT-Metalium low level kernel programming model.
Apache License 2.0
303 stars 25 forks source link

[Feature Request] Documentation on invoking tt_metal compiler #9156

Open jleidel opened 4 weeks ago

jleidel commented 4 weeks ago

Is your feature request related to a problem? Please describe. There doesn't appear to be any documentation on how one invokes the tt_metal compilation flow. We are not interested in using any of your examples or any of your included CMake scripts.

Describe the solution you'd like We would like to see a basic Makefile that resides in a separate source tree that invokes a simple example

Describe alternatives you've considered Since there are no functional examples, there are no alternatives.

Additional context I think this request is relatively clear

tt-rkim commented 3 weeks ago

We currently don't have a separate repo that specifically shows an example using Make and tt-metal as a dependency. From the context of your issue, I'm going to assume you're talking specifically about the Metalium C++ runtime API + not too interested in the ML Python API (ttnn).

We are trying to actively make this better. We do have longer-term plans to release the Metalium runtime headers and shared object in various distribution forms such as Conda and RPM. We can also create example repos as you describe for not only Make, but also other build systems like CMake. We can update this issue as we progress.

This is an example from the community by @marty1885 : https://github.com/marty1885/ttVecAdd

marty1885 commented 3 weeks ago

Related issue: #7914

BTW, my CMake code assumes Metalum is compiled with the same version of fmt as the system. Which may not be the case. I need to fix it when I have time. But the current code works well enough.