Closed tt-rkim closed 1 year ago
@jvasilje Checked new pages into main
make build
then a full make all
inside docs
. Pybindings docs are built into code now, like our other docsShould be ready for review + use by David's team, if that's still the plan
@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.
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
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
our current doc hierarchy is this:
Docs hierarchy needs to be changed to this:
Getting Started
TT-Metal
-- APIs
--- Host APIs
--- Kernel APIs
-- Programming examples
-- dram loopback
-- eltwise binary
-- Tools
--- debug tools
--- performance measurement tools
Libraries -- Tensor ---Overview --- APIs -- ttDNN --- Overview --- APIs
Frameworks -- TT-Dispatch --- Overview
the indents got flattened. should look like this:
@jvasilje Done pls review. some points to keep in mind
ttmetal
pybindings build, "Tensor" and "ttDNN" are still one python module despite our future narrative push of labelling them two separate libraries
Docs:
Get started TT-metal (GOOD: host, kernel apis, prog ex, Graykull; DELETE: Prog Model; TO ADD: paper) Libraries
Frameworks