How waleed-sh/mlx-sparse works
mlx-sparse is a Python-facing MLX sparse-array library backed by native C++ primitives, with CPU kernels and Metal support for fixed-shape operations. Users construct or generate COO/CSR/CSC matrices, operate on or convert them, and may pass them to iterative solvers, factorizations, or spectral routines. The graph retains those documented capabilities and the native-kernel layer; some subsystem connections are documented only at package level because their implementation files were not sampled.
Main entry points: _native.py Native dispatch · _construct.py Construction · _iterative.py Iterative solvers · bindings.cpp C++ bindings
Components 24
Array API
- Construction
mlx_sparse/_construct.py - COO arrays
mlx_sparse/_coo.py - CSR arrays
mlx_sparse/_csr.py - CSC arrays
mlx_sparse/_csc.py - Validation
mlx_sparse/_validation.py - Sparse operations
mlx_sparse/_ops.py - Array types
mlx_sparse/_typing.py
Native Operations
- Native dispatch
mlx_sparse/_native.py - Python fallback
mlx_sparse/_fallback.py - C++ bindings
src/bindings.cpp - Kernel utilities
src/common/common.h - CPU parallelism
src/common/cpu_parallel.h
Sparse Linear Algebra
- Iterative solvers
mlx_sparse/linalg/_iterative.py - Preconditioners
mlx_sparse/linalg/preconditioners.py - Direct factors
mlx_sparse/linalg/_factorizations.py - Spectral routines
mlx_sparse/linalg/_eigen.py - Triangular solves
src/linalg/triangular_solve/triangular_solve.cpp - Solver utilities
src/linalg/common/common.h - Accelerate solves
src/linalg/accelerate/solve/solve.h
Generation and Runtime
- Random arrays
mlx_sparse/random/__init__.py - Native sampling
src/random/random.h - Device runtime
mlx_sparse/runtime.py - Host utilities
mlx_sparse/_host.py
Other components
- Python user
Connections 32
- Python user → Construction: constructs
- Construction → Validation: validates
mlx_sparse/_construct.py - Construction → COO arrays: creates
mlx_sparse/_construct.py - Construction → CSR arrays: creates
mlx_sparse/_construct.py - Construction → CSC arrays: creates
mlx_sparse/_construct.py - Python user → COO arrays: uses
- Python user → CSR arrays: uses
- Python user → CSC arrays: uses
- COO arrays → Native dispatch: dispatches
mlx_sparse/_coo.py - CSR arrays → Native dispatch: dispatches
mlx_sparse/_csr.py - CSC arrays → Native dispatch: dispatches
mlx_sparse/_csc.py - Native dispatch → Python fallback: falls back
mlx_sparse/_native.py - Native dispatch → C++ bindings: dispatches
- C++ bindings → Kernel utilities: uses
- C++ bindings → CPU parallelism: uses
- Python user → Sparse operations: operates on
- Python user → Iterative solvers: solves with
- Iterative solvers → Preconditioners: uses
mlx_sparse/linalg/_iterative.py - Iterative solvers → Native dispatch: dispatches
mlx_sparse/linalg/_iterative.py - Python user → Direct factors: factorizes
- Python user → Spectral routines: computes spectra
- Python user → Triangular solves: solves triangular systems
- Python user → Random arrays: generates arrays
- Random arrays → Native dispatch: requests sampling
mlx_sparse/random/__init__.py - Native dispatch → Native sampling: dispatches
- Python user → Device runtime: selects device
- Preconditioners → Native dispatch: applies kernels
mlx_sparse/linalg/preconditioners.py - Preconditioners → Accelerate solves: may use
- Triangular solves → Solver utilities: uses utilities
src/linalg/triangular_solve/triangular_solve.cpp - Triangular solves → CPU parallelism: uses
src/linalg/triangular_solve/triangular_solve.cpp - Validation → Host utilities: reads metadata
mlx_sparse/_validation.py - Iterative solvers → Solver utilities: uses utilities