BEEBO
Batched Energy-Entropy acquisition for Bayesian Optimization
This repository provides a BoTorch/GPyTorch implementation of the BEEBO acquisition function for batched Bayesian Optimization.
Installation
To install the package, run
pip install beebo
Alternatively, clone the repository and run pip install -e.
Usage
The BEE-BO acquisition function is fully compatible with BoTorch and is implemented as an AnalyticAcquisitionFunction. It can be used as follows, using standard BoTorch utilities.
from beebo import BatchedEnergyEntropyBO
from botorch.optim.optimize import optimize_acqf
# `model` is e.g. a SingleTaskGP trained according to BoTorch's tutorials
# `bounds` is the search space of the optimization problem
amplitude = model.covar_module.outputscale.item() # get the GP's kernel amplitude
acq_fn = BatchedEnergyEntropyBO(
model, # a gaussian process model.
temperature=1.0,
kernel_amplitude=amplitude,
energy_function='sum', # "sum" for meanBEEBO, "softmax" for maxBEEBO
logdet_method='svd', # LinAlg: how to compute log determinants
augment_method='naive', # LinAlg: how to perform the train data augmentation
)
points, value = optimize_acqf(
acq_fn,
q=100,
num_restarts=10,
bounds=bounds, # the bounds of the optimization problem
raw_samples=100,
)
For setting up model and bounds, please refer to BoTorch's tutorials.
Hyperparameters
The explore-exploit trade-off of BEE-BO is controlled using its temperature parameter. In the code snippet above, we additionally use the kernel amplitude (output scale) to scale the temperature internally, so that it is comparable to the beta parameter in the standard Upper Confidence Bound (UCB) acquisition function. When the kernel_amplitude is 1.0, the scaling has no effect and you recover the "pure" BEE-BO acquisition function,
$a(\mathbf{x})=-E(\mathbf{x})+T*I(\mathbf{x})$.
Experiments
Please see the benchmark directory in the repository for the code to perform the benchmark experiments from the paper.
Configuring the linear algebra routines for BEE-BO
-
Log determinants:
The
BatchedEnergyEntropyBOconstructor accepts alogdet_methodargument, which can be set tosvd,choleskyottorch.- The default is
svd, which is stable, at the expense of being slow. choleskyexploits the PSD structure by computing the log determinant from a cholesky decomposition, which is fast but can suffer from numerical instability.torchsimply uses PyTorch'slogdetfunction, which can also suffer from numerical instability.
- The default is
-
GP augmentation with new training observations:
The
BatchedEnergyEntropyBOconstructor accepts aaugment_methodargument, which can be set tonaive,choleskyorget_fantasy_model.- The default is
naive, which simply keeps a second GP and callsset_train_datawith augmented tensors. This uses default GPytorch infrastructure, does not suffer from any memory leaks, but requires recomputing all caches. choleskyperforms a low rank update to the precomputed cholesky decomposition of the train-train covariance, and then computes the posterior covariance via a cholesky solve. In our experiments, this was faster than both the naive approach and the LOVE low-rank update.get_fantasy_modeluses GPyTorch'sget_fantasy_modelmethod, which can perform a low rank update when using LOVE, but suffers from a memory leak when using gradients. Also, the low rank update is contingent on a pending patch at https://github.com/cornellius-gp/gpytorch/pull/2494.
- The default is
Implementation notes
Log determinants are computed using singular value decomposition (SVD) for numerical stability.
BEE-BO requires temporarily adding the query data points as training data points to the GP model in the forward pass to compute the information gain. GPyTorch offers some functionality for that, such as set_train_data or get_fantasy_model. In our experiments with GPyTorch 1.11, both these approaches resulted in memory leaks when running with gradients enabled. As a workaround, we duplicate the GP model via deepcopy when initializing the acquisition function, and then set the train data of the duplicated GP before calling it to compute the augmented posterior. This, together with adding the posterior mean multiplied by 0 to the result, seems to be avoiding memory leaks for the current version.
Due to these workarounds, the forward method thus may look a bit convoluted. The methods compute_energy and compute_entropy are not used for above reasons, but show the core operations of the BEE-BO algorithm in a more readable way.
Metadata
Release files for beebo 0.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| beebo-0.0.2.tar.gz | 12.6 kB | Without provenance | Details for beebo-0.0.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| beebo-0.0.2-py3-none-any.whl | Python 3 | none | any | Details for beebo-0.0.2-py3-none-any.whl |
Total release size: 23.7 kB
Release files / beebo-0.0.2.tar.gz
| Download URL | beebo-0.0.2.tar.gz |
|---|---|
| Size | 12.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6e456efbc008518674b091a6811d11d1b1a17f6446a9cc0d351dfc29e25028d8
|
|
BLAKE2b-256 checksum How to use checksums |
9a9b3f9dd9fb55f3219a4f29bcc4bd9d9d44d56bb48f525b7249306a06b32bb8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.9.19
|
Release files / beebo-0.0.2-py3-none-any.whl
| Download URL | beebo-0.0.2-py3-none-any.whl |
|---|---|
| Size | 11.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9f42408b7cf08487377d1390e0d086f031c28d6ea87158f000409a60c85ba0e4
|
|
BLAKE2b-256 checksum How to use checksums |
0da81d7a458b44654191de3765c2ddbfb487a04e63a982631d400f1eb31d11af
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.9.19
|
Security for beebo 0.0.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.