Skip to main content

k-bit optimizers and matrix multiplication routines.

Project description

bitsandbytes

License Downloads Nightly Unit Tests GitHub Release PyPI - Python Version

bitsandbytes enables accessible large language models via k-bit quantization for PyTorch. We provide three main features for dramatically reducing memory consumption for inference and training:

  • 8-bit optimizers uses block-wise quantization to maintain 32-bit performance at a small fraction of the memory cost.
  • LLM.int8() or 8-bit quantization enables large language model inference with only half the required memory and without any performance degradation. This method is based on vector-wise quantization to quantize most features to 8-bits and separately treating outliers with 16-bit matrix multiplication.
  • QLoRA or 4-bit quantization enables large language model training with several memory-saving techniques that don't compromise performance. This method quantizes a model to 4-bits and inserts a small set of trainable low-rank adaptation (LoRA) weights to allow training.

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.

System Requirements

bitsandbytes has the following minimum requirements for all platforms:

  • Python 3.9+
  • PyTorch 2.3+
    • Note: While we aim to provide wide backwards compatibility, we recommend using the latest version of PyTorch for the best experience.

Accelerator support:

Note: this table reflects the status of the current development branch. For the latest stable release, see the document in the 0.48.0 tag.

Legend:

🚧 = In Development, 〰️ = Partially Supported, ✅ = Supported, ❌ = Not Supported

Platform Accelerator Hardware Requirements LLM.int8() QLoRA 4-bit 8-bit Optimizers
🐧 Linux, glibc >= 2.24
x86-64 ◻️ CPU AVX2
🟩 NVIDIA GPU
cuda
SM60+ minimum
SM75+ recommended
🟥 AMD GPU
cuda
CDNA: gfx90a, gfx942
RDNA: gfx1100
〰️
🟦 Intel GPU
xpu
Data Center GPU Max Series
Arc A-Series (Alchemist)
Arc B-Series (Battlemage)
〰️
🟪 Intel Gaudi
hpu
Gaudi2, Gaudi3 〰️
aarch64 ◻️ CPU
🟩 NVIDIA GPU
cuda
SM75+
🪟 Windows 11 / Windows Server 2019+
x86-64 ◻️ CPU AVX2
🟩 NVIDIA GPU
cuda
SM60+ minimum
SM75+ recommended
🟦 Intel GPU
xpu
Arc A-Series (Alchemist)
Arc B-Series (Battlemage)
〰️
🍎 macOS 14+
arm64 ◻️ CPU Apple M1+ 🚧 🚧
⬜ Metal
mps
Apple M1+ 🚧 🚧

:book: Documentation

:heart: Sponsors

The continued maintenance and development of bitsandbytes is made possible thanks to the generous support of our sponsors. Their contributions help ensure that we can keep improving the project and delivering valuable updates to the community.

Hugging Face   Intel

License

bitsandbytes is MIT licensed.

We thank Fabio Cannizzo for his work on FastBinarySearch which we use for CPU quantization.

How to cite us

If you found this library useful, please consider citing our work:

QLoRA

@article{dettmers2023qlora,
  title={Qlora: Efficient finetuning of quantized llms},
  author={Dettmers, Tim and Pagnoni, Artidoro and Holtzman, Ari and Zettlemoyer, Luke},
  journal={arXiv preprint arXiv:2305.14314},
  year={2023}
}

LLM.int8()

@article{dettmers2022llmint8,
  title={LLM.int8(): 8-bit Matrix Multiplication for Transformers at Scale},
  author={Dettmers, Tim and Lewis, Mike and Belkada, Younes and Zettlemoyer, Luke},
  journal={arXiv preprint arXiv:2208.07339},
  year={2022}
}

8-bit Optimizers

@article{dettmers2022optimizers,
  title={8-bit Optimizers via Block-wise Quantization},
  author={Dettmers, Tim and Lewis, Mike and Shleifer, Sam and Zettlemoyer, Luke},
  journal={9th International Conference on Learning Representations, ICLR},
  year={2022}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

bitsandbytes-0.48.2-py3-none-win_amd64.whl (59.0 MB view details)

Uploaded Python 3Windows x86-64

bitsandbytes-0.48.2-py3-none-manylinux_2_24_x86_64.whl (59.4 MB view details)

Uploaded Python 3manylinux: glibc 2.24+ x86-64

bitsandbytes-0.48.2-py3-none-manylinux_2_24_aarch64.whl (33.8 MB view details)

Uploaded Python 3manylinux: glibc 2.24+ ARM64

File details

Details for the file bitsandbytes-0.48.2-py3-none-win_amd64.whl.

File metadata

File hashes

Hashes for bitsandbytes-0.48.2-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 a048c285eb6ff53a8d189880e9dfa421d2bfb54e8cab263311757cf5b742d865
MD5 0bdde6e1da4c81f0a850d37a6eb13a6d
BLAKE2b-256 172d309b3ba276d1fe5f3db4fb5e0a6926d10654656cdbfe49881aa95f4cfcc2

See more details on using hashes here.

Provenance

The following attestation bundles were made for bitsandbytes-0.48.2-py3-none-win_amd64.whl:

Publisher: python-package.yml on bitsandbytes-foundation/bitsandbytes

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bitsandbytes-0.48.2-py3-none-manylinux_2_24_x86_64.whl.

File metadata

File hashes

Hashes for bitsandbytes-0.48.2-py3-none-manylinux_2_24_x86_64.whl
Algorithm Hash digest
SHA256 cd289562cb7308ee2a707e6884fecca9bbbcfc9ec33a86df2a45e0779692c1a3
MD5 63488a68bebf7e47629775a73ad2418d
BLAKE2b-256 3b72f6934097c94e023967bf7eb24e50987aca8a40f4cabf4e0282957f6258c2

See more details on using hashes here.

Provenance

The following attestation bundles were made for bitsandbytes-0.48.2-py3-none-manylinux_2_24_x86_64.whl:

Publisher: python-package.yml on bitsandbytes-foundation/bitsandbytes

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bitsandbytes-0.48.2-py3-none-manylinux_2_24_aarch64.whl.

File metadata

File hashes

Hashes for bitsandbytes-0.48.2-py3-none-manylinux_2_24_aarch64.whl
Algorithm Hash digest
SHA256 defbfa374d93809de3811cd2bca6978d1d51ecaa39f5bdd2018e1394a4886603
MD5 49c195dda15a7ece4db957d7a2a72c15
BLAKE2b-256 d556e58f1eeb41c71d3789d401ad147fc0fa78fa7004ea58616ba6abc50889c8

See more details on using hashes here.

Provenance

The following attestation bundles were made for bitsandbytes-0.48.2-py3-none-manylinux_2_24_aarch64.whl:

Publisher: python-package.yml on bitsandbytes-foundation/bitsandbytes

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page