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
libEnsemblegenerators inOptimas: APOSMM NLopt - IBCDFOUsing
Xoptgenerators inOptimas: Multiple ExamplesUsing
Xoptgenerators inlibEnsemble: ExpectedImprovement - (with Xopt-style sim)Using
Optimasgenerators inlibEnsemble: Multi-Fidelity Ax GeneratorUsing
libEnsemblegenerators inXopt: 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'sgen_ffunction, and is not itself "workflow" software. -
Variables, Objectives, Constraints (VOCS):
A
VOCSis 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
Metadata
Release files for gest-api 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 | |
|---|---|---|---|
| gest_api-0.2.tar.gz | 14.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| gest_api-0.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 29.2 kB
Release files / gest_api-0.2.tar.gz
| Download URL | gest_api-0.2.tar.gz |
|---|---|
| Size | 14.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6d57127bcaca088fd76340b972ac19852cd9e6467df6fbaa7594534dee22285e
|
|
BLAKE2b-256 checksum How to use checksums |
0d448f089e3cd8a58fa815a086ef599e2e3fb3014fb3f754caebff80a637c484
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 17, 2026.
Transparency logRelease files / gest_api-0.2-py3-none-any.whl
| Download URL | gest_api-0.2-py3-none-any.whl |
|---|---|
| Size | 14.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bdb3cf411d35053c0f744c940ebd72bf87b90facc9545f277263e3ccb9ca7b1f
|
|
BLAKE2b-256 checksum How to use checksums |
a6d4aeadf7cc70988442af8a2d36a7b2d1dc4b4677985396d6f2d5504efa0a29
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 17, 2026.
Transparency log