Author: JH

  • Troubleshooting CrewAI ValidationError: Please Provide an OpenAI API Key

    Troubleshooting CrewAI ValidationError: Please Provide an OpenAI API Key

    TL;DR

    Enabling memory=True on a Crew triggers a Pydantic ValidationError when an OpenAI API key is absent because CrewAI’s embedder parameter defaults to {“provider”: “openai”}.

    Issue #2943 was reported on crewAI 0.121.0 and has since been closed as completed, with a linked commit titled “Fix ValidationError when using memory=True without OpenAI API key”. The sources do not say whether newer releases still reproduce it, but the OpenAI default for memory embeddings is documented across versions, so a missing key or custom embedder is the first thing to check.

    Other OpenAI-related failures, such as knowledge sources or agent and manager LLMs, are separate problems with separate fixes. Setting a Crew embedder does not resolve those.

    For the memory error, either set the OPENAI_API_KEY environment variable or pass an explicit custom embedder configuration (such as Ollama).

    The Symptom: Pydantic ValidationError on Crew Initialization with memory=True

    In issue #2943 submitted to the CrewAI repository, a developer reported an error when adding the parameter memory=True to a Crew. While the setup executed without issue with cache=True, enabling memory=True immediately triggered a validation error.

    The issue occurred during Crew instantiation:

    synergistic_crew = Crew(
        agents=[holiday_agent, macro_agent, news_summarizer_agent, analysis_forecast_agent, user_query_agent],
        tasks=[holiday_task, macro_task, news_summarizer_task, analysis_forecast_task, user_query_task],
        process=Process.sequential,
        verbose=True,
        cache=True,
        memory=True
    )
    

    Adding memory=True produced the following Pydantic validation failure:

    validated_self = self.__pydantic_validator__.validate_python(data, self_instance=self)
                         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    pydantic_core._pydantic_core.ValidationError: 1 validation error for Crew
      Value error, Please provide an OpenAI API key. You can get one at https://platform.openai.com/account/api-keys [type=value_error, input_value={'agents': [Agent(role=Ho...': True, 'memory': True}, input_type=dict]
        For further information visit https://errors.pydantic.dev/2.11/v/value_error
    

    The issue report listed the environment as Ubuntu 20.04, Python 3.10, Venv, crewAI version 0.121.0, and crewAI Tools version 0.45.0. Although the reporter noted using “pydantic version V1”, the traceback references pydantic_core and links to https://errors.pydantic.dev/2.11/v/value_error, indicating that Pydantic v2.11 was actively running in the runtime environment.

    The issue was later closed as completed on 2025-06-04, with a linked commit titled “Fix ValidationError when using memory=True without OpenAI API key”. The thread does not state which release contains the fix, so check your installed version and its changelog before assuming you will see the exact same error today.

    Sources: error-pydantic_core._pydantic_core.ValidationError: 1 validation error for Crew

    Why the Error Triggers: Pydantic Validators and OpenAI Default Fallbacks

    CrewAI relies on Pydantic to validate configuration parameters and dependencies when instantiating objects like Crew, Agent, and Task. When memory=True is set on a Crew, CrewAI initializes its memory system, which requires an embedding model to convert text into vector representations. According to the Crews documentation (v1.15.28), the embedder attribute on Crew defaults to {“provider”: “openai”}.

    In issue #2943 on 0.121.0, enabling memory without an alternative embedder and without an OpenAI key produced a validation error whose message asks for an OpenAI API key. The sources do not show exactly where in the Crew validators the check runs, but the traceback shows it surfacing as a Pydantic error during Crew construction:

    ValidationError: 1 validation error for Crew Value error, Please provide an OpenAI API key
    

    Versions matter here. The issue was filed on crewAI 0.121.0, the Crew attribute descriptions in this article come from the v1.15.28 docs, and the unified Memory class comes from the “edge” docs. The Crews docs describe memory in terms of short-term, long-term, and entity memory, while the edge docs describe a single unified Memory class. In both, the documented default embedder is OpenAI. Where a behavior comes from only one of these sources, the text below says so.

    Other parts of CrewAI also involve OpenAI by default or require explicit configuration. They fail at different points and have different fixes:

    • Memory Embeddings: Directly tied to Crew initialization when memory=True, triggering the reported validation error if embedder remains at its OpenAI default.
    • Agent LLMs: The “Connect to any LLM” documentation covers configuring a non-OpenAI model per agent. The fix is setting the llm parameter on the Agent, not the Crew embedder.
    • Hierarchical Process Coordination: When setting process=Process.hierarchical, the Crews documentation specifies that manager_llm or manager_agent is required. Supply one of them. The embedder setting does not affect this.
    • Knowledge Sources: Issue #2164 reports a separate “Invalid Knowledge Configuration: Please provide an OpenAI API key” error for agent knowledge. It is a different error message from the memory one, so check that issue for its own fix.

    Sources: error-pydantic_core._pydantic_core.ValidationError: 1 validation error for Crew · Issue #2943 · crewAIInc/crew, [BUG] Agent knowledge – Invalid Knowledge Configuration: Please provide an OpenAI API key. · Issue #2164 · cre, Crews – CrewAI, Memory – CrewAI, Connect to any LLM – CrewAI

    Inspecting Crew Attributes and Execution Flow Defaults

    The Crew attributes below come from the v1.15.28 Crews documentation. In issue #2943, the same crew ran with cache=True but failed once memory=True was added:

    • embedder: Configuration dictionary for the embedding provider used by the crew. It is primarily utilized by memory and defaults to {“provider”: “openai”}.
    • memory: Toggles memory systems (short-term, long-term, entity memory in earlier documentation; unified Memory in newer releases). It defaults to False.
    • cache: Toggles caching, defaulting to True.
    • process: Execution flow strategy, defaulting to Process.sequential. When set to Process.hierarchical, manager_llm or manager_agent is required.
    • verbose: Controls logging verbosity, defaulting to False.
    • max_rpm: Maximum requests per minute, defaulting to None.

    The embedder attribute is described as primarily used by memory and defaults to {“provider”: “openai”}. The reporter’s crew had cache=True throughout and the error appeared only after memory=True was added, which points at the memory setting. The sources do not explain why cache=True was unaffected, so treat any explanation of that as an inference.

    Sources: Crews – CrewAI

    The Underlying Culprit: CrewAI Unified Memory and Embedding Requirements

    In newer releases of CrewAI (as outlined in the edge documentation), the framework consolidates memory handling into a unified Memory class. When memory=True is passed, the crew creates a default Memory() instance and passes through the crew’s embedder setting.

    In this unified system, memory recall ranks results using composite scoring:

    composite = semantic_weight * similarity + recency_weight * decay + importance_weight * importance
    

    where similarity is computed from vector distances:

    similarity = 1 / (1 + distance)
    

    According to the official documentation, without an explicit embedder configuration, Memory uses OpenAI text-embedding-3-large embeddings to power these vector calculations. When memories are saved, an LLM also infers scope, categories, and importance scores.

    To resolve the ValidationError, developers have two options depending on their architecture:

    Option 1: Providing the OpenAI API Key
    If you plan to use OpenAI models or embeddings, supply the key as an environment variable before initializing your crew (ideally via a .env file or your shell environment):

    import os
    
    os.environ["OPENAI_API_KEY"] = "your-openai-api-key"
    

    Option 2: Configuring a Custom Embedder (Non-OpenAI Setup)
    If you run local or alternative models (such as Ollama) and do not want to use OpenAI, configure a custom embedder. The Crews docs list embedder as a Crew attribute, so the example below passes it to Crew. The edge Memory docs show the same kind of embedder configuration on a Memory(embedder=…) instance, with the Ollama model key named “model_name”. Check which form your installed version accepts:

    from crewai import Crew, Process
    
    crew = Crew(
        agents=[research_agent, writer_agent],
        tasks=[research_task, write_task],
        process=Process.sequential,
        memory=True,
        embedder={
            "provider": "ollama",
            "config": {
                "model_name": "mxbai-embed-large",
                "url": "http://localhost:11434/api/embeddings"
            }
        }
    )
    

    Explicitly declaring the embedder replaces the {“provider”: “openai”} default. This addresses the memory embedding error only. It does not change the llm setting on agents or manager_llm.

    Sources: Memory – CrewAI

    Closing thoughts

    Convenience flags like memory=True simplify multi-agent workflows, but they often carry implicit dependencies on default cloud providers. In CrewAI, enabling memory activates embedding operations that default to OpenAI unless overridden.

    When building workflows with alternative providers or local models, actively specifying configuration parameters—such as setting a custom embedder or defining model providers explicitly—prevents unexpected Pydantic validation errors during crew initialization.

    Frequently Asked Questions

    Why does setting memory=True trigger a validation error requesting an OpenAI API key?

    Enabling memory=True activates CrewAI’s memory system, which requires an embedding model for vector storage and retrieval. Because the embedder parameter defaults to {“provider”: “openai”}, Crew initialization raises a Pydantic ValidationError if OPENAI_API_KEY is not found in the environment.

    What default embedding model does CrewAI use for its memory system?

    The embedder parameter defaults to {“provider”: “openai”}. In CrewAI’s unified Memory documentation, the default embedding model is specified as OpenAI text-embedding-3-large.

    How can you resolve this error without an OpenAI API key?

    You can provide a custom embedder dictionary to the Crew, such as using provider ollama with an embedding model like mxbai-embed-large, or set the OPENAI_API_KEY environment variable. Check which embedder form your installed version accepts.

    Why did cache=True work in issue #2943 while memory=True failed?

    In the issue, the reporter’s crew with cache=True ran, and the error appeared only after memory=True was added. The sources do not give a reason for the difference. The Crews docs describe embedder as primarily used by memory, which is consistent with the error following memory=True.


    Keep reading: LLM Agents & Tooling

    All guides in this series: LLM Agent Guides: LangChain, LangGraph & AI Tooling

  • QuaRot: Enabling End-to-End 4-Bit LLM Inference via Randomized Rotations

    QuaRot: Enabling End-to-End 4-Bit LLM Inference via Randomized Rotations

    TL;DR

    • QuaRot enables full 4-bit quantization across weights, activations, and the KV cache without retaining high-precision channels.
    • The framework suppresses disruptive activation outliers by using Randomized Hadamard Rotations via computational invariance to disperse peak magnitudes across dimensions.
    • Offline orthogonal rotations fuse directly into weights and normalization layers with zero inference overhead, while lightweight online Hadamard transforms handle internal activations and attention states.

    The Challenge of Outliers in Low-Bit LLM Quantization

    While weight-only 4-bit quantization (W4A16) is widely adopted, true end-to-end low-precision Post-Training Quantization (PTQ)—quantizing weights, activations, and the KV Cache to 4 bits (W4A4 Quantization with 4-bit KV Cache)—has historically resulted in severe accuracy degradation.

    The primary difficulty stems from Activation Outliers: persistent, extreme-value activations in specific channels with magnitudes orders of magnitude larger than standard features. Conventional uniform quantizers cannot allocate sufficient dynamic range to represent these channels without crushing non-outlier features to zero.

    Prior Post-Training Quantization approaches handle outliers through differing mechanisms that carry distinct trade-offs:

    • Outlier Channel Migration vs. Mixed-Precision Retention: SmoothQuant uses per-channel scaling factors to migrate quantization difficulty from activations to weights, targeting 8-bit quantization without keeping mixed-precision channels. In contrast, frameworks like LLM.int8() (and later works like QUIK and Atom) detect outliers dynamically or offline and retain those sensitive channels in higher precision (such as FP16).
    • Kernel and Hardware Overhead: For methods retaining mixed-precision channels, specialized execution kernels are required, introducing memory layout overhead, non-contiguous indexing, and hardware underutilization during matrix multiplication.

    Sources: GitHub – spcl/QuaRot: Code for Neurips24 paper: QuaRot, an end-to-end 4-bit inference of large language models, microsoft.com/en-us/research/publication/quarot-outlier-free-4-bit-in…, QuaRot: Outlier-Free 4-Bit Inference in Rotated LLMs, openreview.net/forum, Vercel Security Checkpoint

    What Is QuaRot and How Randomized Rotations Eliminate Outliers

    To eliminate the need for mixed-precision channels, QuaRot introduces an end-to-end Post-Training Quantization (PTQ) framework that achieves full W4A4 Quantization and 4-bit KV Cache compression. Rather than keeping outlier channels in FP16 during inference, QuaRot suppresses them across the model using Randomized Hadamard Rotations applied via Computational Invariance.

    A randomized Hadamard transformation multiplies a standard Hadamard matrix H by a diagonal matrix diag(s), where s is a vector of random signs drawn from {+1, -1}. A weight matrix W is defined as mu-incoherent if:

    max(W) <= mu * ||W||_F / sqrt(m * n)

    When incoherence is high, large individual elements emerge as outliers relative to the average magnitude. Multiplying by orthogonal randomized Hadamard matrices spreads high-energy spikes across all dimensions, systematically lowering incoherence and shaping activation distributions into uniform forms amenable to low-bit uniform quantizers.

    Under the principle of Computational Invariance, transformers remain invariant to orthogonal transformations across linear and normalization layers. Specifically, multiplying an input projection weight matrix on the left by Q^T and post-multiplying the preceding output projection matrix on the right by Q yields mathematically equivalent outputs. This invariance holds across RMSNorm operations because normalization commutes with orthogonal rotations when rescaling parameters (diag(alpha)) are fused into the subsequent weights:

    RMSNorm(X) = RMSNorm(X * Q^T) * Q

    QuaRot structures its modifications into two stages, illustrated below via mathematical pseudocode:

    # Stage 1: Transformations and Invariance (Mathematical Pseudocode)
    # Applied to all input projections following RMSNorm (W_q, W_k, W_v, W_gate, W_up):
    W_in      <- Q^T * diag(alpha) * W_in
    
    # Output projections post-multiplied by Q; FFN down-proj absorbs H:
    W_down    <- H * W_down * Q
    
    # Attention value and output projections:
    W_v       <- W_v * (I (x) H_d_h)
    W_out     <- (H_n_h (x) I) * (I (x) H_d_h) * W_out = H * W_out
    
    # Online post-RoPE transformations for queries and keys:
    Q_rot     <- Pos(X * W_q) * (I (x) H_d_h)
    K_rot     <- Pos(X * W_k) * (I (x) H_d_h)
    
    # Stage 2: Quantization
    Scale     <- max(|row|) / 7
    Quantized <- round(row / Scale)
    

    In the first stage, RMSNorm scale parameters (diag(alpha)) are absorbed into adjacent input projection weights (including W_q, W_k, W_v, W_gate, and W_up), and randomized Hadamard rotation Q matches the hidden dimension to rotate hidden states (X <- X * Q). Because Q is merged directly into static weights offline, these inter-block rotations incur zero runtime inference overhead. Within the Feed-Forward Network (FFN), an online Hadamard transform is applied before the down-projection layer and cancelled out by fusing H into W_down. In the Multi-Head Attention module, head-wise Hadamard transforms H_d_h are applied to W_v and W_out, and an online Hadamard heads block applies (H_n_h (x) I) to attention activations Z. For keys and queries, online head-wise Hadamard rotations are applied post-RoPE, preserving attention scores while eliminating outliers from the KV Cache.

    In the second stage, weights are quantized (via GPTQ or round-to-nearest), while activations undergo online symmetric per-token quantization scaled by dividing the absolute maximum by 7. The KV Cache is quantized using asymmetric 4-bit quantization with a group size of 128.

    Empirically, on LLaMA-2 70B, QuaRot achieves full W4A4KV4 inference with a WikiText-2 perplexity loss of at most 0.47 (degrading from 3.32 to 3.79), while retaining over 99% of original zero-shot accuracy. In hardware benchmarks, it achieves prefill speedups of up to 2.16x on LLaMA-2 7B and 3.33x on LLaMA-2 70B (batch size 64, sequence length 2048), alongside up to 3.89x memory savings during decoding due to 4-bit KV caching.

    Sources: QuaRot: Outlier-Free 4-Bit Inference in Rotated LLMs

    Closing thoughts

    By leveraging computational invariance, QuaRot treats activation outliers not as an unavoidable feature of large language models, but as a coordinate-alignment artifact that can be systematically rotated away. This contrasts with mixed-precision retention strategies such as LLM.int8(), QUIK, or Atom, which keep sensitive channels in FP16 or INT8 and require specialized, non-contiguous matrix multiplication kernels, as well as SmoothQuant, which migrates difficulty through channel scaling.

    A key distinction in QuaRot is that offline rotations are fused directly into linear weights and normalization layers at zero runtime cost, while online Hadamard operations are restricted to intermediate points like the FFN down-projection and post-RoPE attention heads. Structurally neutralizing incoherence prior to uniform quantization allows standard integer GEMM kernels to execute across all weights, activations, and KV cache states with minimal accuracy degradation.

    Frequently Asked Questions

    What is QuaRot?

    QuaRot is an end-to-end Post-Training Quantization framework that enables 4-bit weight, activation, and KV Cache quantization without retaining high-precision channels. It eliminates activation outliers by applying Randomized Hadamard Rotations through computational invariance.

    Why do activation outliers cause issues in low-bit LLM quantization?

    Activation outliers are extreme values in specific channels that are orders of magnitude larger than standard features. Conventional uniform quantizers cannot allocate sufficient dynamic range for these channels without crushing the remaining non-outlier features to zero.

    How does QuaRot differ from approaches like SmoothQuant and LLM.int8()?

    SmoothQuant uses per-channel scaling to migrate quantization difficulty from activations to weights for 8-bit quantization without keeping mixed-precision channels. LLM.int8() isolates outlier channels dynamically to compute them in FP16. QuaRot takes a different approach: it applies orthogonal Hadamard rotations to disperse peak magnitudes across dimensions, allowing uniform 4-bit quantization across all matrix operations without mixed-precision channels.

    How does QuaRot quantize the KV Cache?

    QuaRot applies online head-wise Randomized Hadamard Rotations post-RoPE to keys and queries to remove outliers directly from the KV Cache. The cache is then compressed using asymmetric 4-bit quantization with a group size of 128.


    Keep reading: LLM Inference & Serving

    All guides in this series: LLM Inference & Serving Guides: vLLM, Ollama & Hugging Face

  • Troubleshooting vLLM Startup: Resolving KV Cache Capacity Exceeded Errors

    Troubleshooting vLLM Startup: Resolving KV Cache Capacity Exceeded Errors

    TL;DR

    • vLLM aborts engine initialization with a ValueError when the allocated KV cache capacity cannot accommodate the model’s maximum sequence length for at least one request.

    • The issue is commonly resolved by decreasing max_model_len, increasing gpu_memory_utilization, or applying tensor parallelism and quantization.

    • In tight-margin boundary cases, switching to the FlashInfer attention backend—either explicitly or implicitly via FP8 KV cache—has been observed to leave less available KV cache memory, triggering this error under otherwise identical settings.

    Diagnosing the KV Cache Exceeded ValueError during Engine Initialization

    During engine initialization and cache profiling, vLLM manages key-value activations in fixed-size blocks via PagedAttention. Before processing inference requests, the engine evaluates available memory and performs a sanity check: the total number of tokens that can fit into the allocated KV cache blocks must be at least as large as the configured maximum sequence length. If the KV cache capacity is smaller than that limit, the engine aborts initialization with a traceback:

    ValueError: The model's max seq len (<X>) is larger than the maximum number of tokens that can be stored in KV cache (<Y>). Try increasing gpu_memory_utilization or decreasing max_model_len when initializing the engine.
    

    This error prevents runtime Out-of-Memory (OOM) faults by ensuring the engine has enough memory to process at least a single full-context request. The available space for cache blocks is roughly calculated as:

    KV Cache Memory ≈ (Total GPU Memory * gpu_memory_utilization) - (Weights + Activations + CUDA Graphs)
    

    Two primary factors trigger this error during startup:

    • Unset or high default context window: If max_model_len (CLI flag --max-model-len) is omitted, vLLM falls back to the native context limit in the model’s Hugging Face config.json (such as max_position_embeddings, which can reach 32,768, 65,536, or 131,072+ tokens). On GPU memory-constrained hardware, the engine cannot allocate enough blocks to cover such large sequences.
    • Model weight and runtime overhead: Serving models in unquantized FP16 or BF16 formats or enabling CUDA graph capture consumes the majority of the GPU memory budget, leaving insufficient headroom for the remaining KV cache pool.

    To resolve the error during engine initialization, adjust the memory configuration via the following flags:

    vllm serve <model_name> --max-model-len 4096 --gpu-memory-utilization 0.95
    

    Setting --max-model-len to an integer lower than the reported capacity directly caps the required sequence ceiling. Raising gpu_memory_utilization (CLI flag --gpu-memory-utilization) above its default of 0.9 (for example, to 0.95) expands the engine’s reserved GPU memory quota, provided sufficient headroom remains to avoid runtime OOM spikes.

    Additional memory can be freed by distributing weights and attention heads across multiple GPUs using tensor parallelism via --tensor-parallel-size, applying model weight quantization (such as FP8, AWQ, or GPTQ), or specifying --kv-cache-dtype as fp8 (or fp8_e4m3 / fp8_e5m2 on supported architectures) to cut the per-token KV footprint by approximately 50% compared to 16-bit floats. However, operators should be aware that enabling FP8 KV cache can implicitly select the FlashInfer backend on certain GPUs, which in tight memory margin scenarios may reduce the available KV cache pool and trigger this initialization check.

    Sources: [Usage]: What's the relationship between KV cache and MAX_SEQUENCE_LENGTH. · Issue #10517 · vllm-project/vllm , worker – vLLM, docs.vllm.ai/en/latest/design/hybrid_kv_cache_manager, vLLM KV Cache OOM: The Flags That Actually Fix It, Conserving Memory – vLLM

    Resolving Hidden Memory Overhead from FLASHINFER and FP8 KV Cache Configurations

    Beyond standard sequence length and utilization tuning, a ValueError during KV cache initialization can also arise in tight-margin boundary conditions when switching the attention backend via --attention-backend, even when GPU memory, --max-model-len (max_model_len), and --gpu-memory-utilization (gpu_memory_utilization) settings remain identical. In an issue reported on the vLLM repository, serving RedHatAI/Qwen3.8-27B-INT4 (a hybrid Mamba/GDN architecture) on two 16 GB RTX 5060 Ti GPUs (PyTorch 2.13.0+cu130, flashinfer-python 0.6.18, vLLM 0.28.0 and 0.28.1rc1.dev446+g798544433) succeeded under the default FlashAttention (FLASH_ATTN) backend, creating a pool of 105,594 tokens on the development build (108,589 tokens on 0.28.0).

    However, explicitly passing --attention-backend FLASHINFER caused engine initialization to fail. Note that the reproduction command included specialized flags tailored for this hybrid model setup, such as --mamba-cache-mode align, rather than standard generic parameters:

    vllm serve RedHatAI/Qwen3.8-27B-INT4 --tensor-parallel-size 2 \
      --gpu-memory-utilization 0.90 --max-model-len 100352 --max-num-seqs 32 \
      --mamba-cache-mode align --max-num-batched-tokens 3135 \
      --attention-backend FLASHINFER
    

    This configuration failed during the memory check with the following error:

    ValueError: To serve at least one request with the model's max seq len (100352),
    3.21 GiB KV cache is needed, which is larger than the available KV cache memory
    (3.06 GiB). Try increasing `gpu_memory_utilization` ... or decreasing `max_model_len` ...
    

    On vLLM 0.28.0, the same message reported 3.15 GiB available memory instead of 3.06 GiB. Users can also encounter this issue without explicitly setting --attention-backend FLASHINFER, as setting --kv-cache-dtype fp8 implicitly selects FlashInfer on some GPUs. While the exact root cause was not definitively settled in the issue report, the reporter suggested that the FlashInfer workspace memory might not be reserved prior to calculating the KV cache pool size. Because the original error message only advised adjusting gpu_memory_utilization or max_model_len, it never informed users that the attention backend was the variable that changed.

    To address this ambiguity, a pull request has been proposed (still open) to identify the active attention backend and include that information directly within the existing ValueError.

    Sources: [Bug]: –attention-backend FLASHINFER fails the startup KV-cache check at a max-model-len that FLASH_ATTN serves; the message never names the backend, kv cache Value Erorr msg improvement Attention Backend

    Closing thoughts

    Ultimately, while trimming --max-model-len or nudging gpu_memory_utilization upward provides a quick mechanical fix, this error illustrates that KV cache headroom is governed by far more than just model weights and user-defined sequence caps. As the observed FlashInfer boundary case demonstrates, backend selection—whether configured explicitly or selected implicitly through options like FP8 KV caching—can alter the memory available for cache blocks and break razor-thin initialization budgets. Rather than reflexively sacrificing context length when this check fails, operators on memory-constrained GPUs should consider backend selection as an active variable in their memory budget. In this context, the proposed pull request to expose the active attention backend directly within the ValueError traceback represents a welcome diagnostic improvement, clarifying what variable actually impacted the available memory pool.

    Frequently Asked Questions

    Why does vLLM throw a ValueError regarding KV cache capacity during engine initialization?

    The error occurs during memory profiling if the total number of tokens that can fit into the allocated KV cache blocks is smaller than the model’s configured maximum sequence length. This sanity check aborts startup to prevent runtime Out-of-Memory faults, ensuring the engine has enough memory to handle at least a single full-context request.

    What are the primary ways to fix the KV cache ValueError?

    You can resolve the error by decreasing the maximum sequence ceiling with --max-model-len or increasing --gpu-memory-utilization (for example, to 0.95) to allocate more GPU memory. Additional remedies include enabling tensor parallelism via --tensor-parallel-size, applying model weight quantization, or setting --kv-cache-dtype to fp8 to reduce the per-token KV footprint (bearing in mind that FP8 KV cache may implicitly select FlashInfer).

    How can changing the attention backend trigger this KV cache error?

    In narrow memory margin setups, switching the attention backend to FLASHINFER has been observed to leave less available KV cache memory compared to FLASH_ATTN (suspected to stem from how backend workspace memory is reserved relative to KV cache pool sizing). This difference can cause initialization to fail even when GPU memory, --max-model-len, and --gpu-memory-utilization remain completely unchanged.

    Can the FLASHINFER backend be activated without passing --attention-backend FLASHINFER?

    Yes, setting --kv-cache-dtype fp8 implicitly selects the FlashInfer backend on some GPUs, which can alter available KV cache headroom in tight boundary cases and trigger the initialization error.


    Keep reading: LLM Inference & Serving

    All guides in this series: LLM Inference & Serving Guides: vLLM, Ollama & Hugging Face

  • Troubleshooting ChromaDB InvalidDimensionException: Resolving the 1536 vs 384 Dimension Mismatch

    Troubleshooting ChromaDB InvalidDimensionException: Resolving the 1536 vs 384 Dimension Mismatch

    TL;DR

    • ChromaDB raises an InvalidDimensionException when a collection defaults to a 384-dimensional embedder at creation but receives 1536-dimensional query vectors from models like OpenAI.
    • ChromaDB collections enforce a strict, immutable coordinate space that cannot be modified in place once initialized.
    • To prevent dimension mismatches, developers must explicitly configure the desired embedding function when creating the collection.

    Diagnosing the InvalidDimensionException When Using OpenAI Embeddings

    This exception typically manifests when a collection is populated using ChromaDB’s default embedding pipeline and subsequently queried with an external OpenAI embedding model. In a report involving ChromaDB 0.4.24 and Python 3.11.8, a user encountered this failure during retrieval:

    InvalidDimensionException: Embedding dimension 1536 does not match collection dimensionality 384
    

    The underlying issue stems from a mismatch between the embedding function used at document ingestion and the embedding function used at query time. The following pattern illustrates how this mismatch occurs in code:

    persistent_client = chromadb.PersistentClient()
    collection = persistent_client.create_collection("emp6")
    
    # Adding documents without specifying an embedding function defaults to 384 dimensions
    for doc in docs:
        collection.add(
            ids=[str(uuid.uuid1())], metadatas=doc.metadata, documents=doc.page_content
        )
    
    # Querying via LangChain Chroma initialized with OpenAI embeddings (1536 dimensions)
    langchain_chroma = Chroma(
        client=persistent_client,
        collection_name="emp6",
        embedding_function=OpenAIEmbeddings(),
    )
    docs1 = langchain_chroma.similarity_search("What is venture")
    

    This snippet demonstrates creating a collection and adding documents without providing an explicit embedding_function, followed by executing a similarity search through LangChain’s Chroma wrapper configured with OpenAIEmbeddings().

    When calling create_collection without an explicit embedding_function parameter, ChromaDB applies its default embedding function, producing vector embeddings with 384 dimensions when documents are added via collection.add(...). When querying that same collection through an interface configured with OpenAIEmbeddings()—such as LangChain’s similarity_search—the incoming query text is converted into a 1536-dimensional vector. Because the existing collection was already indexed at 384 dimensions, ChromaDB rejects the 1536-dimensional query vector with chromadb.errors.InvalidDimensionException.

    Sources: [Bug]: InvalidDimensionException: Embedding dimension 1536 does not match collection dimensionality 384

    Why ChromaDB Defaults to 384 Dimensions and Enforces Fixed Index Dimensionality

    To understand why this mismatch occurs, it helps to look at how ChromaDB handles vector spaces by default. ChromaDB sets a default dimensionality of 384 because its built-in embedder, DefaultEmbeddingFunction, uses the Sentence Transformers model all-MiniLM-L6-v2, which generates 384-dimensional embeddings. When a collection is initialized using create_collection or get_or_create_collection without specifying the embedding_function parameter, ChromaDB applies this default embedder and sets the collection dimensionality to 384.

    ChromaDB enforces strict dimensionality consistency across all records. By default, the underlying vector index is an HNSW graph index constructed for a single, fixed coordinate space, meaning a collection cannot store or query mixed-dimension vectors.

    Furthermore, collection dimensionality cannot be modified in place once initialized. If an operation—including add, upsert, update, or query—attempts to pass embeddings that do not match the collection’s expected dimensionality, ChromaDB rejects the operation and raises chromadb.errors.InvalidDimensionException.

    Sources: Embedding Functions – Chroma Docs, Adding Data to Chroma Collections – Chroma Docs, Configure Collections – Chroma Docs, chromadb.errors.InvalidDimensionException: Dimensionality of (512) does not match index dimensionality (768) ·, Sentence Transformer – Chroma Docs

    Configuring ChromaDB Collections with OpenAI's 1536-Dimension Embedding Function

    To prevent this conflict and ensure your collection accepts 1536-dimensional vectors, you must explicitly supply an embedding function during collection creation. In Python, the chromadb package includes built-in wrappers for providers, allowing you to import OpenAIEmbeddingFunction directly from chromadb.utils.embedding_functions. You must also set your OPENAI_API_KEY environment variable.

    When calling create_collection, link the embedding function to the collection using the embedding_function parameter:

    # Set your OPENAI_API_KEY environment variable
    from chromadb.utils.embedding_functions import OpenAIEmbeddingFunction
    
    collection = client.create_collection(
        name="my_collection",
        embedding_function=OpenAIEmbeddingFunction(
            model_name="text-embedding-3-small"
        ),
    )
    
    # ChromaDB will use OpenAIEmbeddingFunction to embed your documents
    collection.add(
        ids=["id1", "id2"],
        documents=["doc1", "doc2"],
    )
    

    This configuration ensures ChromaDB automatically invokes OpenAIEmbeddingFunction to generate vector representations whenever you call add, update, upsert, or query on the collection using raw text documents.

    For TypeScript applications, install the provider package using a package manager (such as npm install @chroma-core/openai, pnpm add @chroma-core/openai, bun add @chroma-core/openai, or yarn add @chroma-core/openai). You can then pass the initialized instance to createCollection:

    // Set your OPENAI_API_KEY environment variable
    import { OpenAIEmbeddingFunction } from "@chroma-core/openai";
    
    collection = await client.createCollection({
      name: "my_collection",
      embedding_function: new OpenAIEmbeddingFunction({
        modelName: "text-embedding-3-small",
      }),
    });
    
    await collection.add({
      ids: ["id1", "id2"],
      documents: ["doc1", "doc2"],
    });
    

    This TypeScript setup links OpenAIEmbeddingFunction to the collection so that document insertions and queries are embedded using the specified model rather than the default.

    In environments using the Rust client, embedding functions are not attached to the collection; instead, embeddings must be generated separately with your provider SDK and passed directly into calls such as add and query.

    Sources: Embedding Functions – Chroma Docs

    Deleting, Recreating, and Re-indexing Data in ChromaDB

    Once an appropriately configured collection is in place—or when recreating one from scratch—you can safely begin populating it. When inserting records into a collection, ChromaDB raises chromadb.errors.InvalidDimensionException if the supplied embeddings do not match the dimensionality of embeddings already in the collection. Additionally, attempting to re-add a record using an ID that already exists in the collection will be ignored without raising an error; overwriting existing data instead requires updating the data.

    To index new records into a collection, use .add. Each record requires a unique string ID, and you must supply either documents, embeddings, or both. Metadata is optional and can contain strings, integers, floats, booleans, or arrays of those types (empty arrays are not permitted, and all elements in an array must share the same type).

    If you pass only documents, ChromaDB automatically computes embeddings using the collection’s configured embedding_function:

    collection.add(
        ids=["id1", "id2", "id3"],
        documents=["lorem ipsum...", "doc2", "doc3"],
        metadatas=[{"chapter": 3, "verse": 16}, {"chapter": 3, "verse": 5}, {"chapter": 29, "verse": 11}],
    )
    

    This call generates embeddings for each document via the configured collection embedding_function before inserting them.

    If embeddings are precomputed, you can provide them alongside documents. ChromaDB stores the provided embeddings as-is without re-embedding:

    collection.add(
        ids=["id1", "id2", "id3"],
        embeddings=[[1.1, 2.3, 3.2], [4.5, 6.9, 4.4], [1.1, 2.3, 3.2]],
        documents=["doc1", "doc2", "doc3"],
        metadatas=[{"chapter": 3, "verse": 16}, {"chapter": 3, "verse": 5}, {"chapter": 29, "verse": 11}],
    )
    

    This method is used when you already have vector representations and want to avoid recalculating embeddings during ingestion. If your documents are stored externally (such as large images or videos), you can also pass only ids, embeddings, and metadatas, using the IDs to link the stored vectors back to external files.

    Sources: Adding Data to Chroma Collections – Chroma Docs

    Closing thoughts

    Ultimately, this error highlights the hidden hazard of ChromaDB’s default behavior: while falling back to a 384-dimensional model simplifies initial prototyping, it makes multi-tool pipelines—especially those bridging LangChain and OpenAI—deceptively fragile. Because Chroma’s underlying HNSW index enforces a strict, immutable coordinate space that cannot be modified in place, treating the embedding function as an optional setting is a risky architectural shortcut rather than a true convenience. Developers should view embedding function configuration as a mandatory schema definition from day one, explicitly establishing the expected dimensionality at collection creation to avoid the costly necessity of tearing down and re-indexing stored data.

    Frequently Asked Questions

    What causes the error ‘Embedding dimension 1536 does not match collection dimensionality 384’ in ChromaDB?

    This error occurs when a collection is created without an explicit embedding function, defaulting to 384 dimensions, and is subsequently queried with an external model like OpenAI that generates 1536-dimensional embeddings.

    Why does ChromaDB default to 384 dimensions?

    ChromaDB sets a default dimensionality of 384 because its built-in DefaultEmbeddingFunction relies on the Sentence Transformers model all-MiniLM-L6-v2, which outputs 384-dimensional vectors.

    Can you modify the dimensionality of an existing ChromaDB collection?

    No, collection dimensionality cannot be modified in place once initialized. ChromaDB’s underlying HNSW index enforces a fixed coordinate space, and any operation supplying mismatched vector dimensions will trigger an InvalidDimensionException.

    How can you configure a collection in Python to accept 1536-dimensional OpenAI embeddings?

    You can import OpenAIEmbeddingFunction from chromadb.utils.embedding_functions and pass it to the embedding_function parameter when calling create_collection, while ensuring the OPENAI_API_KEY environment variable is set.


    Keep reading: LLM Agents & Tooling

    All guides in this series: LLM Agent Guides: LangChain, LangGraph & AI Tooling

  • Troubleshooting LangGraph InvalidUpdateError: Resolving Concurrent State Updates with Annotated Reducers

    Troubleshooting LangGraph InvalidUpdateError: Resolving Concurrent State Updates with Annotated Reducers

    TL;DR

    • LangGraph raises InvalidUpdateError when multiple concurrent nodes write to the same state key in a single step without an aggregation rule.
    • To intentionally combine concurrent updates, define the state key using typing.Annotated and a reducer function such as operator.add.
    • Unintentional collisions can be prevented by assigning dedicated state keys to parallel branches or routing them into downstream fan-in nodes.

    Diagnosing InvalidUpdateError and the INVALID_CONCURRENT_GRAPH_UPDATE Error

    In LangGraph, conflicting writes during graph execution surface as the API class langgraph.errors.InvalidUpdateError. In LangGraph’s documentation, this issue is tracked under the standard error code INVALID_CONCURRENT_GRAPH_UPDATE.

    The runtime throws this error when multiple parallel nodes (such as Fan-out branches executing concurrently in the same super-step) return an update dictionary targeting the exact same state key. Because LangGraph cannot determine how to resolve the conflicting incoming values for a channel designed to handle only a single write per step, it halts execution to prevent silent data loss or non-deterministic overwrites.

    The exception produces the following message and troubleshooting reference:

    langgraph.errors.InvalidUpdateError: At key '<key>': Can receive only one value per step. Use an Annotated key to handle multiple values.
    For troubleshooting, visit: https://python.langchain.com/docs/troubleshooting/errors/INVALID_CONCURRENT_GRAPH_UPDATE
    

    (Note: Runtime exceptions may print the legacy troubleshooting URL python.langchain.com/..., which corresponds to the current documentation hosted under docs.langchain.com/....)

    This traceback indicates that two or more concurrently executing nodes attempted to write to <key> within the exact same super-step without an aggregation rule.

    When diagnosing this error, confirm whether the concurrent writes to the same key are intentional or the result of graph design:

    • Unintentional Key Collisions: If parallel branches produce distinct results that should not be combined into the same field, alter the graph structure to use dedicated state keys (such as branch_a_output and branch_b_output). Alternatively, route edges from the parallel nodes into a downstream convergence or fan-in node that consumes both results and applies the unified update in a subsequent step.
    • Intentional Multi-Branch Updates: If multiple parallel branches must write to the same collection or field simultaneously, the target key must be declared using typing.Annotated with an appropriate Reducer function to dictate how the concurrent values should be combined.

    Sources: INVALID_CONCURRENT_GRAPH_UPDATE – Docs by LangChain, InvalidUpdateError, Errors – Docs by LangChain, GitHub Issue Title: InvalidUpdateError when using parallel subgraphs with shared state keys in LangGraph · Iss, How to modify specific item in a State – LangGraph – LangChain Forum, docs(langgraph): fixes fan-out example

    The Pregel Execution Model: Why Concurrent Updates Halt the Tick Loop

    To understand why this failure occurs under the hood, it helps to examine how the Pregel execution model processes state within a super-step. Specifically, an INVALID_CONCURRENT_GRAPH_UPDATE error arises when a StateGraph receives concurrent updates to a state property that does not support them, such as during a Fan-out or other parallel execution where multiple nodes return values for the same key within a single step. While a single node returning a value overwrites that key in the state, multiple nodes returning values for the same key create uncertainty about how to update the internal state, causing the graph to raise an error.

    For example, executing a graph via graph.stream() under these conditions can result in a langgraph.errors.InvalidUpdateError:

    langgraph.errors.InvalidUpdateError: At key 'jokes': Can receive only one value per step. Use an Annotated key to handle multiple values.
    For troubleshooting, visit: https://python.langchain.com/docs/troubleshooting/errors/INVALID_CONCURRENT_GRAPH_UPDATE
    

    To prevent or resolve this error when executing nodes in parallel, relevant state keys can be defined with a Reducer function using typing.Annotated (such as Annotated[list, operator.add]), which specifies the logic for combining multiple values.

    Sources: INVALID_CONCURRENT_GRAPH_UPDATE – Docs by LangChain, Fix to graph-api docs Send API example

    Default Overwrite Channels vs. Reducer Channels

    This distinction highlights the core operational difference between default overwrite channels and reducer-enabled channels. By default, fields defined without an annotation in a TypedDict, dataclass, or Pydantic model operate as single-value channels backed internally by LastValue. When such a channel is configured without a Reducer function, receiving multiple update values in a single step causes LangGraph to raise an InvalidUpdateError:

    langgraph.errors.InvalidUpdateError: At key '<key>': Can receive only one value per step. Use an Annotated key to handle multiple values.
    

    To handle multiple values, fields can be configured with Reducer functions using typing.Annotated (such as Annotated[int, operator.add]).

    The presence or absence of a Reducer function also affects how bugs surface during execution. In one reported open issue (#9005), a developer observed a framework bug where overriding an inherited field in a dataclass or Pydantic subclass caused Command(update=...) to apply the update twice in a single step. When the overridden field (count) was configured without a Reducer function, this duplicate application triggered:

    langgraph.errors.InvalidUpdateError: At key 'count': Can receive only one value per step. Use an Annotated key to handle multiple values.
    

    However, when the field configured a Reducer function such as Annotated[int, operator.add], no error was raised, and the framework bug caused the reducer to apply the update twice (yielding a count of 5 instead of 3 from an initial value of 1 and an update of 2). Here, the reducer is not the source of the issue, but its normal aggregation behavior masks the framework’s double-invocation bug.

    Sources: `Command(update=…)` applies an overridden inherited state field twice, Receiving multiple inputs on a single node not working in a vanilla state

    Configuring Annotated State Keys with operator.add and Custom Reducers

    Building on this reducer mechanism, state schemas in LangGraph can use typing.Annotated within a TypedDict to specify a standard Reducer function such as operator.add:

    from typing import Annotated, Sequence
    import operator
    from typing_extensions import TypedDict
    
    class AgentState(TypedDict):
        messages: Annotated[Sequence[dict], operator.add]
    
    class State(TypedDict):
        my_key: Annotated[str, operator.add]
    

    When multiple parallel upstream nodes (such as up and side in a topology like graph.add_edge(["up", "side"], "down")) execute concurrently in the same super-step and both write updates to the same state key, a reducer is required on that key to prevent update conflicts across those parallel branches before control reaches the downstream down node.

    When list merging requires avoiding duplicate entries, custom reducer functions can be defined. For example, in a discussion around handling subgraph outputs, a community workaround demonstrated a custom reducer:

    def reduce_results(left: list[str], right: list[str]) -> list[str]:
        """This approach might not be the best, but it can solve repeat problems."""
        left_table = {result: i for i, result in enumerate(left)}
        merged = left.copy()
        for right_result in right:
            if (existing_idx := left_table.get(right_result)) is not None:
                merged[existing_idx] = right_result
            else:
                merged.append(right_result)
        return merged
    
    class ParentState(TypedDict):
        question: str
        results: Annotated[list[str], reduce_results]
    

    In that same discussion, a contributor suggested separating input and output schemas when handling subgraphs: using the parent graph’s state for the input allows full access to parent state values, while the output schema contains only the required fields, typed as lists with an Annotated Reducer function.

    Sources: Sink node issue, if multiple subgraphs are used in parallel, two node flow to one node

    Edge Cases: Parallel Subgraphs, Conditional Self-Loops, and Shared State Keys

    Beyond standard fan-out configurations, several distinct edge cases and open bug reports illustrate scenarios where InvalidUpdateError surfaces unexpectedly. These scenarios stem from different factors and should not be conflated:

    In an open bug report (issue #6446), executing a compiled subgraph in parallel with another node in the parent graph resulted in an unexpected InvalidUpdateError. In the reporter’s minimal reproducer, a parent graph branched from an initial node to both a standard node (nodeb) and a compiled subgraph:

    def create_graph():
        builder = StateGraph(State)
        builder.add_node("nodea", nodea)
        builder.add_node("subgraph", subgraph())
        builder.add_node("nodeb", nodeb)
    
        builder.add_edge(START, "nodea")
        builder.add_edge("nodea", "nodeb")
        builder.add_edge("nodea", "subgraph")
        builder.add_edge("nodeb", END)
        builder.add_edge("subgraph", END)
        return builder.compile()
    

    When nodeb and subgraph executed concurrently, LangGraph raised:

    langgraph.errors.InvalidUpdateError: At key 'b': Can receive only one value per step. Use an Annotated key to handle multiple values.
    

    The reporter noted that nodeb only updated key b while the subgraph internal nodes only updated keys s1 and s2. However, the root cause has not been officially confirmed by maintainers, and the report remains an open bug rather than an established graph behavior.

    In another scenario (issue #2336), a user encountered an update collision when combining parallel branches with a conditional self-loop (not a RetryPolicy). An initial node branched into parallel nodes b and c, where node c evaluated a conditional edge that routed back to itself on a retry condition before proceeding downstream. Executing this flow produced InvalidUpdateError targeting key count_b. Because the issue was closed without an official explanation or confirmed fix, it is only presumed that a self-loop iteration coincided with another branch in the same super-step to cause multiple writes to count_b.

    Sources: GitHub Issue Title: InvalidUpdateError when using parallel subgraphs with shared state keys in LangGraph, langgraph.errors.InvalidUpdateError: Can receive only one value per step. Use an Annotated key to handle multiple values. error when running retry in graph parallel processing

    Closing thoughts

    In standard graph workflows, InvalidUpdateError serves as an essential safeguard within LangGraph’s Pregel model, preventing non-deterministic data overwrites when multiple concurrent nodes write to the same unannotated channel. When parallel writes to a shared key are intentional, configuring the field with an Annotated reducer provides a deterministic aggregation rule. For unintentional collisions, architectural adjustments such as dedicated state keys or downstream fan-in nodes cleanly separate updates across steps.

    However, reducers should not be treated as a blanket remedy. In specific bug paths such as subclass field inheritance with Command(update=...) (#9005), adding a reducer can mask duplicate updates that would otherwise trigger a visible error. Furthermore, edge cases like parallel subgraphs (#6446) and conditional self-loops (#2336) represent distinct issues with separate, unconfirmed causes rather than straightforward topology mistakes. Distinguishing between intended concurrent updates, graph architectural patterns, and unresolved framework bugs is crucial when troubleshooting update conflicts in LangGraph.

    Frequently Asked Questions

    Why does LangGraph raise an InvalidUpdateError?

    LangGraph raises this error when multiple parallel nodes attempt to update the exact same state key within the same super-step without an aggregation rule. It halts execution to prevent non-deterministic overwrites and silent data loss.

    How can you resolve InvalidUpdateError when multiple branches intentionally update the same key?

    You can declare the target state key using typing.Annotated along with a Reducer function, such as operator.add or a custom reducer. This tells LangGraph how to combine the conflicting concurrent values instead of attempting an overwrite.

    What should you do if parallel nodes are causing unintentional key collisions?

    You can alter the graph structure to give each branch its own dedicated state key, such as branch_a_output and branch_b_output. Alternatively, you can route the parallel nodes to a downstream fan-in node that aggregates the values in a subsequent step.


    Keep reading: LLM Agents & Tooling

    All guides in this series: LLM Agent Guides: LangChain, LangGraph & AI Tooling

  • Multi-Head Latent Attention: Scaling LLM Serving Throughput via Low-Rank KV Compression

    Multi-Head Latent Attention: Scaling LLM Serving Throughput via Low-Rank KV Compression

    TL;DR

    • Multi-Head Latent Attention (MLA) overcomes serving memory bottlenecks by compressing Key-Value states into compact latent vectors via low-rank projections rather than relying on coarse head-sharing.

    • During inference, MLA absorbs key and value up-projection matrices into query and output projections; it pairs this with Decoupled RoPE so that position embeddings do not interfere with matrix absorption.

    • In DeepSeek-V2, MLA enables a 93.3% reduction in KV cache footprint compared to DeepSeek 67B. Together with sparse MoE computation (activating 21B out of 236B parameters), this contributes to a 5.76-fold boost in maximum generation throughput, while separate architectural ablations show MLA outperforms standard Multi-Head Attention.

    The Memory Wall: Why the KV Cache Constrains LLM Serving

    During Autoregressive Generation in Large Language Models (LLMs), Inference Throughput is fundamentally bottlenecked by the Key-Value (KV) Cache. In standard Multi-Head Attention (MHA), the model must retain the Key and Value tensors of all previously generated tokens across every layer. These cached states reside in High-Bandwidth Memory (HBM) and must be repeatedly transferred into on-chip memory at every decoding step to compute attention for each new token. This persistent, high-volume memory traffic creates severe HBM bandwidth contention, capping decoding throughput and strictly limiting both the serving batch size and the practical context window length.

    Prior attempts to alleviate this memory wall rely primarily on Multi-Query Attention (MQA) and Grouped-Query Attention (GQA). Both techniques reduce memory requirements by forcing multiple query heads to share a reduced number of KV heads. While this head-sharing structure lowers the absolute volume of data stored in HBM and transferred to on-chip memory, it introduces an architectural trade-off: sharing KV projections across disparate query heads compromises per-head representational diversity and impairs retrieval expressiveness.

    Consequently, LLM serving faces a structural tension between memory bandwidth efficiency and model capacity. Standard MHA preserves distinct per-head projections at the cost of high HBM bandwidth consumption, whereas MQA and GQA reduce cache overhead at the expense of representational richness. Overcoming this bottleneck requires moving beyond coarse head-sharing, addressing the memory wall via Low-Rank Joint Compression of the stored representations into a Compressed KV Latent Vector rather than sacrificing individual per-head projection capacity.

    Sources: [2405.04434] DeepSeek-V2: A Strong, Economical, and Efficient Mixture-of-Experts Language Model, arxiv.org/pdf/2405.04434, vertexaisearch.cloud.google.com/grounding-api-redirect/AUZIYQF73W_INb…, Not Acceptable!, Paper page – TransMLA: Multi-head Latent Attention Is All You Need

    Empirical Gains: KV Footprint Reduction and Serving Speedups in Practice

    The practical efficacy of this low-rank compression strategy is clearly demonstrated in modern architectures. Compared to the dense DeepSeek 67B baseline, DeepSeek-V2 reduces the Key-Value (KV) Cache footprint by 93.3% and boosts maximum generation throughput up to 5.76 times. This throughput gain is a system-wide result: the KV cache reduction stems directly from MLA’s low-rank compression, while overall serving efficiency is further multiplied by the DeepSeekMoE architecture, which activates only 21B parameters out of 236B total parameters per token.

    Standard Multi-Head Attention (MHA) caches all uncompressed keys and values across every attention head, requiring 2 * n_h * d_h * l elements per token, where n_h represents the head count, d_h is the per-head dimension, and l denotes the layer count. Alternative mechanisms like Grouped-Query Attention (GQA) and Multi-Query Attention (MQA) scale memory down to 2 * n_g * d_h * l elements (for n_g groups) and 2 * d_h * l elements, respectively, but sacrifice modeling capability.

    In contrast, MLA projects keys and values into a single low-rank latent vector c_t^KV of dimension d_c. However, standard Rotary Position Embedding (RoPE) is position-sensitive and couples directly with keys and queries. If RoPE were applied directly to the content keys, the key up-projection matrix W^UK could not be absorbed into the query projection during inference because a token-dependent rotation matrix would sit between them, destroying associativity and forcing the system to recompute prefix keys. MLA resolves this by introducing Decoupled RoPE: the content keys k_t^C remain unrotated (enabling matrix absorption), while a separate, low-dimensional shared key k_t^R of dimension d_h^R carries the positional embeddings.

    During inference, MLA caches only the compressed latent vector c_t^KV alongside the decoupled key k_t^R, requiring (d_c + d_h^R) * l elements per token. In the DeepSeek-V2 configuration (n_h = 128, d_h = 128, d_c = 512 = 4 * d_h, and d_h^R = 64 = d_h / 2), the cache requirement is (d_c + d_h^R) * l = 4.5 * d_h * l elements. In terms of per-token cache storage footprint, this is equivalent to GQA configured with only 2.25 groups. In architectural evaluations, MLA nevertheless achieves stronger performance than full MHA.

    Furthermore, during inference, the key up-projection matrix W^UK is absorbed directly into the query projection W^Q, and the value up-projection matrix W^UV is absorbed into the output projection W^O. As a result, the full per-head keys and values never need to be materialized in memory for attention computation, greatly reducing HBM bandwidth traffic.

    Sources: DeepSeek-V2: A Strong, Economical, and Efficient Mixture-of-Experts Language Model

    Closing thoughts

    These architectural efficiencies highlight a practical approach to addressing memory bottlenecks in LLM serving. Rather than relying entirely on coarse head-sharing mechanisms like GQA or MQA that compromise representational diversity, Multi-Head Latent Attention demonstrates that memory bandwidth contention can be significantly mitigated through low-rank joint compression.

    A key design element is decoupling positional embeddings from content projections. Because standard RoPE operations are position-dependent and prevent key up-projection matrices from being absorbed into queries, Decoupled RoPE isolates the positional stream. This allows the content stream to remain purely linear, enabling inference engines to absorb W^UK into W^Q and W^UV into W^O without materializing uncompressed per-head Key-Value states in memory.

    MLA does not eliminate all architectural trade-offs: practitioners must still select appropriate compression dimensions d_c, allocate cache for decoupled positional keys, and navigate specialized CUDA kernel implementations. Nevertheless, its empirical impact in DeepSeek-V2—where MLA’s 93.3% KV cache reduction relative to DeepSeek 67B combines with sparse MoE execution to deliver up to a 5.76-fold throughput improvement, alongside ablation results outperforming standard MHA—makes latent compression a compelling pattern for high-throughput serving systems.

    Frequently Asked Questions

    Why does the standard Key-Value (KV) cache create a bottleneck in LLM serving?

    In standard Multi-Head Attention, retaining uncompressed Key and Value tensors across all heads and layers requires repeatedly transferring massive volumes of data from High-Bandwidth Memory to on-chip memory at each decoding step. This creates severe memory bandwidth contention that restricts decoding throughput, serving batch sizes, and context window lengths.

    How does Multi-Head Latent Attention (MLA) differ from MQA and GQA?

    MQA and GQA reduce memory by forcing multiple query heads to share a reduced count of KV heads, which compromises representational diversity and retrieval expressiveness. In contrast, MLA compresses stored representations into a compact latent vector via low-rank joint compression without relying on coarse head-sharing.

    What does MLA store in the KV cache per token?

    MLA caches only the Compressed KV Latent Vector alongside a decoupled key carrying Decoupled Rotary Position Embedding (Decoupled RoPE). This requires (d_c + d_h^R) * l elements per token rather than materializing full uncompressed keys and values across every head.

    How does MLA optimize computation during inference?

    During inference, the key up-projection matrix is absorbed directly into the query projection, and the value up-projection matrix is absorbed into the output projection. Because Decoupled RoPE keeps the content stream position-free, this linear absorption avoids having to compute or materialize full per-head Key and Value tensors in memory during attention.

    What empirical throughput and memory gains were achieved by DeepSeek-V2 using MLA?

    Compared to DeepSeek 67B, DeepSeek-V2 reduced the KV cache footprint by 93.3% and increased maximum generation throughput up to 5.76 times. The KV cache reduction is driven by MLA, while the throughput gains reflect both the compressed cache and the sparse DeepSeekMoE architecture activating 21B out of 236B parameters. In terms of cache memory footprint per token, MLA is equivalent to GQA with just 2.25 groups, while separate paper ablations show it delivers stronger modeling performance than full Multi-Head Attention.


    Keep reading: LLM Inference & Serving

    All guides in this series: LLM Inference & Serving Guides: vLLM, Ollama & Hugging Face

  • Troubleshooting ‘ValueError: Some modules are dispatched on the CPU or the disk’ in Transformers

    Troubleshooting ‘ValueError: Some modules are dispatched on the CPU or the disk’ in Transformers

    TL;DR

    • The dispatch error acts as a safety check when quantized models cannot fit entirely on GPUs because low-precision kernels cannot natively execute on the CPU or disk.
    • Past memory calculation bugs in Accelerate integrations—such as under-sized leaf module buffers and assuming uniform layer sizes in no-split modules—previously caused CPU offloading even on systems with ample GPU VRAM.
    • These issues (tracked in issue #46823) were resolved in Transformers through PR #47203 and PR #47211, superseding earlier proposals such as PR #47061.

    Symptom and Trigger: When the Quantization Dispatch Error Occurs

    In Hugging Face Transformers (working alongside Accelerate and bitsandbytes), the dispatch error occurs during model initialization via from_pretrained() when attempting to load a quantized model—such as with load_in_8bit or load_in_4bit—under automatic or custom device placement using device_map (such as device_map="auto").

    When this condition is met, Hugging Face Transformers raises the following exception:

    ValueError: Some modules are dispatched on the CPU or the disk. Make sure you have enough GPU RAM to fit the quantized model.
    

    This error serves as a safety check triggered by the following sequence of constraints and runtime checks:

    • Kernel Device Constraints: The underlying quantization engine (bitsandbytes) executes its low-precision matrix operations using specialized GPU kernels.
    • VRAM Exhaustion and Placement Calculation: When the dispatch planner calculates module placement across available hardware, it may determine that available GPU VRAM—after accounting for CUDA kernel context overhead—is insufficient to host every quantized layer.
    • Automatic Fallback: Upon exhausting GPU VRAM, the dispatch planner attempts CPU offloading ("cpu") or disk offloading ("disk") for the overflow layers.
    • Execution Safety Check: Because quantized modules cannot execute their low-precision kernels natively on CPU or disk without explicit offload configurations, Hugging Face Transformers halts execution with ValueError: Some modules are dispatched on the CPU or the disk. Make sure you have enough GPU RAM to fit the quantized model to prevent immediate failure during forward passes or inference.

    The error directly indicates that the planned quantization configuration cannot fit entirely within the targeted GPU VRAM under the current device_map strategy.

    Sources: huggingface error2 #error – Qiita, PR #31098 Enable BNB multi-backend support – SemanticDiff, Bitsandbytes · Hugging Face, Bitsandbytes · Hugging Face, Loading big models into memory · Hugging Face

    Accelerate Memory Calculation Bugs: Why Ample VRAM Models Still Spill to CPU

    While this dispatch error is designed to catch genuine out-of-memory conditions, models loaded with load_in_4bit and device_map="auto" historically dispatched modules to CPU despite having an explicit and ample max_memory configuration. Under these circumstances, ValueError: Some modules are dispatched on the CPU or the disk. Make sure you have enough GPU RAM to fit the quantized model was raised from quantizer_bnb_4bit.validate_environment (via _get_device_map in integrations/accelerate.py).

    This behavior, tracked in issue #46823, stemmed from how device memory caps and layer sizes were calculated in integrations/accelerate.py:

    • Leaf module buffer under-sizing: get_balanced_memory calculates device caps with a buffer that previously only measured _no_split_modules. However, childless leaf modules (such as embed_tokens and lm_head, which are not reduced by quantization) act as un-splittable atoms. When a leaf module was larger than the balanced cap, device placement skipped earlier GPUs and collapsed onto the remaining capacity, spilling excess modules to CPU offloading even when total GPU VRAM was six times the model size.
    • Variable layer sizes in no-split modules: The block size for _no_split_modules was historically computed by sampling only the first matching layer. This caused under-packing when layers of the same class varied significantly in size. For instance, loading MiniMaxAI/MiniMax-M3 (a 428B sparse MoE VL model) with load_in_4bit, device_map="auto", and max_memory={i: "165GiB" for i in range(8)} on an 8x B200 setup triggered the dispatch ValueError because auto-placement under-packed the variable layers.

    While an initial proposal (PR #47061) attempted to size buffers via get_max_layer_size, maintainers determined it was not the correct fix and closed it in favor of targeted solutions that have since been merged into transformers main:

    • PR #47203 (merged July 9, 2026) addressed the variable layer sizing bug in _no_split_modules.
    • PR #47211 (merged September 18, 2026) corrected the leaf-module buffer calculation by adopting an updated sizing formula: buffer = int(1.25 * max(buffer, mean_leaves, max(leave_modules_sizes.values(), default=0))).

    Sources: Fix device_map="auto" under-packing that spills quantized models to cpu (#46823), 4-bit load_in_4bit + device_map='auto' + explicit max_memory still dispatches modules to CPU on a model that fits -> ValueError

    Closing thoughts

    While Transformers frames this error as a straightforward physical memory shortage, the underlying cause in certain multi-GPU quantized workflows was rooted in placement calculations. The handling of variable-sized MoE layers and unquantized leaf modules previously caused device_map="auto" to bypass available GPUs and spill modules to CPU. These issues have since been officially resolved in Transformers through PR #47203 and PR #47211. Developers working on older versions who encounter this error on ample hardware should update their transformers installation or inspect per-module allocations and explicit device maps.

    Frequently Asked Questions

    What causes the ‘ValueError: Some modules are dispatched on the CPU or the disk’ error in Hugging Face Transformers?

    This error occurs during model initialization with quantization settings like load_in_8bit or load_in_4bit when available GPU VRAM is insufficient to hold all layers. Because quantized modules require specialized GPU kernels and cannot execute natively on CPU or disk, Transformers halts execution as a safety check when modules are offloaded.

    Why did this dispatch error occur on systems with ample GPU VRAM?

    Historically, memory calculation bugs in Accelerate integrations caused auto-placement to under-pack GPUs. If variable-sized layers or un-splittable leaf modules exceeded the calculated balanced memory buffer, earlier GPUs were skipped, causing remaining layers to collapse onto the last GPU or spill to CPU.

    Which types of modules commonly triggered unintended CPU offloading during quantization?

    Childless leaf modules not reduced by quantization (such as embed_tokens and lm_head) and variable-sized layers in no-split modules (such as those in sparse MoE architectures) commonly caused under-packing when buffer reservations were under-calculated.

    How were these quantization memory calculation issues fixed in Transformers?

    An early proposed PR (#47061) was superseded by two merged fixes: PR #47203 resolved the variable layer size estimation in no-split modules, and PR #47211 updated the buffer calculation in get_balanced_memory using leaf module sizes (buffer = int(1.25 * max(buffer, mean_leaves, max(leave_modules_sizes.values(), default=0)))).


    Keep reading: LLM Inference & Serving

    All guides in this series: LLM Inference & Serving Guides: vLLM, Ollama & Hugging Face

  • Troubleshooting LangChain OutputParserException: Both Final Answer and Parse-able Action Produced

    Troubleshooting LangChain OutputParserException: Both Final Answer and Parse-able Action Produced

    TL;DR

    • The OutputParserException fires when a ReAct-style agent’s output matches both the action pattern (Action:/Action Input:) and the final-answer prefix (Final Answer:) in the same turn, so ReActSingleInputOutputParser cannot tell whether to dispatch a tool call or end the run.
    • handle_parsing_errors=True catches the exception and, by default, feeds back a fixed placeholder message (“Invalid or incomplete response”) as the next observation rather than the actual error text — pass a custom string or callable instead of True to send back something more specific
    • The most reliable fix is architectural: move off initialize_agent‘s legacy text-parsing ReAct agent onto a native tool-calling agent, where the turn boundary is enforced by the provider’s API instead of a regex over free text.

    Error Symptom: OutputParserException in ReAct Agent Execution

    In a GitHub issue report, a zero-shot ReAct agent built with initialize_agent and AgentType.ZERO_SHOT_REACT_DESCRIPTION raised langchain_core.exceptions.OutputParserException: Parsing LLM output produced both a final answer and a parse-able action while running against a self-hosted Meta-Llama-3-8B-Instruct model through a Hugging Face pipeline, with a Wikipedia search tool and a DuckDuckGo search tool attached.

    The reporter’s code, quoted as posted in the issue:

    runAgent = initialize_agent(
        llm=hf,
        tools=tools,
        verbose=True,
        agent_type=AgentType.ZERO_SHOT_REACT_DESCRIPTION,
    )
    userInput = "Bitcoin"
    output = runAgent.run(f'Write an academic abstract about {userInput}')
    

    This is reproduced verbatim from the report — hf and tools are defined earlier in the reporter’s own script and not shown here. Note that initialize_agent‘s formal parameter for selecting an agent type is agent, not agent_type. However, when both agent and agent_path are None, initialize_agent defaults to AgentType.ZERO_SHOT_REACT_DESCRIPTION. Thus, passing agent_type is ignored as an extra keyword argument, but the resulting instance is still a zero-shot ReAct agent and reproduces the exact same error.

    When the model over-generates — for example continuing past a tool call to also emit Final Answer: in the same response, or fabricating its own Observation: lines and looping through several invented steps — ReActSingleInputOutputParser.parse() finds both an action match and the final-answer prefix in the same text and raises the exception instead of guessing which one the model meant.

    After first hitting this, the reporter tried passing handle_parsing_errors=True. Rather than resolving cleanly, the run continued generating further hallucinated Thought/Action/Action Input/Observation cycles on its own without reaching a stop state — handle_parsing_errors=True catches the exception and passes the error back into the scratchpad, but it does not prevent the model from continuing to over-generate. A later comment on the same issue suggested adding early_stopping_method="force":

    runAgent = initialize_agent(
        llm=hf,
        tools=tools,
        verbose=True,
        early_stopping_method="force",
        handle_parsing_errors=True,
        agent_type=AgentType.ZERO_SHOT_REACT_DESCRIPTION,
    )
    

    "force" is already AgentExecutor‘s default value for early_stopping_method. The early_stopping_method parameter is independent of handle_parsing_errors and controls how the agent terminates once max_iterations or max_execution_time is reached (e.g., when repeated parsing retries exhaust the iteration limit), not at the moment the parsing conflict happens.

    Sources: OutputParserException: Parsing LLM output produced both a final answer and a parse-able action

    Root Cause: Turn Ambiguity in ReActSingleInputOutputParser Protocols

    LangChain’s text-based ReAct agent protocol relies on a strict turn-by-turn structure in which tool execution and agent termination are meant to be mutually exclusive:

    • Action step: the model emits Thought:, Action: <tool_name>, and Action Input: <input>, and the runtime is meant to stop there, dispatch an AgentAction, run the tool, and inject the result as the next Observation:.
    • Termination step: the model emits Thought: and Final Answer: <response>, and the runtime returns an AgentFinish to end the loop.

    ReActSingleInputOutputParser (and the legacy MRKL parser) decide which of these happened by testing the model’s raw text for two separate patterns: an action match (Action: ... / Action Input: ...) and the final-answer prefix defined by the FINAL_ANSWER_ACTION constant ("Final Answer:"). The exception fires whenever both patterns match in the same output, which happens in at least two distinct ways:

    1. The model hallucinates the rest of the trajectory. After an Action/Action Input pair, the model keeps generating instead of stopping — inventing its own Observation: text for a tool it never actually called, then continuing through further Thought/Action cycles until it eventually appends a Final Answer: as well.
    2. The model appends a final answer directly, with no fabricated observation in between. The model emits Action:/Action Input: and then, in the same continuous response, immediately adds Thought: I now know the final answer and Final Answer: — without ever generating an Observation: line at all.

    The distinction matters for choosing a fix: anything that stops generation at the Observation: boundary only intercepts case 1, because case 2 never produces that string in the first place. In both cases, because the runtime cannot tell from the text alone whether to dispatch an AgentAction or return an AgentFinish, ReActSingleInputOutputParser aborts and raises langchain_core.exceptions.OutputParserException using the string constant FINAL_ANSWER_AND_PARSABLE_ACTION_ERROR_MESSAGE.

    Sources: langchain.schema.output_parser.OutputParserException · Issue #8226 · langchain-ai/langchain · GitHub, vertexaisearch.cloud.google.com/grounding-api-redirect/AUZIYQGQ6Yvdmo…, エラー Parsing LLM output produced both a final answer and a parse-able action #LangChain – Qiita, FINAL_ANSWER_AND_PARSABLE_ACTION_ERROR_MESSAGE, Observation: Invalid or incomplete response using HF TGI · Issue #9381 · langchain-ai/langchain · GitHub

    How to Fix It: From Quick Patch to Eliminating the Error Class

    There are three points at which you can intervene, from patching around the crash to removing the ambiguity altogether.

    1. Catch the exception with handle_parsing_errors. Passing handle_parsing_errors=True to initialize_agent/AgentExecutor stops OutputParserException from crashing the run by catching the exception and returning the error text (or a fallback like “Invalid or incomplete response”) back as an observation so the model can retry. Passing a custom string (e.g. handle_parsing_errors="<custom message>") or a callable lets you control the instructional prompt or dynamically sanitize the output. On its own this only manages the failure at runtime — it does not prevent the model from over-generating again on a later turn. If the model continually repeats parsing errors until hitting max_iterations or max_execution_time, early_stopping_method determines how the agent handles termination at that limit.

    2. Verify and configure stop sequences for the Observation: boundary. Zero-shot ReAct agents in LangChain generally pass stop sequences such as ["\nObservation:", "\n\tObservation:"] to LLM invocations to halt generation immediately after an action is emitted. However, local model wrappers (such as Hugging Face pipeline wrappers) or certain model setups may fail to apply or honor these stop sequences properly. Verifying that stop arguments are actually respected by your LLM wrapper prevents case 1 — the model hallucinating its own observations and looping through further steps. Note that stop sequences do not prevent case 2, where the model appends Final Answer: directly after Action Input: without ever generating an Observation: token.

    3. Move to a native tool-calling agent. ReActSingleInputOutputParser and other text-based parsers exist only because the ReAct protocol encodes actions and answers as plain text that has to be pattern-matched after the fact. Where the underlying model supports tool calling, building the agent with create_tool_calling_agent (or an equivalent structured-output agent) instead of initialize_agent‘s ZERO_SHOT_REACT_DESCRIPTION moves argument parsing and turn boundaries into the API itself, so there is no free-text Action:/Final Answer: pattern left to collide. This isn’t guaranteed for every model, though — a self-hosted model served through a Hugging Face pipeline, like the Meta-Llama-3-8B-Instruct example above, may not expose tool calling the way a hosted provider API does. It is also worth knowing that initialize_agent/AgentExecutor is LangChain’s older agent interface; current LangChain documentation points toward create_agent/LangGraph-based agents as the actively maintained path going forward.

    Sources: langchain.schema.output_parser.OutputParserException · Issue #8226 · langchain-ai/langchain · GitHub, FINAL_ANSWER_AND_PARSABLE_ACTION_ERROR_MESSAGE

    Closing thoughts

    This parsing error illustrates the limitations of relying on regex-based text parsing for agent control flow when underlying LLMs generate past expected turn boundaries. While parameters like handle_parsing_errors handle parser exceptions at runtime by passing feedback back to the scratchpad, and early_stopping_method dictates how the run concludes when iteration limits are reached, neither eliminates the root formatting conflicts on its own.

    For more robust agent pipelines, using native tool-calling agents where supported offers a cleaner architecture by moving tool dispatching from free-form prompt text to structured API interactions.

    Frequently Asked Questions

    Why does the OutputParserException regarding a final answer and parse-able action occur in LangChain?

    This exception occurs when an LLM produces both an action pattern (like Action: and Action Input:) and a final answer prefix (Final Answer:) in a single output turn. Because the ReAct parser checks for both conditions and finds both to be true, it cannot determine whether to invoke a tool via an AgentAction or end execution with an AgentFinish, causing it to abort and raise the error.

    What issue can arise when only handle_parsing_errors=True is passed to initialize_agent?

    Passing handle_parsing_errors=True catches the OutputParserException and returns the error message (or a fallback like “Invalid or incomplete response”) back into the scratchpad as an observation. However, it does not prevent an over-generating model from continuing to hallucinate Thought/Action/Action Input/Observation cycles on subsequent turns instead of cleanly resolving.

    What is the difference between handle_parsing_errors and early_stopping_method?

    handle_parsing_errors manages runtime parser failures when an OutputParserException is raised by feeding error feedback or a custom observation back to the model. early_stopping_method is an independent setting that controls how the execution terminates once max_iterations or max_execution_time has been reached.

    What is the underlying root cause of turn ambiguity in ReActSingleInputOutputParser?

    The root cause is the LLM over-generating text across turn boundaries rather than yielding control after emitting an action or a final answer. When the model outputs both action patterns and termination keywords in the same turn, the parser’s regex and string checks match both mutually exclusive states.


    Keep reading: LLM Agents & Tooling

    All guides in this series: LLM Agent Guides: LangChain, LangGraph & AI Tooling

  • Troubleshooting bitsandbytes: Resolving ‘RuntimeError: CUDA Setup failed despite GPU being available’

    Troubleshooting bitsandbytes: Resolving ‘RuntimeError: CUDA Setup failed despite GPU being available’

    TL;DR

    • The CUDA Setup failed error occurs when bitsandbytes cannot dynamically locate runtime libraries, encounters ABI mismatches, or lacks sufficient GPU compute capability, all of which can be inspected using python -m bitsandbytes.
    • Linux initialization failures caused by dynamic linking issues or missing libstdc++ symbols can be resolved by configuring dynamic library paths or compiling bitsandbytes from source against the local CUDA environment using CMake.
    • Native Windows environments frequently fail due to the library searching for Linux-specific paths and shared objects; running inside WSL2 or installing compatible Windows wheels provides a practical workaround.

    Understanding Why bitsandbytes Fails to Initialize CUDA

    The RuntimeError: CUDA Setup failed despite GPU being available error occurs when the Python environment successfully detects an NVIDIA GPU through PyTorch, but the underlying bitsandbytes C++/CUDA extension fails to load, locate, or execute its compiled GPU kernels. Because bitsandbytes operates as a Python wrapper over custom CUDA and C++ kernels designed for memory-efficient deep learning operations, initialization fails if the low-level execution environment does not satisfy its dynamic linking or hardware requirements.

    CUDA initialization failures are driven by three primary root causes:

    • Dynamic CUDA Library Discovery: At runtime, bitsandbytes searches system search paths for CUDA dynamic runtime shared libraries, such as libcudart.so on Linux or nvcuda.dll on Windows. If these libraries are absent from the linker search paths or are incompatible with the active PyTorch installation, the C++ extension cannot be loaded.
    • CUDA Version and Symbol Mismatches: When the CUDA version used to compile the installed PyTorch build does not match the system CUDA Toolkit or the pre-compiled binaries distributed within the bitsandbytes package, the runtime environment cannot properly bind the required symbols.
    • Compute Capability and Architecture Requirements: bitsandbytes requires specific minimum NVIDIA compute capability levels to execute its kernel backends. Attempting to initialize the library on an unsupported architecture or on a build missing compiled kernels for that specific architecture triggers a setup failure:
      • Compute capability 6.0+ (Pascal or newer): Required to run basic 8-bit optimizers and 4-bit/8-bit quantization routines.
      • Compute capability 7.5+ (Turing, Ampere, Ada Lovelace, Hopper, or newer): Required for accelerated LLM.int8() mixed-precision matrix multiplication.

    Sources: mistralai/Mixtral-8x7B-Instruct-v0.1 · [AUTOMATED] Model Memory Requirements, CUDA Setup failed despite GPU being available. Inspect the CUDA SETUP outputs above to fix your environment! I, bitsandbytes · PyPI, RuntimeError: CUDA Setup failed despite correct environment paths on Windows · Issue #976 · bitsandbytes-found, stackoverflow.com/questions/79913258/cuda-setup-error-missing-libnvji…

    Diagnosing CUDA and Runtime Mismatches Using 'python -m bitsandbytes'

    To pinpoint which of these underlying root causes is responsible for the error in a specific environment, running the diagnostic command provided in the error message outputs detailed information about the environment, detected NVIDIA GPU hardware, and library search stages:

    python -m bitsandbytes
    

    Executing this command triggers bitsandbytes’ internal CUDA setup routine to inspect system paths, compute capability levels, and dynamic library dependencies.

    The resulting diagnostic log reveals the exact sequence of checks bitsandbytes performs. In one developer’s environment report, the diagnostic output captured the following path inspections and library loading stages:

    CUDA_SETUP: WARNING! libcudart.so not found in any environmental path. Searching in backup paths...
    CUDA SETUP: CUDA runtime path found: /usr/local/cuda/lib64/libcudart.so
    CUDA SETUP: Highest compute capability among GPUs detected: 7.5
    CUDA SETUP: Detected CUDA version 121
    CUDA SETUP: Loading binary /home/yed_dev/.local/lib/python3.10/site-packages/bitsandbytes/libbitsandbytes_cuda121.so...
    /lib64/libstdc++.so.6: version `CXXABI_1.3.9' not found (required by /home/yed_dev/.local/lib/python3.10/site-packages/bitsandbytes/libbitsandbytes_cuda121.so)
    CUDA SETUP: Something unexpected happened. Please compile from source:
    git clone [email protected]:TimDettmers/bitsandbytes.git
    cd bitsandbytes
    CUDA_VERSION=121
    python setup.py install
    

    As demonstrated in this log, running python -m bitsandbytes allows you to inspect several diagnostic points:

    • Directory and runtime discovery: It identifies missing or non-existent directories listed in environment paths (such as /usr/local/cuda/lib missing expected shared libraries like libcudart.so, libcudart.so.11.0, or libcudart.so.12.0) and notes when fallback searches find candidates like /usr/local/cuda/lib64/libcudart.so.
    • Hardware and version detection: It prints the detected CUDA version (e.g., CUDA 121) and the highest detected NVIDIA GPU compute capability (e.g., 7.5).
    • Binary loading and ABI mismatches: It shows which specific pre-compiled binary is being loaded (such as libbitsandbytes_cuda121.so) and captures underlying system loader failures, such as a missing C++ ABI symbol in the host’s libstdc++.so (e.g., version 'CXXABI_1.3.9' not found).

    If the setup encounters an unrecoverable failure during binary loading, diagnostic tools often suggest compiling bitsandbytes directly from source for the detected CUDA version.

    Sources: help!!!RuntimeError: CUDA Setup failed despite GPU being available. Please run the following command to get more information:

    Fixing Linux Setup Errors: Configuring CUDA Paths and Missing libstdc++ Symbols

    Once the diagnostic output reveals the exact nature of the failure, addressing it requires targeting the specific platform constraints. In Linux environments, bitsandbytes can detect the local CUDA runtime and hardware specifications successfully but still fail to initialize due to missing system library symbols. In one reported setup log, the initialization routine correctly located the CUDA runtime path at /usr/local/cuda/lib64/libcudart.so, detected CUDA version 117, and identified an NVIDIA GPU compute capability of 7.5, yet failed when attempting to load the pre-compiled binary:

    CUDA SETUP: CUDA runtime path found: /usr/local/cuda/lib64/libcudart.so
    CUDA SETUP: Highest compute capability among GPUs detected: 7.5
    CUDA SETUP: Detected CUDA version 117
    CUDA SETUP: Loading binary /usr/local/lib/python3.9/site-packages/bitsandbytes/libbitsandbytes_cuda117.so...
    /lib64/libstdc++.so.6: version `CXXABI_1.3.9' not found (required by /usr/local/lib/python3.9/site-packages/bitsandbytes/libbitsandbytes_cuda117.so)
    

    This log demonstrates an incompatibility where the system’s libstdc++.so lacks the required CXXABI_1.3.9 symbol needed by libbitsandbytes_cuda117.so. When this dynamic linking error occurs during execution—such as importing dependent libraries like peft that call import bitsandbytes as bnb—compiling the package directly from source against the local environment resolves the ABI mismatch.

    While legacy runtime diagnostic outputs in older package versions recommended running make and python setup.py install from the original repository, current official bitsandbytes documentation maintains source builds through bitsandbytes-foundation/bitsandbytes using CMake:

    git clone https://github.com/bitsandbytes-foundation/bitsandbytes.git
    cd bitsandbytes
    cmake -DCOMPUTE_BACKEND=cuda -S .
    make
    pip install -e .
    

    This compilation workflow builds the CUDA backend kernels directly with your host compiler and active CUDA SDK, ensuring complete symbol compatibility with your system’s libstdc++ runtime.

    Sources: CUDA Setup failed despite GPU being available. Inspect the CUDA SETUP outputs above to fix your environment!

    Resolving Initialization Failures on Windows via Pre-compiled Wheels

    While Linux environments primarily encounter ABI and dynamic path issues, running bitsandbytes in native Windows environments presents a different set of challenges because the initialization routines often look for Linux-specific shared libraries and paths. In user reports running setups such as CUDA 11.8 with PyTorch 2.0.1 or CUDA 12.2.2, the initialization routine scans for .so binaries rather than Windows-compatible dynamic libraries, producing path warnings and failing to register the NVIDIA GPU:

    bin C:\...\bitsandbytes\libbitsandbytes_cpu.so
    UserWarning: C:\... did not contain ['libcudart.so', 'libcudart.so.11.0', 'libcudart.so.12.0'] as expected! Searching further paths...
    CUDA_SETUP: WARNING! libcudart.so not found in any environmental path. Searching in backup paths...
    UserWarning: WARNING: The following directories listed in your path were found to be non-existent: {WindowsPath('/usr/local/cuda/lib64')}
    CUDA SETUP: WARNING! libcuda.so not found! Do you have a CUDA driver installed?
    UserWarning: WARNING: No GPU detected! Check your CUDA paths. Proceeding to load CPU-only library...
    CUDA SETUP: Loading binary ...\libbitsandbytes_cpu.so...
    argument of type 'WindowsPath' is not iterable
    CUDA SETUP: Problem: The main issue seems to be that the main CUDA library was not detected.
    CUDA SETUP: Solution 1): Your paths are probably not up-to-date. You can update them via: sudo ldconfig.
    

    This log excerpt illustrates bitsandbytes attempting to search Linux directories like /usr/local/cuda/lib64 and falling back to a CPU-only .so binary on Windows, ultimately raising a TypeError (argument of type 'WindowsPath' is not iterable) and presenting Linux-specific solutions like sudo ldconfig.

    In cases reported across Windows installations using tools like threestudio or stable-diffusion-webui (with dependencies like xformers 0.0.20), the setup routine fails when it cannot resolve Windows-native runtime bindings. For threestudio, project collaborators recommended running the workflow inside WSL2 to bypass native Windows library resolution failures. In native Windows environments, users typically require dedicated Windows-compatible wheel builds to properly load the CUDA dynamic libraries.

    Sources: CUDA Setup failed despite GPU being available, CUDA Setup failed despite GPU being available. Please run the following command to get more information

    Closing thoughts

    Ultimately, these platform-specific failures illustrate that PyTorch detecting a GPU is only half the battle; bitsandbytes relies on strict low-level dynamic linking that fails whenever host runtime libraries, ABI symbols, or operating system paths diverge from its pre-built binaries.

    Running the python -m bitsandbytes diagnostic tool is essential because it immediately clarifies whether the issue is an unlocated libcudart.so, an incompatible host libstdc++ version, or a Windows environment trying to load Linux-specific paths. When these mismatches occur, targeted source compilation via CMake on Linux or operating within WSL2 / utilizing Windows-compatible builds provides the most reliable way to align the library’s custom kernels with your active CUDA environment.

    Frequently Asked Questions

    Why does bitsandbytes throw a CUDA Setup failed error even when PyTorch detects a GPU?

    This error occurs because the underlying C++/CUDA extension fails to load, locate, or execute its GPU kernels. Common root causes include dynamic CUDA library discovery issues, CUDA version and C++ ABI symbol mismatches, or an unsupported GPU compute capability.

    How can I diagnose CUDA and runtime issues with bitsandbytes?

    You can run the command ‘python -m bitsandbytes’ in your terminal. This diagnostic tool inspects environment paths, checks for required shared libraries like libcudart.so, reports detected CUDA and compute capability versions, and identifies binary loading failures.

    What compute capability is required to run bitsandbytes?

    Bitsandbytes requires a minimum compute capability of 6.0+ (Pascal or newer) for basic 8-bit optimizers and 4-bit/8-bit quantization routines. For accelerated LLM.int8() mixed-precision matrix multiplication, a compute capability of 7.5+ (Turing or newer) is required.

    Why does bitsandbytes encounter initialization errors on Windows?

    On native Windows environments, bitsandbytes often defaults to searching for Linux-specific file paths and .so shared libraries rather than Windows-compatible dynamic libraries. Running inside WSL2 or installing compatible Windows wheels provides a practical workaround to avoid these path and dynamic linking issues.


    Keep reading: LLM Inference & Serving

    All guides in this series: LLM Inference & Serving Guides: vLLM, Ollama & Hugging Face

  • Differential Transformer: Canceling Context Noise with Differential Attention

    Differential Transformer: Canceling Context Noise with Differential Attention

    TL;DR

    • The Differential Transformer cancels attention noise and focuses attention by calculating scores as the difference between two separate softmax attention maps.
    • It achieves standard Transformer performance with approximately 35% fewer parameters or training tokens while reducing contextual hallucinations and enhancing long-context retrieval.
    • The DEX adaptation method enables existing pretrained language models to effectively incorporate key advantages of differential attention using minimal adaptation data (< 0.01%).

    Introduction to the Differential Transformer

    Developed by researchers from Microsoft Research and Tsinghua University—including Tianzhu Ye, Li Dong, Yuqing Xia, Yutao Sun, Yi Zhu, Gao Huang, and Furu Wei—the Differential Transformer (Diff Transformer) introduces a foundational architectural modification to standard Transformer models. Accepted as an Oral Presentation at ICLR 2025, the architecture addresses an inherent limitation in standard softmax attention: attention heads tend to overallocate probability weight to irrelevant context, which is often viewed as a consequence of softmax normalizing scores into strictly positive values summing to 1. In the authors’ motivation, this attention noise may relate to observed challenges such as contextual hallucinations, prompt-order sensitivity, and the “lost-in-the-middle” phenomenon.

    Drawing inspiration from noise-canceling headphones and differential amplifiers in electrical engineering, the Differential Transformer incorporates a Differential Attention Mechanism designed to cancel common-mode background noise and extraneous context. The architecture demonstrates several key advantages across language modeling tasks:

    • Improved Scaling Efficiency: The Diff Transformer matches the performance of standard Transformers while requiring approximately 35% fewer parameters or training tokens.
    • Long-Context Robustness: The model demonstrates stronger retrieval performance on needle-in-a-haystack tasks and long-context evaluations up to 64k tokens, showing less degradation across needle depths and context lengths.
    • Reduced Contextual Hallucinations: By being less distracted by irrelevant context, it decreases hallucination rates on text summarization and question-answering tasks.
    • In-Context Learning Stability: The architecture mitigates sensitivity to the permutation order of few-shot examples, offering higher stability during prompt reordering.
    • Quantization Readiness: Alongside noise cancellation, the architecture suppresses extreme activation outliers, facilitating cleaner post-training low-bit quantization as a distinct representational benefit.

    Sources: [2410.05258] Differential Transformer, Differential Transformer, microsoft.com/en-us/research/publication/differential-transformer, Microsoft’s Differential Transformer cancels attention noise in LLMs, OpenReview (paper discussion page)

    Cancelling Context Noise Through Attention Map Subtraction

    At the heart of these performance gains is the specific way Differential Attention operates. The Differential Attention Mechanism cancels attention noise by calculating attention scores as the difference between two separate softmax attention maps:

    DiffAttn(X) = (softmax(Q1 * K1^T / sqrt(d)) - lambda * softmax(Q2 * K2^T / sqrt(d))) * V
    

    where query and key projections are split into two distinct paths (Q1, K1 and Q2, K2) and λ is a learnable scalar parameter. In practice, λ is reparameterized via learnable vectors λ_q1, λ_k1, λ_q2, and λ_k2 (specifically computed as λ = exp(λ_q1 · λ_k1) – exp(λ_q2 · λ_k2) + λ_init, where λ_init is set according to the layer index). This subtraction directly cancels common-mode noise and counteracts the tendency of conventional architectures to overallocate attention to irrelevant context, amplifying focus on relevant tokens and promoting the emergence of sparse attention patterns.

    By canceling attention noise through this dual-map subtraction, the Diff Transformer achieves consistent empirical advantages across both scaling and downstream evaluations, outperforming standard Transformer baselines across various model sizes and training token volumes.

    Sources: Differential Transformer

    Follow-Up Analysis and Adapting Pretrained Models

    While the original Differential Transformer paper framed its mechanism primarily around noise cancellation, an independent follow-up study titled “Understanding Differential Transformer Unchains Pretrained Self-Attentions” (arXiv:2505.16333) by Chaerin Kong, Jiho Jang, and Nojun Kwak investigated the underlying factors behind its empirical success. The authors uncovered three key factors:

    • Enhanced expressivity via negative attention
    • Reduced redundancy among attention heads
    • Improved learning dynamics

    Because the standard Differential Transformer architecture requires training from scratch, which limits its direct use with existing pretrained models, the study proposed DEX, an efficient adaptation method designed to integrate the advantages of differential attention into pretrained models.

    Rather than computing two separate softmax maps, DEX reuses the original softmax attention scores and adds a lightweight differential operation on the output value matrix. This formulation allows pretrained language models to effectively incorporate key advantages of differential attention while remaining lightweight in training and inference, achieving significant performance gains across diverse benchmarks with minimal adaptation data (< 0.01%).

    Sources: Understanding Differential Transformer Unchains Pretrained Self-Attentions

    Closing thoughts

    In conclusion, by subtracting attention noise through two softmax maps, the Differential Transformer addresses a key limitation of standard softmax attention. Its empirical gains across scaling efficiency, long-context retrieval, and contextual hallucination reduction, alongside activation outlier suppression, highlight the advantages of differential attention representations. Furthermore, independent analysis reveals that benefits such as negative attention expressivity, reduced head redundancy, and improved learning dynamics also underpin its performance, inspiring practical adaptation methods like DEX for pretrained models. Differential attention thus stands as a grounded architectural refinement that delivers tangible, parameter- and data-efficient performance gains.

    Frequently Asked Questions

    What is the primary problem the Differential Transformer solves?

    The Differential Transformer addresses attention noise in standard softmax attention, where attention heads tend to overallocate probability weight to irrelevant context, often seen as a consequence of softmax normalizing scores into strictly positive values summing to 1.

    How does the Differential Attention Mechanism cancel context noise?

    It computes query and key projections across two separate paths, takes the difference between two distinct softmax attention maps weighted by a learnable parameter λ, and subtracts common-mode background noise to focus on salient tokens.

    What performance advantages does the Differential Transformer provide?

    It matches standard Transformer performance using approximately 35% fewer parameters or training tokens, improves long-context retrieval across various depths and lengths up to 64k tokens, lowers contextual hallucination rates in QA and summarization, stabilizes in-context learning against prompt reordering, and suppresses activation outliers for cleaner low-bit quantization.

    What is the DEX method and why is it needed?

    Because the original Differential Transformer architecture requires training from scratch, the DEX method was proposed in an independent follow-up study (arXiv:2505.16333 by Chaerin Kong, Jiho Jang, and Nojun Kwak) to adapt pretrained language models. Instead of computing two softmax maps, DEX reuses existing softmax attention scores and applies a lightweight differential operation on the output value matrix using minimal adaptation data (< 0.01%).


    Keep reading: Training & Architectures

    All guides in this series: LLM Training & Architecture Guides: Fine-Tuning, RL & New Models