Skip to main content

![Python versions](https://img.shields.io/pypi/pyversions/deepopt) [![License](https://img.shields.io/pypi/l/deepopt)](https://pypi.org/project/deepopt/) ![Activity](https://img.shields.io/github/commit-activity/m/LLNL/deepopt) [![Issues](https://img.shields.io/github/issues/LLNL/deepopt)](https://github.com/LLNL/deepopt/issues) [![Pull requests](https://img.shields.io/github/issues-pr/LLNL/deepopt)](https://github.com/LLNL/deepopt/pulls)

<!– This page needs links once the repo is released and docs are published –>

Visit the [DeepOpt documentation](./docs/README.md) for more information on DeepOpt that’s not covered in this README.

## What is DeepOpt?

DeepOpt is a simple and easy-to-use library for performing Bayesian optimization, leveraging the powerful capabilities of [BoTorch](https://botorch.org/). Its key feature is the ability to use neural networks as surrogate functions during the optimization process, allowing Bayesian optimization to work smoothly even on large datasets and in many dimensions. DeepOpt also provides simplified wrappers for BoTorch fitting and optimization routines.

### Key Commands

The DeepOpt library comes equipped with two cornerstone commands:

  1. Learn: The learn command trains a machine learning model on a given set of data. Users can select a Gaussian process (GP), delta-UQ neural network (delUQ), or neural-network ensemble (nnEnsemble) surrogate. Uncertainty quantification (UQ) is available in all models, allowing for direct use in a Bayesian optimization workflow. The learn command supports multi-fidelity modeling with an arbitrary number of fidelities.

  2. Optimize: The optimize command takes the previously trained model created through the learn command and runs a single Bayesian optimization step, proposing a set of candidate points aimed at improving the value of the objective function (output of the learned model). The user can choose between several available acquisition methods for selecting the candidate points. Support for optimization under input uncertainty and risk is available.

## Why DeepOpt?

DeepOpt is a powerful and versatile Bayesian optimization framework that provides users with the flexibility to choose between Gaussian process (GP) and neural network (NN) surrogates. This flexibility empowers users to select the most suitable surrogate model for their specific optimization problem, taking into account factors such as the complexity of the objective function and the available computational resources.

## Installation

DeepOpt is available via [PyPI](https://pypi.org/) and can be easily installed with:

`bash pip install deepopt `

For a quick start guide, see [Getting Started with DeepOpt](./docs/index.md#getting-started-with-deepopt).

## Contributing

See the [Contributing Page](./docs/contributing.md).

## Contact Us

Email: [deepopt@llnl.gov](mailto:deepopt@llnl.gov)

Teams (LC users only): [DeepOpt Teams Page](https://teams.microsoft.com/l/team/19%3aZtbEv_dMMAmf5ObemhhCg1rwtlONspUfpOqSHyNYTQg1%40thread.tacv2/conversations?groupId=30e71349-7146-441a-befd-b938f465499a&tenantId=a722dec9-ae4e-4ae3-9d75-fd66e2680a63)

## License

DeepOpt is released under an MIT license. For more information, please see the [LICENSE](./LICENSE.md) and the [NOTICE](./NOTICE.md).

LLNL-CODE-2006544

Download files

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

Source Distribution

deepopt-1.1.0.tar.gz (77.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

deepopt-1.1.0-py3-none-any.whl (66.3 kB view details)

Uploaded Python 3

File details

Details for the file deepopt-1.1.0.tar.gz.

File metadata

  • Download URL: deepopt-1.1.0.tar.gz
  • Upload date:
  • Size: 77.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for deepopt-1.1.0.tar.gz
Algorithm Hash digest
SHA256 b1fd58ce7e85b574531d9794056c88ee1e8fa5880bcc3d7098a902af25faa05d
MD5 9cb95c87b73c71fd0ab8d944a8e54f54
BLAKE2b-256 1ab5c01ead78e57f8e4969df060d28b4a3cb4ec1fadcee7b1a23be0c9fe937a9

See more details on using hashes here.

Provenance

The following attestation bundles were made for deepopt-1.1.0.tar.gz:

Publisher: publish-python.yml on llnl/deepopt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file deepopt-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: deepopt-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 66.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for deepopt-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c8453e974c41704359851c2da45ac397985b6e16ece00e9b4b1ec0086a1cc1c0
MD5 32e92c384126cdae86de18ea76f84159
BLAKE2b-256 937f8d6f328d25dd4e697d55101aede8eb5db7beac9bc26cef37a5a0df77ce66

See more details on using hashes here.

Provenance

The following attestation bundles were made for deepopt-1.1.0-py3-none-any.whl:

Publisher: publish-python.yml on llnl/deepopt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

1.2.0

2 files

This release

1.1.0 This release

2 files

1.0.0

2 files

0.2.7

2 files

0.2.6

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.1.8

2 files

0.1.7

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page