docs: document Blackwell (sm 12.0) GPU support in README#750
Open
waltsims wants to merge 1 commit into
Open
Conversation
The README's GPU support claim was stale at sm 5.0–9.0a; v0.6.2 pinned the bundled C++ binaries to v1.4.1, which adds sm 12.0 (Blackwell) on Linux CUDA. Update the architecture range so users with RTX 50-series / Blackwell hardware know the project supports them. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| [](https://codecov.io/gh/waltsims/k-wave-python) | ||
|
|
||
| A Python implementation of [k-Wave](http://www.k-wave.org/) — an acoustics toolbox for time-domain simulation of acoustic wave fields. Includes a pure NumPy/CuPy solver (`backend="python"`) and an interface to the pre-compiled k-Wave C++ binaries (`backend="cpp"`) with NVIDIA GPU support (sm 5.0–9.0a). | ||
| A Python implementation of [k-Wave](http://www.k-wave.org/) — an acoustics toolbox for time-domain simulation of acoustic wave fields. Includes a pure NumPy/CuPy solver (`backend="python"`) and an interface to the pre-compiled k-Wave C++ binaries (`backend="cpp"`) with NVIDIA GPU support from Maxwell through Blackwell (sm 5.0–9.0a, sm 12.0). |
Contributor
There was a problem hiding this comment.
Suggested change
| A Python implementation of [k-Wave](http://www.k-wave.org/) — an acoustics toolbox for time-domain simulation of acoustic wave fields. Includes a pure NumPy/CuPy solver (`backend="python"`) and an interface to the pre-compiled k-Wave C++ binaries (`backend="cpp"`) with NVIDIA GPU support from Maxwell through Blackwell (sm 5.0–9.0a, sm 12.0). | |
| A Python implementation of [k-Wave](http://www.k-wave.org/) — an acoustics toolbox for time-domain simulation of acoustic wave fields. Includes a pure NumPy/CuPy solver (`backend="python"`) and an interface to the pre-compiled k-Wave C++ binaries (`backend="cpp"`) with NVIDIA GPU support for sm 5.0–9.0a (Maxwell → Hopper) and sm 12.0 (consumer/workstation Blackwell). |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #750 +/- ##
==========================================
+ Coverage 75.55% 75.81% +0.25%
==========================================
Files 57 57
Lines 8187 8303 +116
Branches 1598 1649 +51
==========================================
+ Hits 6186 6295 +109
- Misses 1380 1382 +2
- Partials 621 626 +5
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
docs/README.md:7so RTX 50-series / Blackwell users know the project covers their hardwareTest plan
🤖 Generated with Claude Code
Greptile Summary
This PR updates the one-line description in
docs/README.mdto advertise Blackwell GPU support (sm 12.0) alongside the existing Maxwell–Hopper range (sm 5.0–9.0a), aligning the README with the bundled k-Wave C++ binary v1.4.1.(sm 5.0–9.0a, sm 12.0)is factually correct, but the prose "from Maxwell through Blackwell" overstates coverage: Blackwell spans sm 10.0 (B200/GB200), sm 10.3 (B300/GB300), sm 11.0 (Jetson T5000/T4000), sm 12.0 (consumer/workstation RTX 50xx), and sm 12.1 (GB10), so datacenter Blackwell users would be misled into thinking their hardware is supported.Confidence Score: 3/5
The README change advertises broader Blackwell support than the binary actually delivers — datacenter Blackwell users (B200, GB200, GB300) would be misled.
The parenthetical
(sm 5.0–9.0a, sm 12.0)is accurate, but the surrounding prose "from Maxwell through Blackwell" covers only a subset of the Blackwell family. Blackwell spans sm 10.0, sm 10.3, sm 11.0, sm 12.0, and sm 12.1; only sm 12.0 is added here. A B200 or GB200 user (sm 10.0) reading the README would reasonably believe their card is supported and waste time debugging a runtime failure.docs/README.md — the one changed line needs the prose tightened to match what the parenthetical already states correctly.
Important Files Changed
Reviews (1): Last reviewed commit: "docs: document Blackwell (sm 12.0) GPU s..." | Re-trigger Greptile