Skip to main content

Evolutionary strategy with file persistence and schema reconciliation.

Project description

Leitwerk

Leitwerk

Tune your magic numbers with stochastic optimization.

leitwerk is a schema-based evolutionary optimizer for long-running training loops.

It offers:

  • parameters as plain dataclasses in your code
  • JSON checkpoints you can inspect and resume
  • schema reconciliation, so you can keep developing and retain progress

Links

Installation

Requires: Python >=3.11,<3.14

pip install leitwerk

For a local development setup with testing, linting and burnysc2:

pip install -e .[dev,docs,benchmark]

The StarCraft II example also requires the game itself or Docker to be installed.

Minimal Example

At base level, leitwerk is a sequential ask/tell function maximizer:

from leitwerk import Optimizer, Parameter

opt = Optimizer({"x": Parameter()})
for _ in range(100):
    x = opt.ask()["x"]
    fx = -(x - 1)**2
    opt.tell(fx)
>>> opt.mean
{'x': 1.0007710964577097}

Everything else is wrapping for easier representation, bounds, typing and persistence.

Example - StarCraft II Bot

For a real training loop showcasing most features, see examples/train_sc2_bot.py:

  • a simple worker rush bot with two parameters
  • runs games continually against the built-in AI
  • scores each game using win/loss and a combat heuristic
  • persists state with OptimizerSession and plot results

Run it directly if you want to observe the games:

python examples/train_sc2_bot.py

Alternatively, use the headless Docker setup:

cd examples
docker compose up --build

On the first run, this will download and unpack the SC2 Linux installation inside the container. Afterward, it will run significantly faster than the rendered game on the host.

Training Results

The example saves progress in examples/data after each game:

  • params.json: optimizer state
  • plot.png: graphs showing parameter samples and results with a moving average
  • history.json: helper file

Example Plot

Developer Commands

  • make fix: auto-format
  • make check: lint and test
  • make docs: build docs
  • make docs-serve: serve docs locally

Project details


Download files

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

Source Distribution

leitwerk-0.7.2.tar.gz (28.7 kB view details)

Uploaded Source

Built Distribution

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

leitwerk-0.7.2-py3-none-any.whl (21.8 kB view details)

Uploaded Python 3

File details

Details for the file leitwerk-0.7.2.tar.gz.

File metadata

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

File hashes

Hashes for leitwerk-0.7.2.tar.gz
Algorithm Hash digest
SHA256 fc9db3a9107e93045c4af170496afe7044380574494ca7823891c53f9ebb95d5
MD5 adfa1b4473a7c2c1f875b917500e2510
BLAKE2b-256 6670add068512dedbdb6cc950b71cebf18c3957a38db71c1b8740b42c2ae360e

See more details on using hashes here.

Provenance

The following attestation bundles were made for leitwerk-0.7.2.tar.gz:

Publisher: ci.yml on phantomsc2/leitwerk

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

File details

Details for the file leitwerk-0.7.2-py3-none-any.whl.

File metadata

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

File hashes

Hashes for leitwerk-0.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 31ad2aaab0b63b2441230c911df24954194f77bf018925ed558bab8cda445cff
MD5 cc462862aca4b9c2b26c41792e7d3f11
BLAKE2b-256 20fc63025beca7bb31cfd9a5a845f8b64c9e16e0384abea55e9618e162b792bc

See more details on using hashes here.

Provenance

The following attestation bundles were made for leitwerk-0.7.2-py3-none-any.whl:

Publisher: ci.yml on phantomsc2/leitwerk

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