Skip to main content

Welcome to WAGGON: WAssrestein Global Gradient-free OptimisatioN

PyPI version Documentation Downloads License: MIT

WAGGON is a python library of black box gradient-free optimisation. Currently, the library contains implementations of optimisation methods based on Wasserstein uncertainty and baseline approaches from the following papers:

  • Tigran Ramazyan, Mikhail Hushchyn and Denis Derkach. Global Optimisation of Black-Box Functions with Generative Models in the Wasserstein Space, 2024.[arxiv] [ECAI 2024 Proceedings]

Implemented methods

  • Wasserstein Uncertainty Global Optimisation (WU-GO)
  • Bayesian optimisation: via Expected Improvement (EI), Lower and Upper Confidence Bounds (LCB, UCB)

Installation

pip install waggon

or

git clone https://github.com/hse-cs/waggon
cd waggon
pip install -e

Basic usage

(See more examples in the documentation.)

The following code snippet is an example of surrogate optimisation.

import waggon
from waggon.optim import SurrogateOptimiser

from waggon.acquisitions import WU
from waggon.surrogates.gan import WGAN_GP as GAN
from waggon.test_functions import three_hump_camel

# initialise the function to be optimised
func = three_hump_camel()
# initialise the surrogate to carry out optimisation
surr = GAN()
# initialise optimisation acquisition function
acqf = WU()

# initialise optimiser
opt = SurrogateOptimiser(func=func, surr=surr, acqf=acqf)

# run optimisation
opt.optimise()

# visualise
waggon.utils.display()

Support

Metadata

Release files for waggon 0.7.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for waggon 0.7.1
File Size Uploaded Provenance Actions
waggon-0.7.1.tar.gz 27.8 kB Without provenance Details for waggon-0.7.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for waggon 0.7.1
File Interpreter ABI Platform Actions
waggon-0.7.1-py3-none-any.whl Python 3 none any Details for waggon-0.7.1-py3-none-any.whl

Total release size: 64.2 kB

Release files / waggon-0.7.1.tar.gz

Download URL waggon-0.7.1.tar.gz
Size 27.8 kB
Tags Source
SHA-256 checksum
How to use checksums
34394799f0232ee315eb0e6f48e22efcb7ab1706a2b9b8da707754251e9c3a2f
BLAKE2b-256 checksum
How to use checksums
7ef4f55f3d84a05a99732e8418378dfe1dc97809c308019646f7d6edbefa4792
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.12.8

Release files / waggon-0.7.1-py3-none-any.whl

Download URL waggon-0.7.1-py3-none-any.whl
Size 36.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
53af74dccdd07572d95cefcbb1ba70821bef165b89f4cf1ffb16f51bfd611537
BLAKE2b-256 checksum
How to use checksums
d35a469129a8d6366dbe79f5cb09fa4df157d9302871ab01696158faf01ed058
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.12.8

Security for waggon 0.7.1

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.7.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page