Skip to content

Commit a2ee1c4

Browse files
docs update
1 parent 498d8de commit a2ee1c4

File tree

2 files changed

+17
-16
lines changed

2 files changed

+17
-16
lines changed

docs/source/algorithms.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This is an overview of the `bnb.functional` API in `bitsandbytes` that we think
55

66
## Using Int8 Matrix Multiplication
77

8-
For straight Int8 matrix multiplication with mixed precision decomposition you can use ``bnb.matmul(...)``. To enable mixed precision decomposition, use the threshold parameter:
8+
For straight Int8 matrix multiplication without mixed precision decomposition you can use ``bnb.matmul(...)``. To enable mixed precision decomposition, use the threshold parameter:
99

1010
```py
1111
bnb.matmul(..., threshold=6.0)

docs/source/installation.mdx

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -19,29 +19,30 @@ Welcome to the installation guide for the `bitsandbytes` library! This document
1919

2020
## CUDA[[cuda]]
2121

22-
`bitsandbytes` is currently only supported on CUDA GPUs for CUDA versions **11.0 - 12.5**. However, there's an ongoing multi-backend effort under development, which is currently in alpha. If you're interested in providing feedback or testing, check out [the multi-backend section below](#multi-backend).
22+
`bitsandbytes` is currently only supported on CUDA GPUs for CUDA versions **11.0 - 12.6**. However, there's an ongoing multi-backend effort under development, which is currently in alpha. If you're interested in providing feedback or testing, check out [the multi-backend section below](#multi-backend).
2323

2424
### Supported CUDA Configurations[[cuda-pip]]
2525

26-
The latest version of `bitsandbytes` builds on the following configurations:
26+
The latest version of the distributed `bitsandbytes` package is built with the following configurations:
2727

28-
| **OS** | **CUDA Version** | **Compiler** |
28+
| **OS** | **CUDA Toolkit** | **Host Compiler** |
2929
|-------------|------------------|----------------------|
3030
| **Linux** | 11.7 - 12.3 | GCC 11.4 |
31-
| | 12.4+ | GCC 13.2 |
32-
| **Windows** | 11.7 - 12.4 | MSVC 19.38+ (VS2022) |
31+
| | 12.4 - 12.6 | GCC 13.2 |
32+
| **Windows** | 11.7 - 12.6 | MSVC 19.42+ (VS2022) |
3333

34-
For Linux systems, ensure your hardware meets the following requirements:
34+
For CUDA systems, ensure your hardware meets the following requirements:
3535

36-
| **Feature** | **Hardware Requirement** |
37-
|---------------------------------|--------------------------------------------------------------------|
38-
| LLM.int8() | NVIDIA Turing (RTX 20 series, T4) or Ampere (RTX 30 series, A4-A100) GPUs |
39-
| 8-bit optimizers/quantization | NVIDIA Kepler (GTX 780 or newer) |
36+
| **Feature** | **Minimum Hardware Requirement** |
37+
|---------------------------------|---------------------------------------------------------------|
38+
| LLM.int8() | NVIDIA Turing (RTX 20 series, T4) or newer GPUs |
39+
| 8-bit optimizers/quantization | NVIDIA Maxwell (GTX 900 series, TITAN X, M40) or newer GPUs * |
40+
| NF4/FP4 quantization | NVIDIA Maxwell (GTX 900 series, TITAN X, M40) or newer GPUs * |
4041

4142
> [!WARNING]
42-
> `bitsandbytes >= 0.39.1` no longer includes Kepler binaries in pip installations. This requires [manual compilation using](#cuda-compile) the `cuda11x_nomatmul_kepler` configuration.
43-
44-
To install from PyPI.
43+
> `bitsandbytes >= 0.45.0` no longer supports Kepler GPUs.
44+
>
45+
> Support for Maxwell GPUs is deprecated and will be removed in a future release. For the best results, a Turing generation device or newer is recommended.
4546
4647
```bash
4748
pip install bitsandbytes
@@ -79,7 +80,7 @@ For Linux and Windows systems, compiling from source allows you to customize the
7980
<hfoptions id="source">
8081
<hfoption id="Linux">
8182

82-
To compile from source, you need CMake >= **3.22.1** and Python >= **3.8** installed. Make sure you have a compiler installed to compile C++ (`gcc`, `make`, headers, etc.).
83+
To compile from source, you need CMake >= **3.22.1** and Python >= **3.9** installed. Make sure you have a compiler installed to compile C++ (`gcc`, `make`, headers, etc.).
8384

8485
For example, to install a compiler and CMake on Ubuntu:
8586

@@ -115,7 +116,7 @@ pip install -e . # `-e` for "editable" install, when developing BNB (otherwise
115116

116117
Windows systems require Visual Studio with C++ support as well as an installation of the CUDA SDK.
117118

118-
To compile from source, you need CMake >= **3.22.1** and Python >= **3.8** installed. You should also install CUDA Toolkit by following the [CUDA Installation Guide for Windows](https://docs.nvidia.com/cuda/cuda-installation-guide-microsoft-windows/index.html) guide from NVIDIA.
119+
To compile from source, you need CMake >= **3.22.1** and Python >= **3.9** installed. You should also install CUDA Toolkit by following the [CUDA Installation Guide for Windows](https://docs.nvidia.com/cuda/cuda-installation-guide-microsoft-windows/index.html) guide from NVIDIA.
119120

120121
Refer to the following table if you're using another CUDA Toolkit version.
121122

0 commit comments

Comments
 (0)