README.md 1.39 KB
Newer Older
Titus's avatar
Titus committed
1
# `bitsandbytes`
Tim Dettmers's avatar
Tim Dettmers committed
2

Titus's avatar
Titus committed
3
4
[![Downloads](https://static.pepy.tech/badge/bitsandbytes)](https://pepy.tech/project/bitsandbytes) [![Downloads](https://static.pepy.tech/badge/bitsandbytes/month)](https://pepy.tech/project/bitsandbytes) [![Downloads](https://static.pepy.tech/badge/bitsandbytes/week)](https://pepy.tech/project/bitsandbytes)

Titus's avatar
Titus committed
5
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.
6

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

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

Titus's avatar
Titus committed
11
**Please head to the official documentation page:**
12

Titus's avatar
Titus committed
13
**[https://huggingface.co/docs/bitsandbytes/main](https://huggingface.co/docs/bitsandbytes/main)**
14

Tim Dettmers's avatar
Tim Dettmers committed
15
16
## License

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

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