Skip to content

Remove CPU benchmarks from main README #776

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Remove CPU benchmarks from main README #776

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions benchmarks/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
18 changes: 6 additions & 12 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down