ROCm / Tensile

Stretching GPU performance for GEMMs and tensor contractions.
MIT License
220 stars 149 forks source link

Creating Tensile Documentation #1999

Closed SwRaw closed 1 month ago

SwRaw commented 3 months ago

Updates style, grammar, and clarity of Tensile's ROCm docs, and migrates important files from the Wiki.

bstefanuk commented 2 months ago

@SwRaw changes are looking good. Once you apply the comments, please resolve the items and I'll do a final review.

pghysels commented 2 months ago

Sorry, I'm confused. Where is documentation hosted? It's not the same as the wiki on github? I found these: https://alt-doc-doc-test.readthedocs.io/en/latest/ROCm_Tools/tensile.html https://new-documentation.readthedocs.io/en/latest/ROCm_Tools/tensile.html#contributing which are also different?

bstefanuk commented 2 months ago

Sorry, I'm confused. Where is documentation hosted? It's not the same as the wiki on github?

@pghysels We're in the process of moving Tensile's Wiki into ROCm docs. As a part of this effort, we're working on restructuring some of the documents to match other library standards. The links you provided appear to be generated from the Wiki content, but I'm not familiar with who has published these, I suspect they're unofficial.

Until this migration is complete, the official AMD docs are hosted privately.

SwRaw commented 2 months ago

Sorry, I'm confused. Where is documentation hosted? It's not the same as the wiki on github? I found these: https://alt-doc-doc-test.readthedocs.io/en/latest/ROCm_Tools/tensile.html https://new-documentation.readthedocs.io/en/latest/ROCm_Tools/tensile.html#contributing which are also different?

You can see the docs here: https://advanced-micro-devices-demo--1999.com.readthedocs.build/projects/Tensile/en/1999/src/index.html

bstefanuk commented 2 months ago

@SwRaw A few things I noticed regarding the following picture of the side bar: image

Can we move the CLI reference dropdown outside of the API reference please. Also, let's make API reference a drop-down too and nest them both under the Reference section.

SwRaw commented 2 months ago

@bstefanuk I am struggling to create the nested TOC structure as requested by you. Let me know if you have any idea on how to nest captions.