pyrevolve 2.2.4

Python wrapper for Revolve checkpointing

Checkpointing

The adjoint computation of an unsteady nonlinear primal function requires the full primal trajectory in reverse temporal order. Storing this can exceed the available memory. In that case, Checkpointing can be used to store the state only at carefully selected points in time. From there, the forward computation can be restarted to recompute lost sections of the trajectory when they are needed during the adjoint computation. This is always a tradeoff between memory and runtime. The classic and provably optimal way to do this for a known number of time steps is Revolve, and there are other algorithms for optimal online checkpointing if the number of steps is unknown a priori, or for multistage checkpointing if there are multiple layers of storage, e.g. memory and hard drive.

PyRevolve

The pyrevolve library contains two parts: crevolve, which is a thin Python wrapper around a previously published C++ implementation, and pyrevolve itself, which sits on top of crevolve and manages data and computation management for the user.

The C++ files in this package are slightly modified to play more nicely with Python, but the original is available from the link below. In addition, there is a C wrapper around the C++ library, to simplify the interface with Python. This C wrapper is taken from libadjoint.

Installation

Since PyRevolve is distributed as source, you must have a functional C/C++ compiler in your environment before trying to install PyRevolve. The installation procedure respects the standard environment variables like CC/CXX.

The simplest installation is through pip by simply doing:

pip install pyrevolve

If you would like to have a local development copy that you can edit, clone the repo and call the following command in the home directory:

pip install -e .

If you face any installation issues, first check that you really do have a functional C++ compiler, either available as g++ in the path or pointed to by the environment variable CXX. If this is not the reason, please raise a issue here or on this Slack channel.

Usage

There are two wrappers: a classic wrapper that follows the behaviour of Revolve as described in the papers, and leaves the data mangement, the actual copying of data, and the calling of operators to the user. An example of how to use it can be executed by calling

python examples/use_classic.py

The other, modernised wrapper, takes care of all this. The user creates a Revolver object, and passes a forward operator, reverse operator, and checkpoint operator to it. The Revolver provides two important methods: apply_forward, and apply_reverse. A call to apply_forward executes the forward computation, while creating the necessary checkpoints for the reverse computation. After this, a user may also call the apply_reverse method to compute the adjoints.

For this to work, the user is responsible that the operators have an apply() method that takes arguments t_start and t_end, and that the checkpoint object has a property size to report the size of one checkpoint, and methods load(ptr) and save(ptr) that deep-copy all time-dependent live data into a location given in ptr.

An example of this can be found here:

python examples/use_modernised.py