jax.experimental.sparse 模块#

注意

jax.experimental.sparse 中的方法是实验性参考实现，不建议在性能关键型应用中使用。

jax.experimental.sparse 模块包含对 JAX 中稀疏矩阵操作的实验性支持。该模块正在积极开发中，API 可能会发生变化。主要接口是 BCOO 稀疏数组类型和 sparsify() 转换。

批量坐标 (BCOO) 稀疏矩阵#

JAX 中目前可用的主要高级稀疏对象是 BCOO，即 *批量坐标* 稀疏数组，它提供了一种与 JAX 转换兼容的压缩存储格式，特别是 JIT（例如 jax.jit()）、批处理（例如 jax.vmap()）和自动微分（例如 jax.grad()）。

下面是使用密集数组创建稀疏数组的示例

>>> from jax.experimental import sparse
>>> import jax.numpy as jnp
>>> import numpy as np

>>> M = jnp.array([[0., 1., 0., 2.],
...                [3., 0., 0., 0.],
...                [0., 0., 4., 0.]])

>>> M_sp = sparse.BCOO.fromdense(M)

>>> M_sp
BCOO(float32[3, 4], nse=4)

使用 todense() 方法转换回密集数组

>>> M_sp.todense()
Array([[0., 1., 0., 2.],
       [3., 0., 0., 0.],
       [0., 0., 4., 0.]], dtype=float32)

BCOO 格式是标准 COO 格式的一个修改版本，其密集表示可以在 data 和 indices 属性中看到。

>>> M_sp.data  # Explicitly stored data
Array([1., 2., 3., 4.], dtype=float32)

>>> M_sp.indices # Indices of the stored data
Array([[0, 1],
       [0, 3],
       [1, 0],
       [2, 2]], dtype=int32)

BCOO 对象具有熟悉的类数组属性以及稀疏专用属性

>>> M_sp.ndim
2

>>> M_sp.shape
(3, 4)

>>> M_sp.dtype
dtype('float32')

>>> M_sp.nse  # "number of specified elements"
4

BCOO 对象还实现了许多类数组方法，允许您在 jax 程序中直接使用它们。例如，我们在此计算转置矩阵向量积

>>> y = jnp.array([3., 6., 5.])

>>> M_sp.T @ y
Array([18.,  3., 20.,  6.], dtype=float32)

>>> M.T @ y  # Compare to dense version
Array([18.,  3., 20.,  6.], dtype=float32)

BCOO 对象旨在与 JAX 转换兼容，包括 jax.jit()、jax.vmap()、jax.grad() 等。例如

>>> from jax import grad, jit

>>> def f(y):
...   return (M_sp.T @ y).sum()
...
>>> jit(grad(f))(y)
Array([3., 3., 4.], dtype=float32)

然而请注意，在正常情况下，jax.numpy 和 jax.lax 函数不知道如何处理稀疏矩阵，因此尝试计算诸如 jnp.dot(M_sp.T, y) 之类的操作将导致错误（但请参阅下一节）。

稀疏化转换#

JAX 稀疏实现的一个首要目标是提供一种在不修改密集实现的情况下，无缝地从密集计算切换到稀疏计算的方法。这个稀疏实验通过 sparsify() 转换实现了这一点。

考虑这个函数，它从矩阵和向量输入计算出更复杂的结果

>>> def f(M, v):
...   return 2 * jnp.dot(jnp.log1p(M.T), v) + 1
...
>>> f(M, y)
Array([17.635532,  5.158883, 17.09438 ,  7.591674], dtype=float32)

如果我们将稀疏矩阵直接传递给此函数，将会导致错误，因为 jnp 函数不识别稀疏输入。但是，通过 sparsify()，我们可以得到一个接受稀疏矩阵的函数版本。

>>> f_sp = sparse.sparsify(f)

>>> f_sp(M_sp, y)
Array([17.635532,  5.158883, 17.09438 ,  7.591674], dtype=float32)

对 sparsify() 的支持包括大量最常用的原语，包括：

  • 广义（批处理）矩阵乘积和爱因斯坦求和 (dot_general_p)

  • 零保留的逐元素二元操作（例如 add_p, mul_p 等）

  • 零保留的逐元素一元操作（例如 abs_p, jax.lax.neg_p 等）

  • 求和归约（reduce_sum_p）

  • 通用索引操作（slice_p, lax.dynamic_slice_p, lax.gather_p）

  • 连接和堆叠（concatenate_p）

  • 转置和重塑（transpose_p, reshape_p, squeeze_p, broadcast_in_dim_p）

  • 一些高阶函数（cond_p, while_p, scan_p）

  • 一些简单的一维卷积（conv_general_dilated_p）

几乎任何转换为这些支持的原语的 jax.numpy 函数都可以在稀疏化转换中使用，以操作稀疏数组。这组原语足以实现相对复杂的稀疏工作流，如下一节所示。

示例：稀疏逻辑回归#

作为一个更复杂稀疏工作流的示例，我们来考虑一个在 JAX 中实现的简单逻辑回归。请注意，以下实现没有提及稀疏性

>>> import functools
>>> from sklearn.datasets import make_classification
>>> from jax.scipy import optimize

>>> def sigmoid(x):
...   return 0.5 * (jnp.tanh(x / 2) + 1)
...
>>> def y_model(params, X):
...   return sigmoid(jnp.dot(X, params[1:]) + params[0])
...
>>> def loss(params, X, y):
...   y_hat = y_model(params, X)
...   return -jnp.mean(y * jnp.log(y_hat) + (1 - y) * jnp.log(1 - y_hat))
...
>>> def fit_logreg(X, y):
...   params = jnp.zeros(X.shape[1] + 1)
...   result = optimize.minimize(functools.partial(loss, X=X, y=y),
...                              x0=params, method='BFGS')
...   return result.x

>>> X, y = make_classification(n_classes=2, random_state=1701)
>>> params_dense = fit_logreg(X, y)
>>> print(params_dense)  
[-0.7298445   0.29893667  1.0248291  -0.44436368  0.8785025  -0.7724008
 -0.62893456  0.2934014   0.82974285  0.16838408 -0.39774987 -0.5071844
  0.2028872   0.5227761  -0.3739224  -0.7104083   2.4212713   0.6310087
 -0.67060554  0.03139788 -0.05359547]

这返回了密集逻辑回归问题的最佳拟合参数。要在稀疏数据上拟合相同的模型，我们可以应用 sparsify() 转换。

>>> Xsp = sparse.BCOO.fromdense(X)  # Sparse version of the input
>>> fit_logreg_sp = sparse.sparsify(fit_logreg)  # Sparse-transformed fit function
>>> params_sparse = fit_logreg_sp(Xsp, y)
>>> print(params_sparse)  
[-0.72971725  0.29878938  1.0246326  -0.44430563  0.8784217  -0.77225566
 -0.6288222   0.29335397  0.8293481   0.16820715 -0.39764675 -0.5069753
  0.202579    0.522672   -0.3740134  -0.7102678   2.4209507   0.6310593
 -0.670236    0.03132951 -0.05356663]

稀疏 API 参考#

sparsify(f[, use_tracer])

实验性稀疏化转换。

grad(fun[, argnums, has_aux])

jax.grad() 的稀疏感知版本

value_and_grad(fun[, argnums, has_aux])

jax.value_and_grad() 的稀疏感知版本

empty(shape[, dtype, index_dtype, sparse_format])

创建一个空的稀疏数组。

eye(N[, M, k, dtype, index_dtype, sparse_format])

创建二维稀疏单位矩阵。

todense(arr)

将输入转换为密集矩阵。

random_bcoo(key, shape, *[, dtype, ...])

生成一个随机 BCOO 矩阵。

JAXSparse(args, *, shape)

高级 JAX 稀疏对象的基类。

BCOO 数据结构#

BCOO 是 *批量 COO 格式*，它是 jax.experimental.sparse 中实现的主要稀疏数据结构。其操作与 JAX 的核心转换兼容，包括批处理（例如 jax.vmap()）和自动微分（例如 jax.grad()）。

BCOO(args, *, shape[, indices_sorted, ...])

JAX 中实现的实验性批量 COO 矩阵

bcoo_broadcast_in_dim(mat, *, shape, ...[, ...])

通过复制数据来扩展 BCOO 数组的大小和秩。

bcoo_concatenate(operands, *, dimension)

jax.lax.concatenate() 的稀疏实现

bcoo_dot_general(lhs, rhs, *, dimension_numbers)

一个通用的收缩操作。

bcoo_dot_general_sampled(A, B, indices, *, ...)

在给定稀疏索引处计算输出的收缩操作。

bcoo_dynamic_slice(mat, start_indices, ...)

jax.lax.dynamic_slice 的稀疏实现。

bcoo_extract(sparr, arr, *[, assume_unique])

根据稀疏数组的索引从密集数组中提取值。

bcoo_fromdense(mat, *[, nse, n_batch, ...])

从密集矩阵创建 BCOO 格式的稀疏矩阵。

bcoo_gather(operand, start_indices, ...[, ...])

lax.gather 的 BCOO 版本。

bcoo_multiply_dense(sp_mat, v)

稀疏数组与密集数组之间的逐元素乘法。

bcoo_multiply_sparse(lhs, rhs)

两个稀疏数组的逐元素乘法。

bcoo_update_layout(mat, *[, n_batch, ...])

更新 BCOO 矩阵的存储布局（即 n_batch 和 n_dense）。

bcoo_reduce_sum(mat, *, axes)

在给定轴上求数组元素和。

bcoo_reshape(mat, *, new_sizes[, ...])

jax.lax.reshape 的稀疏实现。

bcoo_slice(mat, *, start_indices, limit_indices)

jax.lax.slice 的稀疏实现。

bcoo_sort_indices(mat)

对 BCOO 数组的索引进行排序。

bcoo_squeeze(arr, *, dimensions)

jax.lax.squeeze 的稀疏实现。

bcoo_sum_duplicates(mat[, nse])

对 BCOO 数组中的重复索引求和，返回一个带有排序索引的数组。

bcoo_todense(mat)

将批量稀疏矩阵转换为密集矩阵。

bcoo_transpose(mat, *, permutation)

转置 BCOO 格式数组。

BCSR 数据结构#

BCSR 是 *批量压缩稀疏行* 格式，正在开发中。其操作与 JAX 的核心转换兼容，包括批处理（例如 jax.vmap()）和自动微分（例如 jax.grad()）。

BCSR(args, *, shape[, indices_sorted, ...])

JAX 中实现的实验性批量 CSR 矩阵。

bcsr_dot_general(lhs, rhs, *, dimension_numbers)

一个通用的收缩操作。

bcsr_extract(indices, indptr, mat)

在给定的 BCSR（索引，indptr）处从密集矩阵中提取值。

bcsr_fromdense(mat, *[, nse, n_batch, ...])

从密集矩阵创建 BCSR 格式的稀疏矩阵。

bcsr_todense(mat)

将批量稀疏矩阵转换为密集矩阵。

其他稀疏数据结构#

其他稀疏数据结构包括 COO、CSR 和 CSC。这些是实现了少量核心操作的简单稀疏结构的参考实现。它们的操作通常与自动微分转换（例如 jax.grad()）兼容，但与批处理转换（例如 jax.vmap()）不兼容。

COO(args, *, shape[, rows_sorted, cols_sorted])

JAX 中实现的实验性 COO 矩阵。

CSC(args, *, shape)

JAX 中实现的实验性 CSC 矩阵；API 可能会发生变化。

CSR(args, *, shape)

JAX 中实现的实验性 CSR 矩阵。

coo_fromdense(mat, *[, nse, index_dtype])

从密集矩阵创建 COO 格式的稀疏矩阵。

coo_matmat(mat, B, *[, transpose])

COO 稀疏矩阵与密集矩阵的乘积。

coo_matvec(mat, v[, transpose])

COO 稀疏矩阵与密集向量的乘积。

coo_todense(mat)

将 COO 格式稀疏矩阵转换为密集矩阵。

csr_fromdense(mat, *[, nse, index_dtype])

从密集矩阵创建 CSR 格式的稀疏矩阵。

csr_matmat(mat, B, *[, transpose])

CSR 稀疏矩阵与密集矩阵的乘积。

csr_matvec(mat, v[, transpose])

CSR 稀疏矩阵与密集向量的乘积。

csr_todense(mat)

将 CSR 格式稀疏矩阵转换为密集矩阵。

jax.experimental.sparse.linalg#

稀疏线性代数例程。

spsolve(data, indices, indptr, b[, tol, reorder])

使用 QR 分解的稀疏直接求解器。

lobpcg_standard(A, X[, m, tol])

使用 LOBPCG 例程计算前 k 个标准特征值。