Mohan Wu, Martin Lysy
rodeo is a fast and flexible Python front-end library with a Fortran/C++ back-end that uses probabilistic numerics to solve ordinary differential equations (ODEs). That is, most ODE solvers (such as Euler's method) produce a deterministic approximation to the ODE on a grid of size delta
. As delta
goes to zero, the approximation converges to the true ODE solution. Probabilistic solvers such as rodeo also output a solution an a grid of size delta
; however, the solution is random. Still, as delta
goes to zero, the probabilistic numerical approximation converges to the true solution.
rodeo implements the probabilistic solver of Chkrebtii et al (2016). This begins by putting a Gaussian process prior on the ODE solution, and updating it sequentially as the solver steps through the grid. The user-facing interface is written in Python to allow for a wide appeal. The back-end is a time-varying Kalman filter implemented in C++ and Fortran using state-of-the-art linear algrebra routines found here. rodeo is 10-40x faster than a pure Python implementation, achieving comparable speeds to the widely-used deterministic solver odein in the Scipy library. Various low-level backends are provided in the following modules:
-
rodeo.cython
: This module performs the underlying linear algebra using the BLAS/LAPACK routines provided by NumPy through a Cython interface. To maximize speed, no input checks are provided. All inputs must befloat64
NumPy arrays in Fortran order. -
rodeo.eigen
: This module uses the C++ Eigen library for linear algebra. The interface is also through Cython.
Here again we have the same input requirements and lack of checks. Eigen is known to be faster than most BLAS/LAPACK implementations, but it needs to be compiled properly to achieve maximum performance. In particular this involves linking against an installed version of Eigen (not provided) and setting the right compiler flags for SIMD and OpenMP support. Some defaults are provided insetup.py
, but tweaks may be required depending on the user's system. -
rodeo.numba
: This module once again uses BLAS/LAPACK but the interface is through Numba. Here input checks are performed and the inputs can be in either C or Fortran order, and single or double precision (float32
andfloat64
). However, C ordered arrays are first converted to Fortran order, so the latter is preferable for performance considerations.
Download the repo from GitHub and then install with the setup.py
script:
git clone https://github.com/mlysy/rodeo.git
cd rodeo
pip install .
The unit tests are done against the deterministic ode solver odeint to ensure that the solutions are approximately equal. They can be ran through the following commands:
cd tests
python -m unittest discover -v
We provide four separate ODE problems as examples to demonstrate the capabilities of rodeo. These examples are best viewed in the examples/tutorial.ipynb
jupyter notebook, hence extra installations are required.
pip install .[examples]
The HTML documentation can be compiled from the kalmantv root folder:
pip install .[docs]
cd docs
make html
This will create the documentation in docs/build
.
Please see the detailed example in the tutorial here. Running the tutorial compares the deterministic Euler solver to the probabilistic solver for the ODE initial value problem
x_t^{(2)} = sin(2t) - x_t^{(0)}
x_0^{(1)} = 0
x_0^{(0)} = -1
The results for N = 50, 100, and 200 grid points for both solvers is shown below.
rodeo is also capable of performing parameter inference. An example of this is on the FitzHugh-Nagumo model in the tutorial. A comparison of the deterministic Euler solver to the probabilistic solver is shown below.