mirror of
https://github.com/ROCm/composable_kernel.git
synced 2026-05-05 14:11:29 +00:00
cb3fac4d2a
* New docs directory with minimal config * Based on docs directory of rocBLAS * Config for running Doxygen then Sphinx to generate HTML * Add minimal content - intro to doc * Add some boilerplate sections to doc * content still needs to be done, * e.g., need to generate API documentation using Doxygen * need to write contributor guide * Start Softmax section of Support Primitives doc * Written as a test bed for typesetting math content * Need to decide how much detail to go into * add doc directories to git ignore file. * Minor edits - new line at EOF, change year in copyright notices * Port Markdown files to ReStructuredText * Copy Markdown files from pre-existing doc directory to docs directory * Convert to reStructured Text (rst) - section headings, links, tables have a different syntax in rst * New rst files added to index - can generate HTML with same style as HTML generated from rst files in previous commits * Intention is to make all the content in doc redundant and use rst throughout rather than mix of md and rst * Extend Softmax section of Primitives Guide * rename l to z * add material on applying softmax row-wise to matrix * define macro for diag operator (represents diagonal matrix) --------- Co-authored-by: zjing14 <zhangjing14@gmail.com>
15 lines
334 B
ReStructuredText
15 lines
334 B
ReStructuredText
=====================
|
|
Getting Started Guide
|
|
=====================
|
|
|
|
------------
|
|
Introduction
|
|
------------
|
|
|
|
This document contains instructions for installing, using, and contributing to Composable Kernel (CK).
|
|
|
|
Documentation Roadmap
|
|
^^^^^^^^^^^^^^^^^^^^^
|
|
The following is a list of CK documents in the suggested reading order:
|
|
|
|
[TODO] |