MuyGPs is a scalable approximate Gaussian process (GP) model that affords fast prediction and hyperparameter optimization while retaining high-quality predictions and uncertainty quantifiction. MuyGPs achieves best-in-class speed and scalability by limiting inference to the information contained in k nearest neighborhoods for prediction locations for both hyperparameter optimization and tuning. This feature affords leave-one-out cross-validation optimizating a regularized loss function to optimize hyperparameters, as opposed to the more expensive likelihood evaluations required by similar sparse methods.
Automatically-generated documentation can be found at readthedocs.io.
Our documentation includes several jupyter notebook tutorials at
docs/examples
.
These tutorials are also include in the
online documentation.
See in particular the
univariate regression tutorial
for a step-by-step introduction to the use of MuyGPyS
.
See also the
regression api tutorial
describing how to coalesce the same simple workflow into a one-line call.
A deep kernel model inserting a MuyGPs layer into a PyTorch neural network can
be found in the torch tutorial.
As of release v0.6.6, MuyGPyS
supports four distinct backend implementations
of all of its underlying math functions:
numpy
- basic numpy (the default)- JAX - GPU acceleration
- PyTorch - GPU acceleration and neural network integration
- MPI - distributed memory acceleration
It is possible to include the dependencies of any, all, or none of these backends at install time. Please see the below installation instructions.
MuyGPyS
uses the MUYGPYS_BACKEND
environment variable to determine which
backend to use import time.
It is also possible to manipulate MuyGPyS.config
to switch between backends
programmatically.
This is not advisable unless the user knows exactly what they are doing.
MuyGPyS
will default to the numpy
backend.
It is possible to switch back ends by manipulating the MUYGPYS_BACKEND
environment variable in your shell, e.g.
$ export MUYGPYS_BACKEND=jax # turn on JAX backend
$ export MUYGPYS_BACKEND=torch # turn on Torch backend
$ export MUYGPYS_BACKEND=mpi # turn on MPI backend
MuyGPyS
supports just-in-time compilation of the
underlying math functions to CPU or GPU using
JAX since version v0.5.0.
The JAX-compiled versions of the code are significantly faster than numpy,
especially on GPUs.
In order to use the MuyGPyS
torch backend, run the following command in your
shell environment.
$ export MUYGPYS_BACKEND=jax
The MPI version of MuyGPyS
performs all tensor manipulation in distributed
memory.
The tensor creation functions will in fact create and distribute a chunk of each
tensor to each MPI rank.
This data and subsequent data such as posterior means and variances remains
partitioned, and most operations are embarassingly parallel.
Global operations such as loss function computation make use of MPI collectives
like allreduce.
If the user needs to reason about all products of an experiment, such the full
posterior distribution in local memory, it is necessary to employ a collective
such as MPI.gather
.
The wrapped KNN algorithms are not distributed, and so MuyGPyS
does not yet
have an internal distributed KNN implementation.
Future versions will support a distributed memory approximate KNN solution.
The user can run a script myscript.py
with MPI using, e.g. mpirun
(or srun
if using slurm) via
$ export MUYGPYS_BACKEND=mpi
$ # mpirun version
$ mpirun -n 4 python myscript.py
$ # srun version
$ srun -N 1 --tasks-per-node 4 -p pbatch python myscript.py
The torch
version of MuyGPyS
allows for construction and training of complex
kernels, e.g., convolutional neural network kernels. All low-level math is done
on torch.Tensor
objects. Due to PyTorch
's lack of support for the Bessel
function of the second kind, we only support special cases of the Matern kernel,
in particular when the smoothness parameter is
The MuyGPyS
framework is implemented as a custom PyTorch
layer. In the
high-level API found in examples/muygps_torch
, a PyTorch
MuyGPs model
is
assumed to have two components: a model.embedding
which deforms the original
feature data, and a model.GP_layer
which does Gaussian Process regression on
the deformed feature space. A code example is provided below.
Most users will want to use the MuyGPyS.torch.muygps_layer
module to construct
a custom MuyGPs model. The model can then be calibrated using a standard
PyTorch training loop. An example of the approach based on the low-level API
is provided in docs/examples/torch_tutorial.ipynb
.
In order to use the MuyGPyS
torch backend, run the following command in your
shell environment.
$ export MUYGPYS_BACKEND=torch
One can also use the following workflow to programmatically set the backend to torch, although the environment variable method is preferred.
from MuyGPyS import config
MuyGPyS.config.update("muygpys_backend","torch")
...subsequent imports from MuyGPyS
JAX and torch use 32 bit types by default, whereas numpy tends to promote
everything to 64 bits.
For highly stable operations like matrix multiplication, this difference in
precision tends to result in a roughly 1e-8
disagreement between 64 bit and 32
bit implementations.
However, MuyGPyS
depends upon matrix-vector solves, which can result in
disagreements up to 1e-2
.
Hence, MuyGPyS
forces all back end implementations to use 64 bit types by
default.
However, the 64 bit operations are slightly slower than their 32 bit
counterparts.
MuyGPyS
accordingly supports 32 bit types, but this feature is experimental
and might have sharp edges.
For example, MuyGPyS
might throw errors or otherwise behave strangely if the
user passes arrays of 64 bit types while in 32 bit mode.
Be sure to set your data types appropriately.
A user can have MuyGPyS
use 32 bit types by setting the MUYGPYS_FTYPE
environment variable to "32"
, e.g.
$ export MUYGPYS_FTYPE=32 # use 32 bit types in MuyGPyS functions
It is also possible to manipulate MuyGPyS.config
to switch between types
programmatically.
This is not advisable unless the user knows exactly what they are doing.
The index muygpys
is maintained on PyPI and can be installed using pip
.
muygpys
supports many optional extras flags, which will install additional
dependencies if specified.
If installing CPU-only with pip, you might want to consider the following flags:
These extras include:
hnswlib
- install hnswlib dependency to support fast approximate nearest neighbors indexingjax_cpu
- install JAX dependencies to support just-in-time compilation of math functions on CPU (see below to install on GPU CUDA architectures)torch
- install PyTorch dependencies to employ GPU acceleration and the use of theMuyGPyS.torch
submodulempi
- install MPI dependencies to support distributed memory parallel computation. Requires that the user has installed a version of MPI such as mvapich or open-mpi.
$ # numpy-only installation. Functions will internally use numpy.
$ pip install --upgrade muygpys
$ # The same, but includes hnswlib.
$ pip install --upgrade muygpys[hnswlib]
$ # CPU-only JAX installation. Functions will be jit-compiled using JAX.
$ pip install --upgrade muygpys[jax_cpu]
$ # The same, but includes hnswlib.
$ pip install --upgrade muygpys[jax_cpu,hnswlib]
$ # MPI installation. Functions will operate in distributed memory.
$ pip install --upgrade muygpys[mpi]
$ # The same, but includes hnswlib.
$ pip install --upgrade muygpys[mpi,hnswlib]
$ # pytorch installation. MuyGPyS.torch will be usable.
$ pip install --upgrade muygpys[torch]
JAX also supports just-in-time compilation to
CUDA, making the compiled math functions within MuyGPyS
runnable on NVidia
GPUS.
This requires you to install
CUDA and
CuDNN
in your environment, if they are not already installed, and to ensure that they
are on your environment's $LD_LIBRARY_PATH
.
See scripts for an example environment setup.
MuyGPyS
no longer supports automated GPU-supported JAX installation using pip
extras.
To install JAX as a dependency for MuyGPyS
to be deployed on cuda-capable
GPUs, please read and follow the
JAX installation instructions.
After installing JAX, the user will also need to install
Tensorflow Probability with a JAX
backend via
pip install tensorflow-probability[jax]>=0.16.0
MuyGPyS does not and most likely will not support installing CUDA PyTorch with an extras flag. Please install PyTorch separately.
This repository includes several extras_require
optional dependencies.
tests
- install dependencies necessary to run testsdocs
- install dependencies necessary to build the docsdev
- install dependencies for maintaining code style, running performance benchmarks, linting, and packaging (includes all of the dependencies intests
anddocs
).
For example, follow these instructions to install from source for development purposes with JAX support:
$ git clone [email protected]:LLNL/MuyGPyS.git
$ cd MuyGPyS
$ pip install -e .[dev,jax_cpu]
If you would like to perform a GPU installation from source, you will need to
install the jax dependency directly instead of using the jax_cuda
flag or
similar.
Additionally check out the develop branch to access the latest features in between stable releases. See CONTRIBUTING.md for contribution rules.
hnswlib
- install hnswlib dependency to support fast approximate nearest neighbors indexingjax_cpu
- install JAX dependencies to support just-in-time compilation of math functions on CPU (see below to install on GPU CUDA architectures)torch
- install PyTorchmpi
- install MPI dependency to support parallel computationtests
- install dependencies necessary to run testsdocs
- install dependencies necessary to build the docsdev
- install dependencies for maintaining code style, linting, and packaging (includes all of the dependencies intests
anddocs
)
In order to build the docs locally, first pip
install from source using either
the docs
or dev
options and then execute:
$ sphinx-build -b html docs docs/_build/html
Finally, open the file docs/_build/html/index.html
in your browser of choice.
In order to run tests locally, first pip
install MuyGPyS
from source using
either the dev
or tests
options.
All tests in the test/
directory are then runnable as python scripts, e.g.
$ python tests/kernels.py
Individual absl
unit test classes can be run in isolation, e.g.
$ python tests/kernels.py DifferencesTest
The user can run most tests in all backends.
Some tests use backend-dependent features, and will fail with informative error
messages when attempting an unsupported backend.
The user need only set MUYGPYS_BACKEND
prior to running the desired test,
e.g.,
$ export MUYGPYS_BACKEND=jax
$ python tests/kernels.py
If the MPI dependencies are installed, the user can also run absl
tests using
MPI, e.g. using mpirun
$ export MUYGPYS_BACKEND=mpi
$ mpirun -n 4 python tests/kernels.py
or using srun
$ export MUYGPYS_BACKEND=mpi
$ srun -N 1 --tasks-per-node 4 -p pdebug python tests/kernels.py
- Benjamin W. Priest (priest2 at llnl dot gov)
- Amanda L. Muyskens (muyskens1 at llnl dot gov)
- Alec M. Dunton (dunton1 at llnl dot gov)
- Imène Goumiri (goumiri1 at llnl dot gov)
MuyGPyS has been used the in the following papers (newest first):
- Scalable Gaussian Process Hyperparameter Optimization via Coverage Regularization
- Light Curve Completion and Forecasting Using Fast and Scalable Gaussian Processes (MuyGPs)
- Fast Gaussian Process Posterior Mean Prediction via Local Cross Validation and Precomputation
- Gaussian Process Classification fo Galaxy Blend Identification in LSST
- Star-Galaxy Image Separation with Computationally Efficient Gaussian Process Classification
- Star-Galaxy Separation via Gaussian Processes with Model Reduction
If you use MuyGPyS in a research paper, please reference our article:
@article{muygps2021,
title={MuyGPs: Scalable Gaussian Process Hyperparameter Estimation Using Local Cross-Validation},
author={Muyskens, Amanda and Priest, Benjamin W. and Goumiri, Im{\`e}ne and
Schneider, Michael},
journal={arXiv preprint arXiv:2104.14581},
year={2021}
}
MuyGPyS is distributed under the terms of the MIT license. All new contributions must be made under the MIT license.
See LICENSE-MIT, NOTICE, and COPYRIGHT for details.
SPDX-License-Identifier: MIT
LLNL-CODE-824804