Skip to main content

gpCAM is a code for autonomous data acquisition

Project description

gpCAM

PyPI Documentation Status gpCAM CI Codecov PyPI - License DOI

gpCAM (gpcam.lbl.gov) is an API and software designed to make advanced Gaussian Process function approximation and autonomous data acquisition/Bayesian Optimization for experiments and simulations more accurate, faster, simpler, and more widely available. The tool is based on a flexible and powerful Gaussian process regression at the core. The flexibility stems from the modular design of gpCAM which allows the user to implement and import their own Python functions to customize and control almost every aspect of the software. That makes it possible to easily tune the algorithm to account for various kinds of physics and other domain knowledge and to identify and find interesting features, in Euclidean and non-Euclidean spaces. A specialized function optimizer in gpCAM can take advantage of HPC architectures for fast analysis time and reactive autonomous data acquisition. gpCAM broke a 2019 record for the largest exact GP ever run! Below you can see a simple example of how to set up an autonomous experimentation loop.

Usage

The following demonstrates a simple usage of the gpCAM API (see interactive demo).

!pip install gpcam

from gpcam.autonomous_experimenter import AutonomousExperimenterGP
import numpy as np

def instrument(data):
    for entry in data:
        entry["y_data"] = np.sin(np.linalg.norm(entry["x_data"]))
    return data

##set up your parameter space
parameters = np.array([[3.0,45.8],
                       [4.0,47.0]])

##set up some hyperparameters, if you have no idea, set them to 1 and make the training bounds large
init_hyperparameters = np.array([1,1,1])
hyperparameter_bounds =  np.array([[0.01,100],[0.01,100.0],[0.01,100]])

##let's initialize the autonomous experimenter ...
my_ae = AutonomousExperimenterGP(parameters, init_hyperparameters,
                                 hyperparameter_bounds,instrument_function = instrument,  
                                 init_dataset_size=10, info=False)
#...train...
my_ae.train()

#...and run. That's it. You successfully executed an autonomous experiment.
my_ae.go(N = 100)

Credits

Main Developer: Marcus Noack (MarcusNoack@lbl.gov) Many people from across the DOE national labs (especially BNL) have given insights that led to the code in it's current form. See AUTHORS for more details on that.

======= History

6.0.0 (2020-10-26)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gpcam-8.0.6.tar.gz (11.9 MB view details)

Uploaded Source

Built Distribution

gpcam-8.0.6-py2.py3-none-any.whl (52.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file gpcam-8.0.6.tar.gz.

File metadata

  • Download URL: gpcam-8.0.6.tar.gz
  • Upload date:
  • Size: 11.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for gpcam-8.0.6.tar.gz
Algorithm Hash digest
SHA256 098bd78acd8df69f33d069ad5ea6b738df9ed8f5e658d915fe936eb7b9d2b0f3
MD5 eefb9e8571365d3c4b3fff20c05f5de0
BLAKE2b-256 37dd9eafada0359e35744ac85e4187f3230e3085b2cb5d2cdc8c566e0297c22b

See more details on using hashes here.

Provenance

File details

Details for the file gpcam-8.0.6-py2.py3-none-any.whl.

File metadata

  • Download URL: gpcam-8.0.6-py2.py3-none-any.whl
  • Upload date:
  • Size: 52.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for gpcam-8.0.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 cdf3a799e4c8336fdd7392076fb0daecb2730f25e898e01e2303c6b9479f7271
MD5 86ec1240877db487a868a3c72de7a84c
BLAKE2b-256 3c36707f10c512c3a9fc0b33d2bb03c16f4a637827d9f5c52ba732c17a271ddb

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page