Skip to content

Commit fac5ffe

Browse files
committed
Add links to SuiteSparse:GraphBLAS repo and User Guide in api docstring
1 parent dcf83c7 commit fac5ffe

1 file changed

Lines changed: 14 additions & 8 deletions

File tree

suitesparse_graphblas/api/__init__.py

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,24 @@
1-
"""SuiteSparse:GraphBLAS is a full implementation of the GraphBLAS
2-
standard, which defines a set of sparse matrix operations on an
3-
extended algebra of semirings using an almost unlimited variety of
4-
operators and types. When applied to sparse adjacency matrices, these
5-
algebraic operations are equivalent to computations on graphs.
6-
GraphBLAS provides a powerful and expressive framework for creating
7-
high-performance graph algorithms based on the elegant mathematics of
8-
sparse matrix operations on a semiring.
1+
"""[SuiteSparse:GraphBLAS](https://github.com/DrTimothyAldenDavis/GraphBLAS)
2+
is a full implementation of the GraphBLAS standard, which defines a
3+
set of sparse matrix operations on an extended algebra of semirings
4+
using an almost unlimited variety of operators and types. When applied
5+
to sparse adjacency matrices, these algebraic operations are
6+
equivalent to computations on graphs. GraphBLAS provides a powerful
7+
and expressive framework for creating high-performance graph
8+
algorithms based on the elegant mathematics of sparse matrix
9+
operations on a semiring.
910
1011
This module contains the "functional API" for
1112
python-suitesparse-graphblas. This is a higher level API than the
1213
"raw" CFFI binding, but a lower level API than the algebraic
1314
functionality provided by the
1415
[python-graphblas](https://python-graphblas.readthedocs.io/en/stable/api_reference/index.html)
1516
library.
17+
18+
For documentation on the SuiteSparse implementation that describes all
19+
of these functions in detail, read the [SuiteSparse:GraphBLAS User
20+
Guide](https://github.com/DrTimothyAldenDavis/GraphBLAS/blob/stable/Doc/GraphBLAS_UserGuide.pdf)
21+
1622
"""
1723
from suitesparse_graphblas.api import (
1824
binaryop,

0 commit comments

Comments
 (0)