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 .

For a development setup with tests, docs, benchmarks and burnysc2:

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

The SC2 example 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.1.tar.gz (28.6 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.1-py3-none-any.whl (21.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: leitwerk-0.7.1.tar.gz
  • Upload date:
  • Size: 28.6 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.1.tar.gz
Algorithm Hash digest
SHA256 49da5df3da3809ab41d1df96913ad83764946fe29bd05ec761baa7c1c0e34cb8
MD5 40405a10b08e4835df360ede7177a787
BLAKE2b-256 91108ed684928ef939293764207ccd93e0196f39e5f8b799080e4038276fa741

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: leitwerk-0.7.1-py3-none-any.whl
  • Upload date:
  • Size: 21.7 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 853aa6c39a7ed943f2a980497a45851ce66eadc34aa13a1e895aa6687eb1bfc1
MD5 e91cbbdc6ad9a2f61fee30d0f198c63c
BLAKE2b-256 6400c643cbe863889976dc21283dc299242f71d9f9912be9dcd5cec31e3c9773

See more details on using hashes here.

Provenance

The following attestation bundles were made for leitwerk-0.7.1-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