Skip to main content

puggles-dashboard

The optional visual add-on for puggles, a fast NSGA-II / NSGA-III library with a Rust core. It adds a live browser dashboard, run replay, and side-by-side comparison of runs.

pip install "puggles[dashboard]"     # puggles plus this add-on, at matching versions

The core puggles wheel has no visual code. With this add-on installed, puggles.Dashboard, puggles.show, puggles.load, puggles.reference_front and python -m puggles.dashboard work. They load on first use, so import puggles stays as fast as before. You can also import the add-on directly as puggles_dashboard.

Watch a run

Pass a dashboard as the callback. The page shows:

  • the Pareto front in 2-D, 3-D, parallel coordinates or a scatter matrix
  • decision variables and convergence
  • a sortable table of solutions
import puggles as pg

ga = pg.NSGAII(problem, seed=42)
dash = pg.Dashboard(ga, objective_names=["cost", "risk"])   # opens a tab
ga.run(20_000, callback=dash)                              # live; the page's Stop button ends the run
dash.save("run.pgrun.json.gz")                              # replay: python -m puggles.dashboard run.pgrun.json.gz
dash.export_html("run.html")                                # a standalone page you can share
dash.wait()                                                 # in a script: keep the page up until Ctrl+C

While a run is being watched, you can:

  • pause it
  • filter and pin solutions
  • select the most balanced trade-off
  • see where each generation's time goes

The page loads Plotly.js from a CDN, so viewing needs an internet connection.

Speed. The server and the recorder are native. When a dashboard is the callback, run() records straight from the optimizer's Rust solutions and never builds Python objects per generation. With a built-in (Rust) objective, the run also keeps the GIL released and its full multithreaded speed. Population snapshots are sampled to max_points (default 2,000) members.

Options

  • True front: if it's known, pass it, and IGD becomes a convergence metric: pg.Dashboard(ga, reference_front=pg.reference_front("dtlz2", 3)).
  • Comparing runs: keep_runs=True keeps each finished run overlaid on the next. Several seeds or algorithms then share one dashboard (see examples/compare_runs.py). dash.compare(path) adds a saved run, and so does python -m puggles.dashboard a.pgrun.json b.pgrun.json.
  • Goals: set targets per objective in the page. With NSGA-III, Steer focuses the running optimization on them.
  • Groups and results: call set_group("NSGA-II") before each run. The Results tab then compares groups across seeds with a significance test, and the convergence chart shows median and IQR bands.
  • Your own columns: columns={"weight": lambda x: ...}. They appear in the table, colour-by, pins and the Drivers view, which shows which variables move each objective.
  • Remote: Dashboard(..., host="0.0.0.0") requires a token, which is included in dash.url. Or tunnel the port: ssh -L 8765:127.0.0.1:8765 host.
  • Also:
    • dash.add_event("…") marks the convergence chart.
    • The page offers notifications, a one-click HTML report, a shapes (colour-blind) mode, and keyboard shortcuts (?).
    • In Jupyter, a Dashboard as the last expression in a cell shows inline.

pg.show(ga) opens a finished optimizer's front. The header shows where evaluations run: CPU threads, or the GPU and its device, with a live count of GPU evaluations. For GPU runs, build the core with maturin develop --release --features gpu and pass a pg.GpuProblem; see examples/dashboard_demo.py --gpu.

Replay from the command line

python -m puggles.dashboard run.pgrun.json.gz                 # serve a saved run
python -m puggles.dashboard a.pgrun.json b.pgrun.json         # overlay runs
python -m puggles.dashboard run.pgrun.json --html report.html # standalone page, no server

The Rust crate (puggles, feature plot) writes the same .pgrun.json files.

How it plugs into the core

Dashboard.__puggles_recorder__() returns a capsule holding a small, versioned native interface (puggles::recorder_abi in the Rust crate). NSGAII.run / NSGAIII.run look for it on their callback. If the interface doesn't match, for example after mixing versions, the core issues a RuntimeWarning and falls back to calling the dashboard as an ordinary Python callback. puggles-dashboard requires the puggles release with the same version number. That's what the [dashboard] extra installs.

License

MIT OR Apache-2.0

Metadata

Release files for puggles-dashboard 0.3.0

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

Source distribution (sdist)

Source distribution for puggles-dashboard 0.3.0
File Size Uploaded Provenance Actions
puggles_dashboard-0.3.0.tar.gz 198.6 kB Without provenance Details for puggles_dashboard-0.3.0.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for puggles-dashboard 0.3.0
File Actions
puggles_dashboard-0.3.0-cp39-abi3-win_amd64.whl CPython 3.9 abi3 Windows x86-64 Details for puggles_dashboard-0.3.0-cp39-abi3-win_amd64.whl
puggles_dashboard-0.3.0-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl CPython 3.9 abi3 Linux glibc 2.17+ x86-64 Details for puggles_dashboard-0.3.0-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
puggles_dashboard-0.3.0-cp39-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl CPython 3.9 abi3 Linux glibc 2.17+ ARM64 Details for puggles_dashboard-0.3.0-cp39-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl
puggles_dashboard-0.3.0-cp39-abi3-macosx_11_0_arm64.whl CPython 3.9 abi3 macOS 11.0+ ARM64 Details for puggles_dashboard-0.3.0-cp39-abi3-macosx_11_0_arm64.whl
puggles_dashboard-0.3.0-cp39-abi3-macosx_10_12_x86_64.whl CPython 3.9 abi3 macOS 10.12+ x86-64 Details for puggles_dashboard-0.3.0-cp39-abi3-macosx_10_12_x86_64.whl

Total release size: 2.7 MB

Release files / puggles_dashboard-0.3.0.tar.gz

Download URL puggles_dashboard-0.3.0.tar.gz
Size 198.6 kB
Tags Source
SHA-256 checksum
How to use checksums
f1485e920926990407ad659fcdfe3c37945984128be9086ed6053887b85c7fdd
BLAKE2b-256 checksum
How to use checksums
339eae6965bf3b79f79b9a1e16fc5728fa2e3843aba50417e263f4c223c88581
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / puggles_dashboard-0.3.0-cp39-abi3-win_amd64.whl

Download URL puggles_dashboard-0.3.0-cp39-abi3-win_amd64.whl
Size 426.5 kB
Tags CPython 3.9 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
fce2a80207a3a79baa430daf7e57a82645edb7c0da6d3cbde1848db42bcc1d6b
BLAKE2b-256 checksum
How to use checksums
d0e07add1aa8aa017e44d6755e49aa496ece978bc21ee46795b8a7f10d95292c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / puggles_dashboard-0.3.0-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl

Download URL puggles_dashboard-0.3.0-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
Size 538.5 kB
Tags CPython 3.9 Linux glibc 2.17+ x86-64 abi3
SHA-256 checksum
How to use checksums
5dd6ca1882f40c3c2ee47cb430ead279fc7f2fa3c09187dbf3d6eb618be3be02
BLAKE2b-256 checksum
How to use checksums
fc221bd149ff2e4e8c7627f29a1f5dae89c5b37b96d8280cf7cb191437f9f421
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / puggles_dashboard-0.3.0-cp39-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl

Download URL puggles_dashboard-0.3.0-cp39-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl
Size 520.5 kB
Tags CPython 3.9 Linux glibc 2.17+ ARM64 abi3
SHA-256 checksum
How to use checksums
e97698255e37cb0d1720c3cb48b8c45ac4f1ef642a7942c703547bb5a9fcbdb7
BLAKE2b-256 checksum
How to use checksums
d8607b460d93f58b244811fd4ef2831f8dea17886ed38d54e831403bef4ca0c2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / puggles_dashboard-0.3.0-cp39-abi3-macosx_11_0_arm64.whl

Download URL puggles_dashboard-0.3.0-cp39-abi3-macosx_11_0_arm64.whl
Size 494.1 kB
Tags CPython 3.9 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
0bffb9ce16cbc57698d1cf32784f0e58a21ed1ca65bb88ba91b737a485986deb
BLAKE2b-256 checksum
How to use checksums
d3b035124aa37252d091565678a4668283bdd9deb3c5673f3d842b4bf0767453
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / puggles_dashboard-0.3.0-cp39-abi3-macosx_10_12_x86_64.whl

Download URL puggles_dashboard-0.3.0-cp39-abi3-macosx_10_12_x86_64.whl
Size 511.8 kB
Tags CPython 3.9 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
3d645d66de13f5930f86b4bc65485a26b8517c8ff82ef2c5cc4f816a07dd26d1
BLAKE2b-256 checksum
How to use checksums
32626cb951f0f44dd5220d31c58f7c308320b54aca0a999cbf04e6192f71f4e1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for puggles-dashboard 0.3.0

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.3.0 This release

6 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