README.md 1.97 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

15
## `bitsandbytes` multi-backend _alpha_ release is out!
16

17
🚀 Big news! After months of hard work and incredible community contributions, we're thrilled to announce the **bitsandbytes multi-backend _alpha_ release**! 💥
18

19
Now supporting:
20
21
- 🔥 **AMD GPUs** (ROCm)
-**Intel CPUs** & **GPUs**
22

23
We’d love your early feedback! 🙏
24

25
👉 [Instructions for your `pip install` here](https://huggingface.co/docs/bitsandbytes/main/en/installation#multi-backend)
26
27

We're super excited about these recent developments and grateful for any constructive input or support that you can give to help us make this a reality (e.g. helping us with the upcoming Apple Silicon backend or reporting bugs). BNB is a community project and we're excited for your collaboration 🤗
28

Tim Dettmers's avatar
Tim Dettmers committed
29
30
## License

Titus's avatar
Titus committed
31
`bitsandbytes` is MIT licensed.
Tim Dettmers's avatar
Tim Dettmers committed
32
33

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