llmcompressor-nightly 0.4.1.20250313

A library for compressing large language models utilizing the latest techniques and research in the field for both training aware and post training techniques. The library is designed to be flexible and easy to use on top of PyTorch and HuggingFace Transformers, allowing for quick experimentation.

LLM Compressor

llmcompressor is an easy-to-use library for optimizing models for deployment with vllm, including:

• Comprehensive set of quantization algorithms for weight-only and activation quantization
• Seamless integration with Hugging Face models and repositories
• safetensors-based file format compatible with vllm
• Large model support via accelerate

✨ Read the announcement blog here! ✨

Supported Formats

• Activation Quantization: W8A8 (int8 and fp8)
• Mixed Precision: W4A16, W8A16
• 2:4 Semi-structured and Unstructured Sparsity

Supported Algorithms

• Simple PTQ
• GPTQ
• SmoothQuant
• SparseGPT

When to Use Which Optimization

PTQ

PTQ is performed to reduce the precision of quantizable weights (e.g., linear layers) to a lower bit-width. Supported formats are:

W4A16

• Uses GPTQ to compress weights to 4 bits. Requires calibration dataset.
• Useful speed ups in low QPS regimes with more weight compression.
• Recommended for any GPUs types.

W8A8-INT8

• Uses channel-wise quantization to compress weights to 8 bits using GPTQ, and uses dynamic per-token quantization to compress activations to 8 bits. Requires calibration dataset for weight quantization. Activation quantization is carried out during inference on vLLM.
• Useful for speed ups in high QPS regimes or offline serving on vLLM.
• Recommended for NVIDIA GPUs with compute capability <8.9 (Ampere, Turing, Volta, Pascal, or older).

W8A8-FP8

• Uses channel-wise quantization to compress weights to 8 bits, and uses dynamic per-token quantization to compress activations to 8 bits. Does not require calibration dataset. Activation quantization is carried out during inference on vLLM.
• Useful for speed ups in high QPS regimes or offline serving on vLLM.
• Recommended for NVIDIA GPUs with compute capability >8.9 (Hopper and Ada Lovelace).

Sparsification

Sparsification reduces model complexity by pruning selected weight values to zero while retaining essential weights in a subset of parameters. Supported formats include:

2:4-Sparsity with FP8 Weight, FP8 Input Activation

• Uses (1) semi-structured sparsity (SparseGPT), where, for every four contiguous weights in a tensor, two are set to zero. (2) Uses channel-wise quantization to compress weights to 8 bits and dynamic per-token quantization to compress activations to 8 bits.
• Useful for better inference than W8A8-fp8, with almost no drop in its evaluation score blog. Note: Small models may experience accuracy drops when the remaining non-zero weights are insufficient to recapitulate the original distribution.
• Recommended for compute capability >8.9 (Hopper and Ada Lovelace).

Installation

pip install llmcompressor

Get Started

End-to-End Examples

Applying quantization with llmcompressor:

• Activation quantization to int8
• Activation quantization to fp8
• Weight only quantization to int4
• Quantizing MoE LLMs
• Quantizing Vision-Language Models
• Quantizing Audio-Language Models

User Guides

Deep dives into advanced usage of llmcompressor:

• Quantizing with large models with the help of accelerate

Quick Tour

Let's quantize TinyLlama with 8 bit weights and activations using the GPTQ and SmoothQuant algorithms.

Note that the model can be swapped for a local or remote HF-compatible checkpoint and the recipe may be changed to target different quantization algorithms or formats.

Apply Quantization

Quantization is applied by selecting an algorithm and calling the oneshot API.

from llmcompressor.modifiers.smoothquant import SmoothQuantModifier
from llmcompressor.modifiers.quantization import GPTQModifier
from llmcompressor import oneshot

# Select quantization algorithm. In this case, we:
#   * apply SmoothQuant to make the activations easier to quantize
#   * quantize the weights to int8 with GPTQ (static per channel)
#   * quantize the activations to int8 (dynamic per token)
recipe = [
    SmoothQuantModifier(smoothing_strength=0.8),
    GPTQModifier(scheme="W8A8", targets="Linear", ignore=["lm_head"]),
]

# Apply quantization using the built in open_platypus dataset.
#   * See examples for demos showing how to pass a custom calibration set
oneshot(
    model="TinyLlama/TinyLlama-1.1B-Chat-v1.0",
    dataset="open_platypus",
    recipe=recipe,
    output_dir="TinyLlama-1.1B-Chat-v1.0-INT8",
    max_seq_length=2048,
    num_calibration_samples=512,
)

Inference with vLLM

The checkpoints created by llmcompressor can be loaded and run in vllm:

Install:

pip install vllm

Run:

from vllm import LLM
model = LLM("TinyLlama-1.1B-Chat-v1.0-INT8")
output = model.generate("My name is")

Questions / Contribution

• If you have any questions or requests open an issue and we will add an example or documentation.
• We appreciate contributions to the code, examples, integrations, and documentation as well as bug reports and feature requests! Learn how here.