docs(cuda): use Windows-native BNB_CUDA_VERSION guidance#1957
docs(cuda): use Windows-native BNB_CUDA_VERSION guidance#1957peter941221 wants to merge 3 commits into
Conversation
|
Thanks, generally this looks OK. Please fix the lint issue. It may be worth it to add a note about PowerShell syntax too but that wouldn't block me from merging. |
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
|
Fixed this. I merged current GitHub picked up the new head, but the workflow reruns landed in |
|
Hi, Thanks for the contribution. After #1980 there's conflicts now, but also the need for this should be significantly reduced as well. As such I'm going to close this. |
docs(cuda): use Windows-native BNB_CUDA_VERSION guidance
Summary
This updates CUDA override guidance to use platform-appropriate shell commands on Windows and documents the local source-build case where the toolkit version used for the native DLL does not match the CUDA version bundled with the installed PyTorch wheel.
Problem
On Windows, bitsandbytes currently emits Unix-style guidance such as
unset BNB_CUDA_VERSIONandexport BNB_CUDA_VERSION=...frombitsandbytes/cextension.py.That is misleading for Windows users, especially in the common local-source-build workflow where:
cu130)libbitsandbytes_cuda132.dll)In that situation, users may need
BNB_CUDA_VERSIONto point bitsandbytes at the locally built DLL, but the current warning text tells them to use Unix shell syntax even on Windows.Change
bitsandbytes/cextension.pythat formats env-var guidance per platformset VAR=.../set VAR=on Windows instead ofexport/unsetdocs/source/installation.mdxcovering the local toolkit / PyTorch CUDA version mismatch caseValidation
Validated on Windows with:
libbitsandbytes_cuda132.dll2.12.0+cu130pytest tests/test_cuda_setup_evaluator.py -qThe targeted tests pass, and the Windows warning text now suggests
set BNB_CUDA_VERSION=...andset BNB_CUDA_VERSION=instead of Unix shell commands.