Skip to content

Commit 74174af

Browse files
Merge pull request #33922 from jakevdp:sparse-note
PiperOrigin-RevId: 844853575
2 parents 8f431f6 + 60a0f0f commit 74174af

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

docs/jax.experimental.sparse.rst

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
``jax.experimental.sparse`` module
22
==================================
33

4-
.. note::
5-
6-
The methods in ``jax.experimental.sparse`` are experimental reference
7-
implementations, and not recommended for use in performance-critical
8-
applications.
9-
104
.. automodule:: jax.experimental.sparse
115

126
.. currentmodule:: jax.experimental.sparse

jax/experimental/sparse/__init__.py

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,17 @@
1515
"""
1616
.. currentmodule:: jax.experimental.sparse
1717
18+
.. note::
19+
20+
The methods in ``jax.experimental.sparse`` are experimental reference implementations,
21+
and not recommended for use in performance-critical applications. The submodule is no
22+
longer being actively developed, but the team will continue supporting existing features
23+
as best we can.
24+
1825
The :mod:`jax.experimental.sparse` module includes experimental support for sparse matrix
19-
operations in JAX. It is under active development, and the API is subject to change. The
20-
primary interfaces made available are the :class:`BCOO` sparse array type, and the
21-
:func:`sparsify` transform.
26+
operations in JAX. The primary interfaces made available are the :class:`BCOO` sparse array
27+
type, and the :func:`sparsify` transform.
28+
2229
2330
Batched-coordinate (BCOO) sparse matrices
2431
-----------------------------------------

0 commit comments

Comments
 (0)