From ffb73df5f9c4ce47bf8cd165bb10870da7ee4db0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicholas=20Kr=C3=A4mer?= Date: Mon, 15 Jan 2024 10:42:57 +0100 Subject: [PATCH] Update the README to include new functionality --- README.md | 10 +++++----- matfree/polynomial.py | 6 +++++- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d99f389..7c84855 100644 --- a/README.md +++ b/README.md @@ -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) diff --git a/matfree/polynomial.py b/matfree/polynomial.py index 016ceb8..081b7dd 100644 --- a/matfree/polynomial.py +++ b/matfree/polynomial.py @@ -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