Skip to main content

A standard for generating test points and exchanging variables, objectives, and constraints in optimization problems

Project description

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

Project details


Release history Release notifications | RSS feed

This version

0.1

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.1.tar.gz (13.0 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.1-py3-none-any.whl (13.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for gest_api-0.1.tar.gz
Algorithm Hash digest
SHA256 c5712721072fab8fdef7e976d4140db99729245f34ff36eefc0737c5197d25a8
MD5 604a08679cc9ed16d64bae496caf6ee3
BLAKE2b-256 d905e0abb7062a8c92059592ecdd5bc857de70ab7bfaedf86b084e99e6bbc5c2

See more details on using hashes here.

Provenance

The following attestation bundles were made for gest_api-0.1.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.1-py3-none-any.whl.

File metadata

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

File hashes

Hashes for gest_api-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8dad05c867c631e84bdd559acad030b0a5a2a2930f82ef7ec6f3e7bd655187b3
MD5 c3689aed1a218efb71934ffe471ec821
BLAKE2b-256 ef71739438702088c7ec2a5d4dcd605f0801e378e907a215ad2866164b6bec33

See more details on using hashes here.

Provenance

The following attestation bundles were made for gest_api-0.1-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.

Supported by

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