Skip to content

Commit

Permalink
Update the README to include new functionality
Browse files Browse the repository at this point in the history
  • Loading branch information
pnkraemer committed Jan 15, 2024
1 parent dfca7e5 commit ffb73df
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ Randomised and deterministic matrix-free methods for trace estimation, matrix fu
Builds on [JAX](https://jax.readthedocs.io/en/latest/).



- ⚡ A stand-alone implementation of **stochastic Lanczos quadrature**
- ⚡ Stochastic **trace estimation** including batching, control variates, and uncertainty quantification
- ⚡ Matrix-free matrix decompositions for **large sparse eigenvalue problems**
- ⚡ A stand-alone implementation of **stochastic Lanczos quadrature**
- ⚡ Matrix-decomposition algorithms for **large sparse eigenvalue problems**
- ⚡ Polynomial methods for approximating **functions of large matrices**

and many other things.
Everything is natively compatible with JAX' feature set:
JIT compilation, automatic differentiation, vectorisation, and pytrees.
Everything is natively compatible with the rest of JAX:
JIT compilation, automatic differentiation, vectorisation, and PyTrees.
[_Let us know what you think about matfree!_](https://github.com/pnkraemer/matfree/issues)


Expand Down
6 changes: 5 additions & 1 deletion matfree/polynomial.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
"""Approximate matrix-function-vector products with polynomial expansions."""
"""Approximate matrix-function-vector products with polynomial expansions.
This module does not include Lanczos-style approximations, which are
in [matfree.lanczos][matfree.lanczos].
"""

from matfree.backend import containers, control_flow, np
from matfree.backend.typing import Array
Expand Down

0 comments on commit ffb73df

Please sign in to comment.