Skip to main content

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.

Project description

tool icon LLM Compressor

docs PyPI

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

  • Comprehensive set of quantization algorithms and transforms for weight, activation, KV Cache, and attention quantization
  • Seamless integration with Hugging Face models and repositories
  • Models saved in the compressed-tensors format, compatible with vLLM
  • DDP and disk offloading support for compressing very large models

✨ Read the announcement blog here! ✨

LLM Compressor Flow


📊 Help us improve by taking our 1-minute user survey

💬 Join us on the vLLM Community Slack and share your questions, thoughts, or ideas in:

  • #sig-quantization
  • #llm-compressor

🚀 What's New!

Big updates have landed in LLM Compressor! To get a more in-depth look, check out the LLM Compressor overview.

Some of the exciting new features include:

Supported Precisions and Types

  • Activation Quantization: W8A8 (int8 and fp8), W4AFP8, Microscale (NVFP4, MXFP4, MXFP8)
  • Mixed Precision: W4A16, W8A16, MXFP8A16, MXFP4A16, NVFP4A16
  • Attention and KV Cache Quantization: FP8, NVFP4

Supported Algorithms

  • Simple PTQ
  • GPTQ
  • AWQ
  • SmoothQuant
  • AutoRound
  • Rotation-based (SpinQuant, QuIP)

Quantizing your model, step-by-step

Please refer to our step-by-step compression guide for detailed information about selecting quantization schemes, algorithms, and their use cases.

Additional information about LLM Compressor functionality is also available in our User Guides

Installation

pip install llmcompressor

Get Started

End-to-End Examples

Applying quantization with llmcompressor:

Weight and Activation Quantization

Weight Only Quantization

Attention and KV Cache Quantization

Architecture-Specific Quantization

Non-Uniform Quantization

Big Model Quantization Support

Model-Free Definition Quantization

DDP Quantization

Quick Tour

Let's quantize Qwen3-30B-A3B with FP8 weights and activations using the Round-to-Nearest algorithm.

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 compressed_tensors.offload import dispatch_model
from transformers import AutoModelForCausalLM, AutoTokenizer

from llmcompressor import oneshot
from llmcompressor.modifiers.quantization import QuantizationModifier

MODEL_ID = "Qwen/Qwen3-30B-A3B"

# Load model.
model = AutoModelForCausalLM.from_pretrained(MODEL_ID)
tokenizer = AutoTokenizer.from_pretrained(MODEL_ID)

# Configure the quantization algorithm and scheme.
# In this case, we:
#   * quantize the weights to FP8 using RTN with block_size 128
#   * quantize the activations dynamically to FP8 during inference
recipe = QuantizationModifier(
    targets="Linear",
    scheme="FP8_BLOCK",
    ignore=["lm_head", "re:.*mlp.gate$"],
)

# Apply quantization.
oneshot(model=model, recipe=recipe)

# Confirm generations of the quantized model look sane.
print("========== SAMPLE GENERATION ==============")
dispatch_model(model)
input_ids = tokenizer("Hello my name is", return_tensors="pt").input_ids.to(
    model.device
)
output = model.generate(input_ids, max_new_tokens=20)
print(tokenizer.decode(output[0]))
print("==========================================")

# Save to disk in compressed-tensors format.
SAVE_DIR = MODEL_ID.split("/")[1] + "-FP8-BLOCK"
model.save_pretrained(SAVE_DIR)
tokenizer.save_pretrained(SAVE_DIR)

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("Qwen/Qwen3-30B-A3B-FP8-BLOCK")
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.

Citation

If you find LLM Compressor useful in your research or projects, please consider citing it:

@software{llmcompressor2024,
    title={{LLM Compressor}},
    author={Red Hat AI and vLLM Project},
    year={2024},
    month={8},
    url={https://github.com/vllm-project/llm-compressor},
}

!!! warning Sparse compression (24 sparsity) is no longer supported by LLM Compressor due to lack of hardware support and usage

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

llmcompressor-0.12.1a20260615.tar.gz (2.4 MB view details)

Uploaded Source

Built Distribution

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

llmcompressor-0.12.1a20260615-py3-none-any.whl (299.4 kB view details)

Uploaded Python 3

File details

Details for the file llmcompressor-0.12.1a20260615.tar.gz.

File metadata

  • Download URL: llmcompressor-0.12.1a20260615.tar.gz
  • Upload date:
  • Size: 2.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for llmcompressor-0.12.1a20260615.tar.gz
Algorithm Hash digest
SHA256 df04f8b18236197c6faf96dcf8dd601eb16eaeaa497f368adcfd4589f4c80342
MD5 6dee44c367f3b70c45ee2e4b0ccab1ce
BLAKE2b-256 2c023f5315d55f8b80213b49c849275dfba2162c957c6d3fe8c3a17c75d84530

See more details on using hashes here.

Provenance

The following attestation bundles were made for llmcompressor-0.12.1a20260615.tar.gz:

Publisher: upload.yml on neuralmagic/llm-compressor-testing

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

File details

Details for the file llmcompressor-0.12.1a20260615-py3-none-any.whl.

File metadata

File hashes

Hashes for llmcompressor-0.12.1a20260615-py3-none-any.whl
Algorithm Hash digest
SHA256 e10fe5c0cc6148dc107c53d52ff1791f678b071ef96502b7ece3706f34462438
MD5 0fa53908199f3b6cab87b590af0142a6
BLAKE2b-256 50db9ffb206a825b5b9387f078e8643aa55ef92cff26e8792fc665a0f556d007

See more details on using hashes here.

Provenance

The following attestation bundles were made for llmcompressor-0.12.1a20260615-py3-none-any.whl:

Publisher: upload.yml on neuralmagic/llm-compressor-testing

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