Update to SuiteSparse:GraphBLAS 8.0.0 by eriknw · Pull Request #456 · python-graphblas/python-graphblas · GitHub

This begins updating to SuiteSparse:GraphBLAS 8.0.0, which added the JIT and contexts. Currently, this PR adds support for context and updates the configurations. We still need to support the JIT.

See release log here: https://github.com/DrTimothyAldenDavis/GraphBLAS/releases/tag/v8.0.0

Contexts

There are two types of contexts: global, and thread-local.

The global context can be viewed and modified at gb.global_context.
Local contexts can be created by gb.ss.Context().
- Local contexts can also be used as context managers, such as with gb.ss.Context(nthreads=4):.
- Contexts also have c.engage() and c.disengage() methods that are used by __enter__ and __exit__.

Local contexts do not stack. The inner context replaces the outer context here:

with Context(nthreads=8):
    # nthreads is 8
    with Context(nthreads=4):
        # nthreads is 4
    # Now nthreads is default (not 8!)

I don't know if we want to try to keep track of the stack ourselves. Perhaps if/when somebody needs such a workflow.

The other tricky thing with contexts is that nthreads and chunks were removed as descriptor options. This is awkward for us, since I like the syntax of expr.new(nthreads=8) and C(nthreads=8) << expr and would like to keep it (and not add incompatible changes). So, I kept it. If any context option is used in **opts (which is typically for the descriptor), then we either update the current context that the user explicitly engaged, or we create a new context whose lifetime matches the descriptor lifetime. This ought to work well enough in practice, but I'm not fond of relying on __del__ to disengage the context. I would prefer if e.g. nthreads was still part of the descriptor.

Configs

Two changes happened with configuration in SuiteSparse:GraphBLAS:

nthreads and chunks were removed (they're now handled by context
many JIT options were added

We have some choices for how we can handle these.

First, the global config can have all configurations and global contexts:

>>> gb.ss.config
GlobalConfig({'bitmap_switch': [0.03999999910593033, 0.05000000074505806, 0.05999999865889549, 0.07999999821186066, 0.10000000149011612, 0.20000000298023224, 0.30000001192092896, 0.4000000059604645],
 'burble': False,
 'chunk': 65536.0,
 'format': 'by_row',
 'gpu_id': -1,
 'hyper_switch': 0.0625,
 'jit_c_cmake_libs': 'm;dl;/home/erik/miniconda3/envs/sspg/x86_64-conda-linux-gnu/lib/libgomp.so;/home/erik/miniconda3/envs/sspg/x86_64-conda-linux-gnu/sysroot/usr/lib/libpthread.so',
 'jit_c_compiler_flags': ' -Wundef  -std=c11 -lm -Wno-pragmas  -fexcess-precision=fast  -fcx-limited-range  -fno-math-errno  -fwrapv  -O3 -DNDEBUG -fopenmp  -fPIC ',
 'jit_c_compiler_name': '/home/erik/miniconda3/envs/sspg/bin/cc',
 'jit_c_control': 'on',
 'jit_c_libraries': ' -lm -ldl /home/erik/miniconda3/envs/sspg/x86_64-conda-linux-gnu/lib/libgomp.so /home/erik/miniconda3/envs/sspg/x86_64-conda-linux-gnu/sysroot/usr/lib/libpthread.so',
 'jit_c_linker_flags': ' -shared ',
 'jit_c_preface': '',
 'jit_cache_path': '/home/erik/.SuiteSparse/GrB8.0.0',
 'jit_error_log': '',
 'jit_use_cmake': False,
 'memory_pool': [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
 'nthreads': 8,
 'print_1based': False})

Second, we can have a new global_context object:

>>> gb.ss.global_context
GlobalContext({'chunk': 65536.0,
 'gpu_id': -1,
 'nthreads': 8})

Third, we can have a new jit or jitconfig object:

>>> gb.ss.jit
JitConfig({'c_cmake_libs': 'm;dl;/home/erik/miniconda3/envs/sspg/x86_64-conda-linux-gnu/lib/libgomp.so;/home/erik/miniconda3/envs/sspg/x86_64-conda-linux-gnu/sysroot/usr/lib/libpthread.so',
 'c_compiler_flags': ' -Wundef  -std=c11 -lm -Wno-pragmas  -fexcess-precision=fast  -fcx-limited-range  -fno-math-errno  -fwrapv  -O3 -DNDEBUG -fopenmp  -fPIC ',
 'c_compiler_name': '/home/erik/miniconda3/envs/sspg/bin/cc',
 'c_control': 'on',
 'c_libraries': ' -lm -ldl /home/erik/miniconda3/envs/sspg/x86_64-conda-linux-gnu/lib/libgomp.so /home/erik/miniconda3/envs/sspg/x86_64-conda-linux-gnu/sysroot/usr/lib/libpthread.so',
 'c_linker_flags': ' -shared ',
 'c_preface': '',
 'cache_path': '/home/erik/.SuiteSparse/GrB8.0.0',
 'error_log': '',
 'use_cmake': False})

So, if we want global_context and/or jit/jitconfig objects, we could remove one/both of them from the global config, which simplifies the global config considerably. For example, here's the global config without the JIT options:

GlobalConfig({'bitmap_switch': [0.03999999910593033, 0.05000000074505806, 0.05999999865889549, 0.07999999821186066, 0.10000000149011612, 0.20000000298023224, 0.30000001192092896, 0.4000000059604645],
 'burble': False,
 'chunk': 65536.0,
 'format': 'by_row',
 'gpu_id': -1,
 'hyper_switch': 0.0625,
 'memory_pool': [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
 'nthreads': 8,
 'print_1based': False})

If we also removed the global context items from the global config, we get:

GlobalConfig({'bitmap_switch': [0.03999999910593033, 0.05000000074505806, 0.05999999865889549, 0.07999999821186066, 0.10000000149011612, 0.20000000298023224, 0.30000001192092896, 0.4000000059604645],
 'burble': False,
 'format': 'by_row',
 'hyper_switch': 0.0625,
 'memory_pool': [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
 'print_1based': False})

@jim22k @SultanOrazbayev how would you like to organize the global configuration and global context? It's helpful to expose the global context so users can do global_contect.engage() to reset the context. I also like keeping nthreads in the global config (which gets and sets via the global context). So, my main question I'm struggling with is whether to split out the jit config.

Finally, we don't yet support getting or setting functions such as malloc, free, print, and flush (the third change in 8.0.0).

JIT

Coming soon!

coverage: 99.44% (-0.4%) from 99.806%
when pulling 8ec612f on eriknw:v8.0.0
into f0e0324 on python-graphblas:main.

Alright, I think we should consider how we want contexts to behave and not rely on default behavior. For example, I think it would be nice to be able to layer contexts:

with Context(nthreads=4):
    # nthreads is 4
    with Context(chunk=0.5):
        # nthreads is still 4 (new behavior!)
        ...
    # nthreads is still 4 (new behavior!)

I updated contexts to chain and stack by default as illustrated in my previous comment.

Descriptor-like context values (such as expr.new(nthreads=4)) create new context objects derived from the current active context, and they "disengage" when they go out of scope so they can now apply to GraphBLAS functions that don't have descriptors. I think everything should more-or-less behave exactly as expected/desired in all plausible usage (but it's probably possible to get contexts in a weird state if one tries, really, really hard to do so).

I/we still need to document and test descriptors, and work on the JIT. If anybody wants to continue to work or play with this PR, ping me on discord or slack.

In response to this comment, DrTimothyAldenDavis/GraphBLAS#218 (comment), I wonder whether it would be better for us to have a single context per thread that we update (it sounds like engaging a context in a thread may be required for kernel fusion in the future, and engaging many contexts in a thread may wreak havoc on this). This would mean that Context objects that would get used on a regular basis are pure Python that don't create/free GxB_Context objects, but modify the thread-local context. I'm glad we learned of this now. I'd like to think on it a bit.

JIT tests are now passing in CI for Linux and Windows! 🎉

Should we remove the name argument here? It's required to be the same name as the typedef, and I bet we could determine the name from jit_c_definition.

Similarly, should we get the name, input type, and return type from the C definition here?

Alternatively, should name not be required to match the name used in the C definition?

Should we call this function something else, such as gb.unary.ss.register_jit?

Also, should we consider adding register_anonymous or allowing it to be anonymous?

This is going in!

We still need to add some tests and documentaion, so SuiteSparse 8 is not yet "officially" supported. The metadata only allows SuiteSparse 7. This also gives us more time to review and refine the JIT.

Feel free to add review comments to this PR even after it's merged.

btw, the JIT is working for CI for all OSes with both python-suitesparse-graphblas wheels and GraphBLAS from conda-forge except for Window wheels (I don't know why).

eriknw added 2 commits May 20, 2023 20:38

Update to SuiteSparse:GraphBLAS 8.0.0

375835b

Let the tests run

94f968b

eriknw commented May 21, 2023

View reviewed changes

Comment thread graphblas/tests/test_formatting.py Outdated

oops

f75ee19

Allow contexts to stack/chain together

b57cbff

eriknw mentioned this pull request May 22, 2023

Why was nthreads and chunks remove from the descriptor? DrTimothyAldenDavis/GraphBLAS#218

Closed

eriknw mentioned this pull request Jun 2, 2023

bug: deprecating python 3.8 support might resolve it #458

Closed

eriknw added 17 commits June 2, 2023 20:18

Merge branch 'main' into v8.0.0

ea116ea

Update to 8.0.1

0ae080e

Make dtypes a directory so we can add gb.dtypes.ss

a1b757e

bump ruff and mark more slow tests

8ec612f

moar

3996198

JIT for binary and indexunary operators (untested, undocumented)

e44c08f

oops forgot to add file

aa627d0

Add test for suitesparse jit

620735c

Bump pre-commit

31faf9b

Merge branch 'main' into v8.0.0

a835b33

Merge branch 'main' into v8.0.0

206d433

bump ruff

0e6a217

Handle scipy 1.11.0

b4234e9

oops fix usage of check_status_carg

3416f31

Add ways to use easily use burble in tests

36be766

Try this to allow pre-release

20bde63

oops and here

70a7b98

eriknw mentioned this pull request Jun 27, 2023

Backport many of the SS:GB 8 changes to run on 7 #478

Merged

Merge branch 'main' into v8.0.0

da1fac3

eriknw added 7 commits June 28, 2023 12:05

Fix bad merge

e259d22

Try to fix SS JIT config when testing on Linux

05d3db8

Install c-compiler for JIT

8ffd6ba

More experimentation

00d2e6b

Better handle JIT UDT numpy and numba dtypes

76dc467

Try this

0526bfb

skip ssjit tests on macos for now

0763253

eriknw added 3 commits June 29, 2023 12:15

Merge branch 'main' into v8.0.0

1125674

fix ss.dtypes

d7a9460

Run with SuiteSparse 7 and 8

8c3692a

eriknw commented Jul 1, 2023

View reviewed changes

eriknw added 13 commits July 1, 2023 23:49

Enable SS 7 in CI; and a bit more coverage

9a9d24b

Try this

0d564e0

Still experimenting

1add974

Another try

1109d02

skip SS JIT on macos again

3c234f3

Oops, forgot to commit this when trying clang

d3e2a4f

Don't use -isysroot for SS JIT on macos

c9b3beb

Clean up; SS JIT working on macos in CI now!

86bddfc

Clean up; change dependency metadata to only use SS:GB 7

546814b

Test python-suitespare-graphblas 8 wheels

fdd4cad

hmm, don't test JIT on Windows with suitesparse-graphblas wheels

aee83f8

Clean up again

8639b0b

Update ss config doc for experimental GPU support

6270abf

eriknw merged commit f14cbac into python-graphblas:main Jul 5, 2023

Update to SuiteSparse:GraphBLAS 8.0.0 by eriknw · Pull Request #456 · python-graphblas/python-graphblas · GitHub

Uh oh!

Update to SuiteSparse:GraphBLAS 8.0.0 - #456

Update to SuiteSparse:GraphBLAS 8.0.0#456
eriknw merged 45 commits into
python-graphblas:mainfrom
eriknw:v8.0.0

eriknw commented May 21, 2023 •
edited
Loading

Uh oh!

Uh oh!

Uh oh!

coveralls commented May 21, 2023 •
edited
Loading

Uh oh!

Uh oh!

eriknw commented May 21, 2023

Uh oh!

eriknw commented May 22, 2023

Uh oh!

eriknw commented May 22, 2023

Uh oh!

eriknw commented Jun 29, 2023

Uh oh!

eriknw Jul 1, 2023

Uh oh!

eriknw Jul 1, 2023

Uh oh!

eriknw commented Jul 5, 2023

Uh oh!

eriknw commented Jul 5, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		jit_ffi = FFI()


		def register_new(name, jit_c_definition, *, np_type=None):

		__call__ = TypedUserUnaryOp.__call__


		def register_new(name, jit_c_definition, input_type, ret_type):

Update to SuiteSparse:GraphBLAS 8.0.0 by eriknw · Pull Request #456 · python-graphblas/python-graphblas · GitHub

Uh oh!

Update to SuiteSparse:GraphBLAS 8.0.0 - #456

Update to SuiteSparse:GraphBLAS 8.0.0#456eriknw merged 45 commits intopython-graphblas:mainpython-graphblas/python-graphblas:mainfrom eriknw:v8.0.0eriknw/grblas:v8.0.0Copy head branch name to clipboard

Conversation

eriknw commented May 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Contexts

Configs

JIT

Uh oh!

Uh oh!

coveralls commented May 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

eriknw commented May 21, 2023

Uh oh!

eriknw commented May 22, 2023

Uh oh!

eriknw commented May 22, 2023

Uh oh!

eriknw commented Jun 29, 2023

Uh oh!

eriknw Jul 1, 2023

Choose a reason for hiding this comment

Uh oh!

eriknw Jul 1, 2023

Choose a reason for hiding this comment

Uh oh!

eriknw commented Jul 5, 2023

Uh oh!

eriknw commented Jul 5, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Update to SuiteSparse:GraphBLAS 8.0.0#456
eriknw merged 45 commits into
python-graphblas:mainfrom
eriknw:v8.0.0

eriknw commented May 21, 2023 •
edited
Loading

coveralls commented May 21, 2023 •
edited
Loading