update docstring

uwsampl · Nov 17, 2022 · f170bc5 · f170bc5
1 parent 7ec3bca
commit f170bc5
Show file tree

Hide file tree

Showing 6 changed files with 55 additions and 7 deletions.
diff --git a/docs/api/python/tvm.sparse.rst b/docs/api/python/tvm.sparse.rst
@@ -0,0 +1,36 @@
+.. _apidata
+
+tvm.sparse
+==========
+
+.. currentmodule:: tvm.sparse
+.. automodule:: tvm.sparse
+
+Program transformations
+---------------------------------------
+
+.. autosummary::
+  :toctree: ../../generated
+
+  lower_sparse_iter
+  lower_sparse_buffer
+  format_decompose
+  specialize_buffer
+
+Composable Format Description
+---------------------------------------
+
+.. autosummary::
+  :toctree: ../../generated
+
+  FormatRewriteRule
+
+Format Conversion Routines
+---------------------------------------
+
+.. autosummary::
+  :toctree: ../../generated
+
+  condense
+  column_part_hyb
+  csf_to_ell3d
diff --git a/docs/faq.rst b/docs/faq.rst
@@ -0,0 +1,4 @@
+Frequently Asked Questions
+==========================
+
+Under construction.
diff --git a/docs/index.rst b/docs/index.rst
@@ -30,11 +30,17 @@ SparseTIR is a tensor-level compiler for sparse/irregular operators in Deep Lear
    :maxdepth: 1
    :caption: System Overview
 
+   motivation.rst
    overview.rst
 
-API doc
-==================
+.. toctree::
+   :maxdepth: 1
+   :caption: Misc
+
+   faq.rst
+
+.. toctree::
+   :maxdepth: 1
+   :caption: API Reference
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   api/python/tvm.sparse
diff --git a/docs/motivation.rst b/docs/motivation.rst
@@ -0,0 +1,4 @@
+Why creating another compiler abstraction for Sparse Tensor Algebra
+===================================================================
+
+Under construction
diff --git a/docs/overview.rst b/docs/overview.rst
@@ -1,4 +1,3 @@
 System Overview
 ===============
 
-Under construction
diff --git a/docs/tutorials/blitz.rst b/docs/tutorials/blitz.rst
@@ -1,4 +1,3 @@
 The Blitz Course to SparseTIR
 =============================
 
-Under construction.