Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Docstring for python-end API #76

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[WIP] Docstring for python-end API #76

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions python/tvm/sparse/format.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,41 @@ class FormatRewriteRule(Object):
inv_idx_map_func : Union[Callable, IndexMap]
A function describing the coordinate mapping from indices in new format.
to indices in old format.

Examples
--------
.. code-block:: python

>>> import tvm
>>> from tvm.sparse import format_decompose
>>> def bsr(block_size: int)
... @T.prim_func
... def func(
... a: T.handle,
... indptr: T.handle,
... indices: T.handle,
... m: T.int32,
... n: T.int32,
... nnz: T.int32,
... ) -> None:
... IO = T.dense_fixed(m)
... JO = T.sparse_variable(IO, (n, nnz), (indptr, indices), "int32")
... II = T.dense_fixed(block_size)
... JI = T.dense_fixed(block_size)
... A = T.match_sparse_buffer(a, (IO, JO, II, JI), "float32")
... T.evaluate(0)
... return func
...
>>> rewrite_bsr_32 = FormatRewriteRule(
... str(32),
... bsr(32),
... ["A"],
... ["I", "J"],
... ["IO", "JO", "II", "JI"],
... {"I": ["IO", "II"], "J": ["JO", "JI"]},
... lambda i, j: (i // 32, j // 32, i % 32, j % 32),
... lambda io, jo, ii, ji: (io * 32 + ii, jo * 32 + ji),
... )
"""

def __init__(
Expand Down