From 58148d2f54083b53a8fc4564a9d0e7a1b7a5bd73 Mon Sep 17 00:00:00 2001 From: Erik Welch Date: Tue, 18 Apr 2023 15:34:06 -0500 Subject: [PATCH 1/2] Add note about supporting GraphBLAS C API version --- README.md | 1 + docs/getting_started/faq.rst | 12 ++++++++++++ 2 files changed, 13 insertions(+) diff --git a/README.md b/README.md index f07fdea12..89f085220 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,7 @@ or pip: $ pip install python-graphblas[default] ``` This will also install the [SuiteSparse:GraphBLAS](https://github.com/DrTimothyAldenDavis/GraphBLAS) compiled C library. +We currently support the [GraphBLAS C API 2.0 specification](https://graphblas.org/docs/GraphBLAS_API_C_v2.0.0.pdf). ### Optional Dependencies diff --git a/docs/getting_started/faq.rst b/docs/getting_started/faq.rst index ab905050c..1e60a1bd4 100644 --- a/docs/getting_started/faq.rst +++ b/docs/getting_started/faq.rst @@ -112,6 +112,18 @@ This is motivated by these guidelines: For example, if a CVE is discovered, we won't retroactively apply the fix to previous releases. Instead, the fix will only be available starting with the next release. +The `GraphBLAS C API specification `_ is expected to change slowly, but it does change. +We aim to support the latest version of the GraphBLAS spec and of implementations. +We will announce plans to drop support of *old* versions of the spec or major versions of implementations +*before* we do so. We will make the announcements in the +`release notes `_ and in our Discord channel. +If the proposed changes will negatively affect you, please +`let us know `_ +so we may work together towards a solution. + +To see which versions of SuiteSparse:GraphBLAS we support, look at the version specification +of ``suitesparse`` under ``[projects.optional-dependencies]`` in ``pyproject.toml``. + What is the relationship between python-graphblas and pygraphblas? ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ From 8617f2465286a08f33865a0926fca08ef3384901 Mon Sep 17 00:00:00 2001 From: Erik Welch Date: Wed, 19 Apr 2023 08:37:50 -0600 Subject: [PATCH 2/2] Add "2.0" as the spec version here in readme too --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 89f085220..2a3378d18 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,7 @@ The following are not required by python-graphblas, but may be needed for certai ## Description Currently works with [SuiteSparse:GraphBLAS](https://github.com/DrTimothyAldenDavis/GraphBLAS), but the goal is to make it work with all implementations of the GraphBLAS spec. -The approach taken with this library is to follow the C-API specification as closely as possible while making improvements +The approach taken with this library is to follow the C-API 2.0 specification as closely as possible while making improvements allowed with the Python syntax. Because the spec always passes in the output object to be written to, we follow the same, which is very different from the way Python normally operates. In fact, many who are familiar with other Python data libraries (numpy, pandas, etc) will find it strange to not create new objects for every call.