Overview

This repository is an effort to standardize the interface of the generators in optimization libraries such as:

The objective of this effort is for these different libraries to be able to use each other's generators with little effort.

Examples:

Using libEnsemble generators in Optimas: APOSMM NLopt - IBCDFO

Using Xopt generators in Optimas: Multiple Examples

Using Xopt generators in libEnsemble: ExpectedImprovement - (with Xopt-style sim)

Using Optimas generators in libEnsemble: Multi-Fidelity Ax Generator

Using libEnsemble generators in Xopt: APOSMM Generator

Definitions

  • Generator:

    A generator is an object that recommends points to be evaluated in an optimization. It can also receive data (evaluations from past or ongoing optimization), which helps it make more informed recommendations.

    Note: The generator does not orchestrate the overall optimization (e.g. dispatch evaluations, etc.). As such, it is distinct from libEnsemble's gen_f function, and is not itself "workflow" software.

  • Variables, Objectives, Constraints (VOCS):

    A VOCS is an object that specifies the names and types of components of the optimization problem that will be used by the generator. Each generator will validate that it can handle the specified set of variables, objectives, constraints, etc.

Documentation

For complete API documentation, examples, and detailed specifications, see the official documentation:

https://generator-standard.readthedocs.io

Installation

The Python abstract classes that define the standard can be installed with:

pip install gest-api

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for rlehe from gravatar.com rlehe Avatar for shuds13 from gravatar.com shuds13

Requires

Python >=3.10

Tags

optimization workflows generators

Classifiers

Report project as malware

Download files

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

Source Distribution

gest_api-0.2.tar.gz (14.4 kB view details)

Uploaded Source

Built Distribution

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

gest_api-0.2-py3-none-any.whl (14.7 kB view details)

Uploaded Python 3

File details

Details for the file gest_api-0.2.tar.gz.

File metadata

  • Download URL: gest_api-0.2.tar.gz
  • Upload date:
  • Size: 14.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for gest_api-0.2.tar.gz
Algorithm Hash digest
SHA256 6d57127bcaca088fd76340b972ac19852cd9e6467df6fbaa7594534dee22285e
MD5 419b57d4c42ac73e34e931b51ea51d79
BLAKE2b-256 0d448f089e3cd8a58fa815a086ef599e2e3fb3014fb3f754caebff80a637c484

See more details on using hashes here.

Provenance

The following attestation bundles were made for gest_api-0.2.tar.gz:

Publisher: publish-to-pypi.yml on campa-consortium/gest-api

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

File details

Details for the file gest_api-0.2-py3-none-any.whl.

File metadata

  • Download URL: gest_api-0.2-py3-none-any.whl
  • Upload date:
  • Size: 14.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for gest_api-0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 bdb3cf411d35053c0f744c940ebd72bf87b90facc9545f277263e3ccb9ca7b1f
MD5 106c4afa3d6cf49088a76e480e8635b9
BLAKE2b-256 a6d4aeadf7cc70988442af8a2d36a7b2d1dc4b4677985396d6f2d5504efa0a29

See more details on using hashes here.

Provenance

The following attestation bundles were made for gest_api-0.2-py3-none-any.whl:

Publisher: publish-to-pypi.yml on campa-consortium/gest-api

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

Release history Release notifications | RSS feed

This release

0.2 This release

2 files

0.1

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