From 9c82ada8cf2405361a138e8e871e1ee2546970ba Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 27 Jul 2026 16:17:08 +0000 Subject: [PATCH] Remove CPU benchmark rows from main README, move to benchmarks/README.md --- benchmarks/README.md | 15 +++++++++++++++ docs/README.md | 18 ++++++------------ 2 files changed, 21 insertions(+), 12 deletions(-) diff --git a/benchmarks/README.md b/benchmarks/README.md index 9878f6a5..eaf30745 100644 --- a/benchmarks/README.md +++ b/benchmarks/README.md @@ -17,6 +17,21 @@ The default benchmark uses: By default, this can run for a long time and may stop once memory limits are reached. +## Reference Runtimes + +Values are total elapsed seconds for a single default run (3D initial-value problem, heterogeneous absorbing medium, 1000 timesteps, averaged over 3 repeats). + +| Backend | OS | Accelerator | 64³ | 128³ | 256³ | Hardware | +|---------|-----------------------|-------------|-----|------|------|----------| +| python | Linux | CPU | — | — | — | — | +| python | macOS (Apple Silicon) | CPU | 81 | — | — | Apple M1, 8 GB | +| python | Windows | CPU | — | — | — | — | +| cpp | Linux | CPU (OMP) | — | — | — | — | +| cpp | macOS (Apple Silicon) | CPU (OMP) | — | — | — | — | +| cpp | Windows | CPU (OMP) | — | — | — | — | + +Contributions welcome — open a PR filling a row with your k-wave-python version, and (for `cpp` backend) `BINARY_VERSION`. + ## Usage Run a small smoke benchmark: diff --git a/docs/README.md b/docs/README.md index b60ffb01..264a736c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -26,18 +26,12 @@ No GPU required — all examples run on CPU with NumPy. Reference runtimes for the 3D scaling benchmark in [`benchmarks/benchmark.py`](../benchmarks/README.md). Values are total elapsed seconds for a single default run (3D initial-value problem, heterogeneous absorbing medium, 1000 timesteps, averaged over 3 repeats). -| Backend | OS | Accelerator | 64³ | 128³ | 256³ | Hardware | -|---------|-----------------------|-------------------|-----|------|------|----------| -| python | Linux | CPU | — | — | — | — | -| python | Linux | NVIDIA GPU | — | — | — | — | -| python | macOS (Apple Silicon) | CPU | 81 | — | — | Apple M1, 8 GB | -| python | Windows | CPU | — | — | — | — | -| python | Windows | NVIDIA GPU | — | — | — | — | -| cpp | Linux | CPU (OMP) | — | — | — | — | -| cpp | Linux | NVIDIA GPU (CUDA) | — | — | — | — | -| cpp | macOS (Apple Silicon) | CPU (OMP) | — | — | — | — | -| cpp | Windows | CPU (OMP) | — | — | — | — | -| cpp | Windows | NVIDIA GPU (CUDA) | — | — | — | — | +| Backend | OS | Accelerator | 64³ | 128³ | 256³ | Hardware | +|---------|---------|-------------------|-----|------|------|----------| +| python | Linux | NVIDIA GPU | — | — | — | — | +| python | Windows | NVIDIA GPU | — | — | — | — | +| cpp | Linux | NVIDIA GPU (CUDA) | — | — | — | — | +| cpp | Windows | NVIDIA GPU (CUDA) | — | — | — | — | Contributions welcome — open a PR filling a row with your k-wave-python version, and (for `cpp` backend) `BINARY_VERSION`. See [`benchmarks/README.md`](../benchmarks/README.md) for the reproducer command.