docs: add benchmark results matrix to README#769
Draft
waltsims wants to merge 2 commits into
Draft
Conversation
Adds a Benchmarks section to the front-page README with a 10-row matrix covering (backend, OS, accelerator) combinations against three grid sizes (64³, 128³, 256³). All cells ship empty (em-dash) as a scaffold — contributors fill rows via follow-up commits with their hardware, k-wave-python version, and BINARY_VERSION. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Owner
Author
|
it would be great if you two could add entries here! |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #769 +/- ##
=======================================
Coverage 75.83% 75.83%
=======================================
Files 58 58
Lines 8274 8274
Branches 1614 1614
=======================================
Hits 6275 6275
Misses 1373 1373
Partials 626 626
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Measured on Apple M1 MacBook Air (8 GB) against k-wave-python 0.6.3rc1: 64³ = 81 s (python backend, CPU, 1000 timesteps, 3 averages). 128³/256³ left empty — 256³ exceeds 8 GB RAM on this machine. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a
## Benchmarkssection to the front-page README (docs/README.md) with a 10-row matrix covering(backend, OS, accelerator)combinations against three grid sizes: 64³, 128³, 256³.All cells ship empty (em-dash) as a scaffold. The plan is for contributors to fill rows via follow-up commits on this branch:
Grid-size columns are drawn from the isotropic sizes in the default
x/y/z_scale_arrayinbenchmarks/helpers.py(indices 0/3/6/9 = 32³/64³/128³/256³, dropped 32³ as too small to be interesting). 512³ was excluded because many workstations OOM.Rows omitted intentionally:
python/cpp+ macOS + GPU — no CUDA on macOS.cpp+ Intel Mac + CPU — rare; can be added when someone runs it.Reproducer command lives in
benchmarks/README.md; the section links to it.Test plan
docs/README.mdis thereadme =inpyproject.toml)🤖 Generated with Claude Code