tenstorrent / tt-metal

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

Add library level docs #183

Closed tt-rkim closed 1 year ago

tt-rkim commented 1 year ago

Docs:

Get started TT-metal (GOOD: host, kernel apis, prog ex, Graykull; DELETE: Prog Model; TO ADD: paper) Libraries

Frameworks

tt-rkim commented 1 year ago

@jvasilje Checked new pages into main

  1. When buliding, don't forget to a full make build then a full make all inside docs. Pybindings docs are built into code now, like our other docs
  2. First version of Tensor lib + Op lib (ttdnn) under "Libraries" > "ttmetal Python API (will become ttDNN)". Combined for now, but will split out into appropriate places once dir reorg is done
  3. TT-Dispatch stub under "Frameworks"
  4. Deleted unwanted docs + ready to add paper

Should be ready for review + use by David's team, if that's still the plan

tt-rkim commented 1 year ago

@abhullar-tt @coffeeandcheesecake @DrJessop Hey guys, per this issue, we now have docs for pybinded code. Right now, a good chunk of the device and tensor modules have docstrings. They're embedded directly into the pybindings code, and you can reference them with a automodule directive in Sphinx.

As part of future development processes, please add docstrings with argument tables if needed and add them into the docs.

tt-rkim commented 1 year ago

Must write examples/explanations in libraries docs in response to questions here: https://tenstorrent.sharepoint.com/:x:/r/sites/Jasmina/_layouts/15/Doc.aspx?sourcedoc=%7B5[…]action=editnew&cid=c78df972-bd33-4d07-b81d-045d36ff51a8

Per @jvasilje 's feedback from early users

tt-rkim commented 1 year ago

Closing this as initial version of docs is complete, and now future versions are iterative. ttDNN and Tensor libs will eventually be split out into separate ones once #182 is complete

jvasilje commented 1 year ago
image
jvasilje commented 1 year ago

our current doc hierarchy is this:

Docs hierarchy needs to be changed to this:

jvasilje commented 1 year ago

the indents got flattened. should look like this:

image
tt-rkim commented 1 year ago

@jvasilje Done pls review. some points to keep in mind