KLUJAX

A sparse linear solver for JAX based on the efficient KLU algorithm.

CPU & float64

This library is a wrapper around the SuiteSparse KLU algorithms. This means the algorithm is only implemented for C-arrays and hence is only available for CPU arrays with double precision, i.e. float64 or complex128.

Note that this will be enforced at import of klujax!

Usage

The klujax library provides a single function solve(A, b), which solves for x in the linear system Ax=b A is a sparse tensor in COO-format with shape mxm and x and b have shape mxn. Note that JAX does not have a native sparse matrix representation and hence A should be represented as a tuple of two index arrays and a value array: (Ai, Aj, Ax).

import jax.numpy as jnp
from klujax import solve

b = jnp.array([8, 45, -3, 3, 19], dtype=jnp.float64)
A_dense = jnp.array([[2, 3, 0, 0, 0],
                     [3, 0, 4, 0, 6],
                     [0, -1, -3, 2, 0],
                     [0, 0, 1, 0, 0],
                     [0, 4, 2, 0, 1]], dtype=jnp.float64)
Ai, Aj = jnp.where(jnp.abs(A_dense) > 0)
Ax = A_dense[Ai, Aj]

result_ref = jnp.linalg.inv(A_dense)@b
result = solve(Ai, Aj, Ax, b)

print(jnp.abs(result - result_ref) < 1e-12)
print(result)

[ True True True True True]
[1. 2. 3. 4. 5.]

Installation

The library can be installed with pip:

pip install klujax

Please note that no pre-built wheels exist. This means that pip will attempt to install the library from source. Make sure you have the necessary (build-)dependencies installed.

conda install suitesparse
pip install jax
pip install torch_sparse_solve

License & Credits

This library was partly based on:

torch_sparse_solve, LGPL-2.1
SuiteSparse, LGPL-2.1
kagami-c/PyKLU, LGPL-2.1
scipy.sparse, BSD-3

Metadata

Release files for klujax 0.0.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for klujax 0.0.6
File	Size	Uploaded	Provenance
klujax-0.0.6.tar.gz	15.1 kB	Mar 16, 2022	Without provenance	Details

Release files / klujax-0.0.6.tar.gz

Download URL	klujax-0.0.6.tar.gz
Size	15.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`da34addfcfaabf53155946edbdfe71d811e8adc6d4d6346acb4c088abc9f1a4b`
BLAKE2b-256 checksum How to use checksums	`bfc2b4e4a794fa94b09b60a7d245c6f17d184aea3aa21f152c3c9223677fcdda`
Upload date	Mar 16, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/0.0.0 importlib_metadata/4.11.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.10`

Security for klujax 0.0.6

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.