kooplearn 2.0.0rc1

A python package for evolution operator learning

kooplearn is a Python library to learn evolution operators — also known as Koopman or Transfer operators — from data. kooplearn models can:

1. Predict the evolution of states and observables.
2. Estimate the eigenvalues and eigenfunctions of the learned evolution operators.
3. Compute the dynamic mode decomposition of states and observables.
4. Learn neural-network representations $x_t \mapsto \varphi(x_t)$ for evolution operators.

Why Choosing kooplearn?

1. It is easy to use and strictly adheres to the scikit-learn API.

2. Kernel estimators are state-of-the-art:

   • kooplearn implements the Reduced Rank Regressor from Kostic et al. 2022, which is provably better than the classical kernel DMD in estimating eigenvalues and eigenfunctions.
   • It also implements Nyström estimators and randomized estimators randomized for blazingly fast kernel learning.

3. Includes representation-learning losses (implemented both in Pytorch and JAX) to train neural-network Koopman embeddings.

4. Offers a collection of datasets for benchmarking evolution-operator learning algorithms.

Installation

To install the core version of kooplearn:

pip

pip install kooplearn

uv

uv add kooplearn

To enable neural-network representations using kooplearn.torch or kooplearn.jax:

pip

# Torch
pip install "kooplearn[torch]"
# JAX
pip install "kooplearn[jax]"

uv

# Torch
uv add "kooplearn[torch]"
# JAX
uv add "kooplearn[jax]"

Contributing

We welcome contributions from the community! If you're interested in contributing to kooplearn, please follow these steps:

1. Fork the repository on GitHub.
2. Clone your forked repository to your local machine.
3. Create a new branch for your feature or bug fix: git checkout -b feature/your-feature-name or git checkout -b bugfix/issue-number.
4. Make your changes and commit them with descriptive commit messages.
5. Push your changes to your forked repository.
6. Create a pull request from your branch to the main branch of the original repository.
7. Provide a clear title and description for your pull request, including any relevant information about the changes you've made.

We appreciate your contributions and will review your pull request as soon as possible. Thank you for helping improve kooplearn!

License

This project is licensed under the MIT License.

Main contributors

kooplearn is an joint effort between teams at the Italian Institute of Technology in Genoa and the École polytechnique in Paris. The main contributors to the project are (in alphabetical order):

• Vladimir Kostic
• Karim Lounici
• Giacomo Meanti
• Erfan Mirzaei
• Pietro Novelli
• Daniel Ordonez
• Grégoire Pacreau
• Massimiliano Pontil
• Giacomo Turri

The mantainer of this repo is Pietro Novelli.

---

We hope you find kooplearn useful for your dynamical systems analysis. If you encounter any issues or have suggestions for improvements, please don't hesitate to raise an issue. Happy coding!