Skip to content

Commit a5c07be

Browse files
Update installation doc
Updated installation instructions for AMD ROCm support and clarified installation methods.
1 parent 5ea4afe commit a5c07be

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

docs/source/installation.mdx

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ We provide official support for NVIDIA GPUs, CPUs, Intel XPUs, and Intel Gaudi.
1818
- [Installation via PyPI](#cpu-pip)
1919
- [Compile from Source](#cpu-compile)
2020
- [AMD ROCm (Preview)](#rocm-preview)
21+
- [Installation via PyPI](#rocm-pip)
22+
- [Compile from Source](#rocm-compile)
2123
- [Preview Wheels](#preview-wheels)
2224

2325
## System Requirements[[requirements]]
@@ -49,9 +51,9 @@ The currently distributed `bitsandbytes` packages are built with the following c
4951
|--------------------|------------------|----------------------|--------------
5052
| **Linux x86-64** | 11.8 - 12.6 | GCC 11.2 | sm60, sm70, sm75, sm80, sm86, sm89, sm90
5153
| **Linux x86-64** | 12.8 - 12.9 | GCC 11.2 | sm70, sm75, sm80, sm86, sm89, sm90, sm100, sm120
52-
| **Linux x86-64** | 13.0 | GCC 11.2 | sm75, sm80, sm86, sm89, sm90, sm100, sm110, sm120
54+
| **Linux x86-64** | 13.0 | GCC 11.2 | sm75, sm80, sm86, sm89, sm90, sm100, sm120
5355
| **Linux aarch64** | 11.8 - 12.6 | GCC 11.2 | sm75, sm80, sm90
54-
| **Linux aarch64** | 12.8 - 13.0 | GCC 11.2 | sm75, sm80, sm90, sm100, sm120
56+
| **Linux aarch64** | 12.8 - 13.0 | GCC 11.2 | sm75, sm80, sm90, sm100, sm110, sm120, sm121
5557
| **Windows x86-64** | 11.8 - 12.6 | MSVC 19.43+ (VS2022) | sm50, sm60, sm75, sm80, sm86, sm89, sm90
5658
| **Windows x86-64** | 12.8 - 12.9 | MSVC 19.43+ (VS2022) | sm70, sm75, sm80, sm86, sm89, sm90, sm100, sm120
5759
| **Windows x86-64** | 13.0 | MSVC 19.43+ (VS2022) | sm75, sm80, sm86, sm89, sm90, sm100, sm120
@@ -183,12 +185,16 @@ pip install -e .
183185

184186
## AMD ROCm (Preview)[[rocm]]
185187

188+
* Support for AMD GPUs is currently in a preview state.
189+
* All features are supported for consumer RDNA devices.
190+
* The Data Center products currently lack support for the default 4bit blocksize of 64, and as such default to 128.
186191
* A compatible PyTorch version with AMD ROCm support is required. It is recommended to use the latest stable release. See [PyTorch on ROCm](https://rocm.docs.amd.com/projects/install-on-linux/en/latest/install/3rd-party/pytorch-install.html) for guidance.
187-
* ROCm support is currently only available in our preview wheels or when building from source.
188192

189-
### Preview Wheels from `main`[[rocm-preview]]
193+
### Installation from PyPI[[rocm-pip]]
190194

191-
The currently distributed preview `bitsandbytes` are built with the following configurations:
195+
This is the most straightforward and recommended installation option.
196+
197+
The currently distributed `bitsandbytes` are built with the following configurations:
192198

193199
| **OS** | **ROCm** | **Targets**
194200
|--------------------|----------|---------------------------------------------------------------------|
@@ -200,11 +206,17 @@ The currently distributed preview `bitsandbytes` are built with the following co
200206

201207
**Windows is not currently supported.**
202208

203-
Please see [Preview Wheels](#preview-wheels) for installation instructions.
209+
Use `pip` or `uv` to install the latest release:
210+
211+
```bash
212+
pip install bitsandbytes
213+
```
204214

205215
### Compile from Source[[rocm-compile]]
206216

207-
bitsandbytes can be compiled from ROCm 6.1 - ROCm 7.0.
217+
bitsandbytes can be compiled from ROCm 6.2 - ROCm 7.1.
218+
219+
To compile from source, you need CMake >= **3.31.6**.
208220

209221
```bash
210222
# Install bitsandbytes from source

0 commit comments

Comments
 (0)