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.2+
    • 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.47.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
SM50+ 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
Gaudi1, Gaudi2, Gaudi3 🚧 🚧
aarch64 ◻️ CPU
🟩 NVIDIA GPU
cuda
SM75+
🪟 Windows 11 / Windows Server 2019+
x86-64 ◻️ CPU AVX2
🟩 NVIDIA GPU
cuda
SM50+ 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

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

bitsandbytes-0.47.0-py3-none-win_amd64.whl (60.7 MB view details)

Uploaded Python 3Windows x86-64

bitsandbytes-0.47.0-py3-none-manylinux_2_24_x86_64.whl (61.3 MB view details)

Uploaded Python 3manylinux: glibc 2.24+ x86-64

bitsandbytes-0.47.0-py3-none-manylinux_2_24_aarch64.whl (30.0 MB view details)

Uploaded Python 3manylinux: glibc 2.24+ ARM64

File details

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

File metadata

File hashes

Hashes for bitsandbytes-0.47.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 4880a6d42ca9628b5a571c8cc3093dc3f5f52511e5a9e47d52d569807975531a
MD5 c1153094c015730aa0549439e0f3d824
BLAKE2b-256 18a9e07a227f1cd6562844cea2f05ee576b0991a9a91f45965c06034178ba0f6

See more details on using hashes here.

Provenance

The following attestation bundles were made for bitsandbytes-0.47.0-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.47.0-py3-none-manylinux_2_24_x86_64.whl.

File metadata

File hashes

Hashes for bitsandbytes-0.47.0-py3-none-manylinux_2_24_x86_64.whl
Algorithm Hash digest
SHA256 68f3fffd494a47ed1fd7593bfc5dd2ac69b68260599b71b4c4b3a32f90f3b184
MD5 95d59458d7bd5d3d666c69f541693595
BLAKE2b-256 9c4091f1a5a694f434bc13cba160045fdc4e867032e627b001bf411048fefd9c

See more details on using hashes here.

Provenance

The following attestation bundles were made for bitsandbytes-0.47.0-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.47.0-py3-none-manylinux_2_24_aarch64.whl.

File metadata

File hashes

Hashes for bitsandbytes-0.47.0-py3-none-manylinux_2_24_aarch64.whl
Algorithm Hash digest
SHA256 2f805b76891a596025e9e13318b675d08481b9ee650d65e5d2f9d844084c6521
MD5 34623b680accc4e22e7eed17561bbbcc
BLAKE2b-256 aaeb477d6b5602f469c7305fd43eec71d890c39909f615c1d7138f6e7d226eff

See more details on using hashes here.

Provenance

The following attestation bundles were made for bitsandbytes-0.47.0-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 Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page