transformers/docs/source/en/quantization/overview.md
Jerry Zhang 78d78cdf8a
Add TorchAOHfQuantizer (#32306)
* Add TorchAOHfQuantizer

Summary:
Enable loading torchao quantized model in huggingface.

Test Plan:
local test

Reviewers:

Subscribers:

Tasks:

Tags:

* Fix a few issues

* style

* Added tests and addressed some comments about dtype conversion

* fix torch_dtype warning message

* fix tests

* style

* TorchAOConfig -> TorchAoConfig

* enable offload + fix memory with multi-gpu

* update torchao version requirement to 0.4.0

* better comments

* add torch.compile to torchao README, add perf number link

---------

Co-authored-by: Marc Sun <marc@huggingface.co>
2024-08-14 16:14:24 +02:00

6.4 KiB

Quantization

Quantization techniques focus on representing data with less information while also trying to not lose too much accuracy. This often means converting a data type to represent the same information with fewer bits. For example, if your model weights are stored as 32-bit floating points and they're quantized to 16-bit floating points, this halves the model size which makes it easier to store and reduces memory-usage. Lower precision can also speedup inference because it takes less time to perform calculations with fewer bits.

Interested in adding a new quantization method to Transformers? Read the HfQuantizer guide to learn how!

If you are new to the quantization field, we recommend you to check out these beginner-friendly courses about quantization in collaboration with DeepLearning.AI:

When to use what?

The community has developed many quantization methods for various use cases. With Transformers, you can run any of these integrated methods depending on your use case because each method has their own pros and cons.

For example, some quantization methods require calibrating the model with a dataset for more accurate and "extreme" compression (up to 1-2 bits quantization), while other methods work out of the box with on-the-fly quantization.

Another parameter to consider is compatibility with your target device. Do you want to quantize on a CPU, GPU, or Apple silicon?

In short, supporting a wide range of quantization methods allows you to pick the best quantization method for your specific use case.

Use the table below to help you decide which quantization method to use.

Quantization method On the fly quantization CPU CUDA GPU RoCm GPU (AMD) Metal (Apple Silicon) torch.compile() support Number of bits Supports fine-tuning (through PEFT) Serializable with 🤗 transformers 🤗 transformers support Link to library
AQLM 🔴 🟢 🟢 🔴 🔴 🟢 1 / 2 🟢 🟢 🟢 https://github.com/Vahe1994/AQLM
AWQ 🔴 🔴 🟢 🟢 🔴 ? 4 🟢 🟢 🟢 https://github.com/casper-hansen/AutoAWQ
bitsandbytes 🟢 🔴 🟢 🔴 🔴 🔴 4 / 8 🟢 🟢 🟢 https://github.com/TimDettmers/bitsandbytes
EETQ 🟢 🔴 🟢 🔴 🔴 ? 8 🟢 🟢 🟢 https://github.com/NetEase-FuXi/EETQ
GGUF / GGML (llama.cpp) 🟢 🟢 🟢 🔴 🟢 🔴 1 - 8 🔴 See GGUF section See GGUF section https://github.com/ggerganov/llama.cpp
GPTQ 🔴 🔴 🟢 🟢 🔴 🔴 2 - 3 - 4 - 8 🟢 🟢 🟢 https://github.com/AutoGPTQ/AutoGPTQ
HQQ 🟢 🟢 🟢 🔴 🔴 🟢 1 - 8 🟢 🔴 🟢 https://github.com/mobiusml/hqq/
Quanto 🟢 🟢 🟢 🔴 🟢 🟢 2 / 4 / 8 🔴 🔴 🟢 https://github.com/huggingface/quanto
FBGEMM_FP8 🟢 🔴 🟢 🔴 🔴 🔴 8 🔴 🟢 🟢 https://github.com/pytorch/FBGEMM
torchao 🟢 🟢 🔴 partial support (int4 weight only) 4 / 8 🟢🔴 🟢 https://github.com/pytorch/ao