Skip to content

Commit

Permalink
Add some missing mentions of sparse
Browse files Browse the repository at this point in the history
  • Loading branch information
asmeurer committed May 24, 2024
1 parent 676e373 commit ac8e593
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 4 deletions.
3 changes: 2 additions & 1 deletion docs/dev/tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ dependencies from `requirements-dev.txt` (array-api-compat has [no hard
runtime dependencies](no-dependencies)).

array-api-tests is run against all supported libraries are tested on CI
([except for JAX](jax-support)). This is achieved by a [reusable GitHub Actions
([except for JAX](jax-support) and [Sparse](sparse-support)). This is achieved
by a [reusable GitHub Actions
Workflow](https://github.com/data-apis/array-api-compat/blob/main/.github/workflows/array-api-tests.yml).
Most libraries have tests that must be xfailed or skipped for various reasons.
These are defined in specific `<library>-xfails.txt` files and are
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

This is a small wrapper around common array libraries that is compatible with
the [Array API standard](https://data-apis.org/array-api/latest/). Currently,
NumPy, CuPy, PyTorch, Dask, and JAX are supported. If you want support for other array
libraries, or if you encounter any issues, please [open an
NumPy, CuPy, PyTorch, Dask, JAX, and Sparse are supported. If you want support
for other array libraries, or if you encounter any issues, please [open an
issue](https://github.com/data-apis/array-api-compat/issues).

Note that some of the functionality in this library is backwards incompatible
Expand Down
4 changes: 3 additions & 1 deletion docs/supported-array-libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,5 +133,7 @@ Other methods may only be partially implemented or return incorrect results at t

The minimum supported Dask version is 2023.12.0.

## [`sparse`](https://sparse.pydata.org/en/stable/)
(sparse-support)=
## [Sparse](https://sparse.pydata.org/en/stable/)

Similar to JAX, `sparse` Array API support is contained directly in `sparse`.
1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
"jax": "jax",
"pytorch": "pytorch",
"dask": "dask",
"sprase": "sparse >=0.15.1",
},
classifiers=[
"Programming Language :: Python :: 3",
Expand Down

0 comments on commit ac8e593

Please # to comment.