"vscode:/vscode.git/clone" did not exist on "0d56855b74a8e0819bdae17af567f7e901d8c4c6"
index.mdx 1.05 KB
Newer Older
Titus's avatar
Titus committed
1
# `bitsandbytes`
Titus's avatar
Titus committed
2

Titus's avatar
Titus committed
3
The `bitsandbytes` library is a lightweight Python wrapper around CUDA custom functions, in particular 8-bit optimizers, matrix multiplication (LLM.int8()), and 8 + 4-bit quantization functions.
Titus's avatar
Titus committed
4

Titus's avatar
Titus committed
5
The library includes quantization primitives for 8-bit & 4-bit operations, through `bitsandbytes.nn.Linear8bitLt` and `bitsandbytes.nn.Linear4bit` and 8bit optimizers through `bitsandbytes.optim` module.
Titus's avatar
Titus committed
6

Titus's avatar
Titus committed
7
There are ongoing efforts to support further hardware backends, i.e. Intel CPU + GPU, AMD GPU, Apple Silicon. Windows support is on its way as well.
Titus's avatar
Titus committed
8

Titus's avatar
Titus committed
9
## API documentation
Titus's avatar
Titus committed
10

Titus's avatar
Titus committed
11
12
13
- [Linear4bit](quantizaton#linear4bit)
- [Linear8bit](quantizaton#linear8bit)
- [StableEmbedding](optimizers#stableembedding)
Titus's avatar
Titus committed
14

Titus's avatar
Titus committed
15
# License
Titus's avatar
Titus committed
16

Titus's avatar
Titus committed
17
The majority of bitsandbytes is licensed under MIT, however portions of the project are available under separate license terms, as the parts adapted from Pytorch are licensed under the BSD license.
Titus's avatar
Titus committed
18
19

We thank Fabio Cannizzo for his work on [FastBinarySearch](https://github.com/fabiocannizzo/FastBinarySearch) which we use for CPU quantization.