[Model] Add TP-aware MistralEncoder for FLUX.2-dev TP (#2465)

Signed-off-by: vraiti <vraiti@redhat.com>
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
vraitiandClaude Opus 4.6 authored and GitHub committed 2026-05-13 12:33:55 -07:00
1 parent efd955674b
commit 9de9d1f7b5
4 files changed
+1193 -54

No files matched your search

@@ -0,0 +1,493 @@
# SPDX-License-Identifier: Apache-2.0
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
from types import SimpleNamespace
import pytest
import torch
from vllm.config import DeviceConfig, VllmConfig, set_current_vllm_config
from vllm_omni.diffusion.models.mistral_encoder.mistral_encoder import (
MistralEncoderModel,
MistralEncoderOutput,
MistralRotaryEmbedding,
)
pytestmark = [pytest.mark.core_model, pytest.mark.cpu]
_MODULE = "vllm_omni.diffusion.models.mistral_encoder.mistral_encoder"
SMALL_MISTRAL_CONFIG = dict(
hidden_size=64,
num_attention_heads=8,
num_key_value_heads=4,
head_dim=8,
intermediate_size=128,
num_hidden_layers=2,
rms_norm_eps=1e-5,
max_position_embeddings=512,
rope_theta=1000000.0,
vocab_size=256,
)
def _make_config(**overrides):
return SimpleNamespace(**{**SMALL_MISTRAL_CONFIG, **overrides})
def _make_nested_config(**overrides):
"""Simulate Mistral3Config with a text_config attribute."""
text_config = _make_config(**overrides)
return SimpleNamespace(text_config=text_config)
@pytest.fixture(scope="function", autouse=True)
def setup_tp_group(monkeypatch, mocker):
"""Set up TP=2, rank=0, and VllmConfig for all tests."""
device_config = DeviceConfig(device="cpu")
monkeypatch.setattr(
"vllm.model_executor.layers.linear.get_tensor_model_parallel_world_size",
lambda: 2,
)
monkeypatch.setattr(
"vllm.model_executor.layers.linear.get_tensor_model_parallel_rank",
lambda: 0,
)
monkeypatch.setattr(f"{_MODULE}.get_tensor_model_parallel_world_size", lambda: 2)
monkeypatch.setattr(
"vllm.model_executor.layers.vocab_parallel_embedding.get_tensor_model_parallel_world_size",
lambda: 2,
)
monkeypatch.setattr(
"vllm.model_executor.layers.vocab_parallel_embedding.get_tensor_model_parallel_rank",
lambda: 0,
)
mock_tp_group = mocker.MagicMock()
mock_tp_group.world_size = 2
mocker.patch("vllm.distributed.parallel_state.get_tp_group", return_value=mock_tp_group)
# Mock TP communication ops used during forward passes. Each op is
# imported by reference into the modules that use it, so we must patch
# at every import site.
_identity = lambda x: x # noqa: E731
monkeypatch.setattr(
"vllm.model_executor.layers.vocab_parallel_embedding.tensor_model_parallel_all_reduce",
_identity,
)
monkeypatch.setattr(
"vllm.model_executor.layers.linear.tensor_model_parallel_all_reduce",
_identity,
)
monkeypatch.setattr(
"vllm.model_executor.layers.linear.tensor_model_parallel_all_gather",
_identity,
)
monkeypatch.setattr(
f"{_MODULE}.tensor_model_parallel_all_gather",
_identity,
)
mocker.patch("torch.distributed.broadcast")
from vllm.model_executor.layers.utils import default_unquantized_gemm
monkeypatch.setattr(
"vllm.model_executor.layers.linear.dispatch_unquantized_gemm",
lambda: default_unquantized_gemm,
)
with set_current_vllm_config(VllmConfig(device_config=device_config)):
yield
class TestConfigParsing:
"""Verify that MistralEncoderModel extracts config correctly."""
def test_plain_config(self):
config = _make_config()
model = MistralEncoderModel(config, prefix="text_encoder")
assert model.hidden_size == 64
assert model.num_heads == 8
assert model.num_kv_heads == 4
assert model.head_dim == 8
assert model.intermediate_size == 128
assert model.num_layers == 2
assert model.rms_norm_eps == 1e-5
assert model.rope_theta == 1000000.0
assert model.vocab_size == 256
def test_nested_text_config(self):
config = _make_nested_config()
model = MistralEncoderModel(config, prefix="text_encoder")
assert model.hidden_size == 64
assert model.num_heads == 8
assert model.num_kv_heads == 4
assert model.config is config.text_config
def test_defaults_when_fields_missing(self):
config = SimpleNamespace(
hidden_size=64,
num_attention_heads=8,
intermediate_size=128,
num_hidden_layers=1,
vocab_size=256,
)
model = MistralEncoderModel(config, prefix="text_encoder")
assert model.num_kv_heads == 8, "should fall back to num_attention_heads"
assert model.head_dim == 8, "should compute hidden_size // num_heads"
assert model.rms_norm_eps == 1e-5
assert model.max_position_embeddings == 131072
assert model.rope_theta == 1000000.0
class TestRoPEInitialization:
"""Verify that RoPE inv_freq is computed from config, not left uninitialized."""
def test_inv_freq_deterministic(self):
rope = MistralRotaryEmbedding(head_dim=8, max_position_embeddings=512, rope_theta=1000000.0)
expected = 1.0 / (1000000.0 ** (torch.arange(0, 8, 2, dtype=torch.float32) / 8))
assert torch.allclose(rope.inv_freq, expected)
def test_different_theta_produces_different_freqs(self):
rope_a = MistralRotaryEmbedding(head_dim=8, max_position_embeddings=512, rope_theta=10000.0)
rope_b = MistralRotaryEmbedding(head_dim=8, max_position_embeddings=512, rope_theta=1000000.0)
assert not torch.allclose(rope_a.inv_freq, rope_b.inv_freq)
def test_cos_sin_shape_and_identity(self):
rope = MistralRotaryEmbedding(head_dim=8, max_position_embeddings=512, rope_theta=1000000.0)
seq_len = 16
position_ids = torch.arange(seq_len).unsqueeze(0)
cos, sin = rope(position_ids, torch.float32)
assert cos.shape == (1, seq_len, 8)
assert sin.shape == (1, seq_len, 8)
assert torch.allclose(cos**2 + sin**2, torch.ones_like(cos), atol=1e-6)
def test_model_rope_uses_config_theta(self):
config = _make_config(rope_theta=10000.0)
model = MistralEncoderModel(config, prefix="text_encoder")
expected = 1.0 / (10000.0 ** (torch.arange(0, 8, 2, dtype=torch.float32) / 8))
actual = model.language_model.model.rotary_emb.inv_freq
assert torch.allclose(actual, expected)
class TestWeightLoading:
"""Test weight loading and stacked params mapping."""
def test_qkv_weights_loaded(self):
config = _make_config(num_hidden_layers=1)
model = MistralEncoderModel(config, prefix="text_encoder")
hidden_size = config.hidden_size
num_heads = config.num_attention_heads
num_kv_heads = config.num_key_value_heads
head_dim = config.head_dim
prefix = "language_model.model.layers.0.self_attn."
weights = [
(prefix + "q_proj.weight", torch.randn(num_heads * head_dim, hidden_size)),
(prefix + "k_proj.weight", torch.randn(num_kv_heads * head_dim, hidden_size)),
(prefix + "v_proj.weight", torch.randn(num_kv_heads * head_dim, hidden_size)),
]
loaded = model.load_weights(weights)
assert len(loaded) > 0
assert any("qkv_proj" in p for p in loaded)
attn = model.language_model.model.layers[0].self_attn
# TP=2: q sharded to num_heads/2, kv sharded to num_kv_heads/2
expected_dim = (num_heads // 2 + 2 * (num_kv_heads // 2)) * head_dim
assert attn.qkv_proj.weight.shape == (expected_dim, hidden_size)
def test_gate_up_weights_loaded(self):
config = _make_config(num_hidden_layers=1)
model = MistralEncoderModel(config, prefix="text_encoder")
hidden_size = config.hidden_size
intermediate_size = config.intermediate_size
prefix = "language_model.model.layers.0.mlp."
weights = [
(prefix + "gate_proj.weight", torch.randn(intermediate_size, hidden_size)),
(prefix + "up_proj.weight", torch.randn(intermediate_size, hidden_size)),
]
loaded = model.load_weights(weights)
assert len(loaded) > 0
assert any("gate_up_proj" in p for p in loaded)
mlp = model.language_model.model.layers[0].mlp
# TP=2: each shard is intermediate_size/2, two merged
expected_dim = 2 * (intermediate_size // 2)
assert mlp.gate_up_proj.weight.shape == (expected_dim, hidden_size)
def test_skips_vision_but_loads_lm_head(self):
config = _make_config(num_hidden_layers=1)
model = MistralEncoderModel(config, prefix="text_encoder")
weights = [
("language_model.lm_head.weight", torch.randn(256, 64)),
("vision_tower.encoder.weight", torch.randn(64, 64)),
("multi_modal_projector.linear.weight", torch.randn(64, 64)),
]
loaded = model.load_weights(weights)
assert any("lm_head" in p for p in loaded)
assert not any("vision_tower" in p for p in loaded)
assert not any("multi_modal_projector" in p for p in loaded)
def test_unknown_weights_ignored(self):
config = _make_config(num_hidden_layers=1)
model = MistralEncoderModel(config, prefix="text_encoder")
weights = [("totally.fake.weight", torch.randn(10, 10))]
loaded = model.load_weights(weights)
assert len(loaded) == 0
class TestModelStructure:
"""Verify module hierarchy matches HF checkpoint layout."""
def test_module_nesting(self):
config = _make_config(num_hidden_layers=2)
model = MistralEncoderModel(config, prefix="text_encoder")
assert hasattr(model, "language_model")
assert hasattr(model.language_model, "model")
m = model.language_model.model
assert hasattr(m, "embed_tokens")
assert hasattr(m, "layers")
assert hasattr(m, "norm")
assert hasattr(m, "rotary_emb")
assert len(m.layers) == 2
def test_param_names_match_checkpoint_prefix(self):
config = _make_config(num_hidden_layers=1)
model = MistralEncoderModel(config, prefix="text_encoder")
param_names = set(dict(model.named_parameters()).keys())
assert any(n.startswith("language_model.model.embed_tokens") for n in param_names)
assert any(n.startswith("language_model.model.layers.0.self_attn") for n in param_names)
assert any(n.startswith("language_model.model.layers.0.mlp") for n in param_names)
class TestKVCache:
"""Verify KV cache plumbing through attention, layer, and model."""
def test_attention_returns_none_kv_when_cache_off(self):
from vllm_omni.diffusion.models.mistral_encoder.mistral_encoder import (
MistralEncoderAttention,
)
attn = MistralEncoderAttention(
hidden_size=64,
num_heads=8,
num_kv_heads=4,
head_dim=8,
prefix="test",
)
hidden = torch.randn(1, 4, 64)
cos = torch.ones(1, 4, 8)
sin = torch.zeros(1, 4, 8)
out, kv = attn(hidden, cos, sin, use_cache=False)
assert kv is None
assert out.shape == (1, 4, 64)
def test_attention_returns_kv_when_cache_on(self):
from vllm_omni.diffusion.models.mistral_encoder.mistral_encoder import (
MistralEncoderAttention,
)
attn = MistralEncoderAttention(
hidden_size=64,
num_heads=8,
num_kv_heads=4,
head_dim=8,
prefix="test",
)
hidden = torch.randn(1, 4, 64)
cos = torch.ones(1, 4, 8)
sin = torch.zeros(1, 4, 8)
out, kv = attn(hidden, cos, sin, use_cache=True)
assert kv is not None
k, v = kv
# TP=2: num_kv_heads shard = 4//2 = 2
assert k.shape == (1, 2, 4, 8)
assert v.shape == (1, 2, 4, 8)
def test_attention_appends_past_kv(self):
from vllm_omni.diffusion.models.mistral_encoder.mistral_encoder import (
MistralEncoderAttention,
)
attn = MistralEncoderAttention(
hidden_size=64,
num_heads=8,
num_kv_heads=4,
head_dim=8,
prefix="test",
)
# Simulate a prefill with 4 tokens
hidden = torch.randn(1, 4, 64)
cos = torch.ones(1, 4, 8)
sin = torch.zeros(1, 4, 8)
_, kv = attn(hidden, cos, sin, use_cache=True)
# Simulate a decode step with 1 token
hidden_new = torch.randn(1, 1, 64)
cos_new = torch.ones(1, 1, 8)
sin_new = torch.zeros(1, 1, 8)
out, kv2 = attn(hidden_new, cos_new, sin_new, past_key_value=kv, use_cache=True)
k2, v2 = kv2
assert k2.shape == (1, 2, 5, 8), "should be past(4) + new(1)"
assert out.shape == (1, 1, 64)
def test_model_forward_use_cache(self):
config = _make_config(num_hidden_layers=2)
model = MistralEncoderModel(config, prefix="text_encoder")
input_ids = torch.randint(0, 128, (1, 8))
output = model(input_ids, use_cache=True)
assert isinstance(output, MistralEncoderOutput)
assert output.past_key_values is not None
assert len(output.past_key_values) == 2
# Each layer's cache: (k, v) with seq_len=8
k, v = output.past_key_values[0]
assert k.shape[2] == 8
assert v.shape[2] == 8
def test_model_forward_no_cache(self):
config = _make_config(num_hidden_layers=1)
model = MistralEncoderModel(config, prefix="text_encoder")
input_ids = torch.randint(0, 128, (1, 4))
output = model(input_ids, use_cache=False)
assert output.past_key_values is None
def test_model_decode_with_past(self):
config = _make_config(num_hidden_layers=1)
model = MistralEncoderModel(config, prefix="text_encoder")
# Prefill
input_ids = torch.randint(0, 128, (1, 4))
output = model(input_ids, use_cache=True)
past = output.past_key_values
# Decode one token
new_token = torch.randint(0, 128, (1, 1))
output2 = model(new_token, use_cache=True, past_key_values=past)
assert output2.last_hidden_state.shape == (1, 1, 64)
k2, v2 = output2.past_key_values[0]
assert k2.shape[2] == 5, "cache should grow from 4 to 5"
class TestRoPEOffset:
"""Verify RoPE offset produces correct positions for decode steps."""
def test_offset_zero_matches_original(self):
rope = MistralRotaryEmbedding(head_dim=8, max_position_embeddings=512, rope_theta=1000000.0)
position_ids = torch.arange(4).unsqueeze(0)
cos_a, sin_a = rope(position_ids, torch.float32)
cos_b, sin_b = rope(position_ids, torch.float32)
assert torch.allclose(cos_a, cos_b)
assert torch.allclose(sin_a, sin_b)
def test_offset_produces_shifted_positions(self):
rope = MistralRotaryEmbedding(head_dim=8, max_position_embeddings=512, rope_theta=1000000.0)
# Full sequence of 5 positions
full_ids = torch.arange(5).unsqueeze(0)
cos_full, sin_full = rope(full_ids, torch.float32)
# Position 4 only
offset_ids = torch.tensor([[4]])
cos_off, sin_off = rope(offset_ids, torch.float32)
assert torch.allclose(cos_full[:, 4:5], cos_off)
assert torch.allclose(sin_full[:, 4:5], sin_off)
class TestGenerate:
"""Verify autoregressive generate() method."""
def test_generate_produces_tokens(self):
config = _make_config(num_hidden_layers=1)
model = MistralEncoderModel(config, prefix="text_encoder")
input_ids = torch.randint(0, 128, (1, 4))
attention_mask = torch.ones(1, 4, dtype=torch.long)
output = model.generate(
input_ids=input_ids,
attention_mask=attention_mask,
max_new_tokens=3,
do_sample=False,
use_cache=True,
)
assert output.shape[0] == 1
# prompt(4) + generated(3) = 7, unless EOS hit early
assert output.shape[1] >= 5
assert output.shape[1] <= 7
# prompt tokens preserved
assert torch.equal(output[:, :4], input_ids)
def test_generate_stops_at_eos(self):
config = _make_config(num_hidden_layers=1, eos_token_id=0)
model = MistralEncoderModel(config, prefix="text_encoder")
# Manually set embed_tokens so that token 0 maps to a specific embedding
# that will produce logits strongly favouring token 0 again.
# This is a probabilistic test — we just verify it doesn't exceed max.
input_ids = torch.randint(1, 128, (1, 4))
output = model.generate(
input_ids=input_ids,
max_new_tokens=10,
do_sample=False,
eos_token_id=0,
)
# Should have at most prompt(4) + max_new(10) = 14 tokens
assert output.shape[1] <= 14
def test_generate_greedy_deterministic(self):
config = _make_config(num_hidden_layers=1)
model = MistralEncoderModel(config, prefix="text_encoder")
input_ids = torch.randint(0, 128, (1, 4))
out1 = model.generate(input_ids=input_ids, max_new_tokens=5, do_sample=False)
out2 = model.generate(input_ids=input_ids, max_new_tokens=5, do_sample=False)
assert torch.equal(out1, out2)
def test_generate_ignores_extra_kwargs(self):
"""generate() should accept and ignore pixel_values and other HF kwargs."""
config = _make_config(num_hidden_layers=1)
model = MistralEncoderModel(config, prefix="text_encoder")
input_ids = torch.randint(0, 128, (1, 4))
output = model.generate(
input_ids=input_ids,
max_new_tokens=2,
do_sample=False,
pixel_values=torch.randn(1, 3, 224, 224),
)
assert output.shape[1] >= 5
class TestComputeLogits:
"""Verify logits computation via lm_head weight."""
def test_logits_shape(self):
config = _make_config(num_hidden_layers=1, vocab_size=256)
model = MistralEncoderModel(config, prefix="text_encoder")
hidden = torch.randn(1, 4, 64)
logits = model._compute_logits(hidden)
# TP=2: VocabParallelEmbedding stores vocab_size/2 = 128 per shard
# With TP=2 but mocked (no actual all_gather), local logits only
# In real TP, all_gather would give (1, 4, 256)
# With mock, tp_size=2 triggers all_gather path but the mock may not
# actually gather. Just verify we get a tensor back.
assert logits.dim() == 3
assert logits.shape[0] == 1
assert logits.shape[1] == 4
@@ -21,7 +21,7 @@ from diffusers.pipelines.flux2.system_messages import (
)
from diffusers.utils.torch_utils import randn_tensor
from torch import nn
from transformers import AutoProcessor, Mistral3ForConditionalGeneration, PixtralProcessor
from transformers import AutoConfig, AutoProcessor, PixtralProcessor
from vllm.model_executor.models.utils import AutoWeightsLoader
from vllm_omni.diffusion.data import DiffusionOutput, OmniDiffusionConfig
@@ -31,6 +31,7 @@ from vllm_omni.diffusion.distributed.utils import get_local_device
from vllm_omni.diffusion.model_loader.diffusers_loader import DiffusersPipelineLoader
from vllm_omni.diffusion.models.flux2 import Flux2Transformer2DModel
from vllm_omni.diffusion.models.interface import SupportImageInput
from vllm_omni.diffusion.models.mistral_encoder import MistralEncoderModel
from vllm_omni.diffusion.models.progress_bar import ProgressBarMixin
from vllm_omni.diffusion.profiler.diffusion_pipeline_profiler import DiffusionPipelineProfilerMixin
from vllm_omni.diffusion.request import OmniDiffusionRequest
@@ -350,6 +351,7 @@ class Flux2Pipeline(nn.Module, CFGParallelMixin, SupportImageInput, ProgressBarM
):
super().__init__()
self.od_config = od_config
self.weights_sources = [
DiffusersPipelineLoader.ComponentSource(
model_or_path=od_config.model,
@@ -368,12 +370,30 @@ class Flux2Pipeline(nn.Module, CFGParallelMixin, SupportImageInput, ProgressBarM
self.scheduler = FlowMatchEulerDiscreteScheduler.from_pretrained(
model, subfolder="scheduler", local_files_only=local_files_only
)
self.text_encoder = Mistral3ForConditionalGeneration.from_pretrained(
self.weights_sources.append(
DiffusersPipelineLoader.ComponentSource(
model_or_path=od_config.model,
subfolder="text_encoder",
revision=None,
prefix="text_encoder.",
fall_back_to_pt=True,
),
)
text_encoder_config = AutoConfig.from_pretrained(
model, subfolder="text_encoder", local_files_only=local_files_only
)
self.text_encoder = MistralEncoderModel(
text_encoder_config,
prefix="text_encoder",
).to(self._execution_device)
self.tokenizer = PixtralProcessor.from_pretrained(
model, subfolder="tokenizer", local_files_only=local_files_only
)
self.text_encoder.set_processor(
self.tokenizer,
system_message_t2i=SYSTEM_MESSAGE_UPSAMPLING_T2I,
system_message_i2i=SYSTEM_MESSAGE_UPSAMPLING_I2I,
)
self.vae = AutoencoderKLFlux2.from_pretrained(model, subfolder="vae", local_files_only=local_files_only).to(
self._execution_device
)
@@ -402,7 +422,7 @@ class Flux2Pipeline(nn.Module, CFGParallelMixin, SupportImageInput, ProgressBarM
@staticmethod
def _get_mistral_3_small_prompt_embeds(
text_encoder: Mistral3ForConditionalGeneration,
text_encoder: MistralEncoderModel,
tokenizer: AutoProcessor,
prompt: str | list[str],
dtype: torch.dtype | None = None,
@@ -613,7 +633,6 @@ class Flux2Pipeline(nn.Module, CFGParallelMixin, SupportImageInput, ProgressBarM
return torch.stack(x_list, dim=0)
# Copied from diffusers.pipelines.flux2.pipeline_flux2.Flux2Pipeline.upsample_prompt
def upsample_prompt(
self,
prompt: str | list[str],
@@ -621,61 +640,15 @@ class Flux2Pipeline(nn.Module, CFGParallelMixin, SupportImageInput, ProgressBarM
temperature: float = 0.15,
device: torch.device = None,
) -> list[str]:
prompt = [prompt] if isinstance(prompt, str) else prompt
device = self.text_encoder.device if device is None else device
# Set system message based on whether images are provided
if images is None or len(images) == 0 or images[0] is None:
system_message = SYSTEM_MESSAGE_UPSAMPLING_T2I
else:
system_message = SYSTEM_MESSAGE_UPSAMPLING_I2I
# Validate and process the input images
if images:
images = _validate_and_process_images(images, self.image_processor, self.upsampling_max_image_size)
# Format input messages
messages_batch = format_input(prompts=prompt, system_message=system_message, images=images)
# Process all messages at once
# with image processing a too short max length can throw an error in here.
inputs = self.tokenizer.apply_chat_template(
messages_batch,
add_generation_prompt=True,
tokenize=True,
return_dict=True,
return_tensors="pt",
padding="max_length",
truncation=True,
max_length=2048,
)
# Move to device
inputs["input_ids"] = inputs["input_ids"].to(device)
inputs["attention_mask"] = inputs["attention_mask"].to(device)
if "pixel_values" in inputs:
inputs["pixel_values"] = inputs["pixel_values"].to(device, self.text_encoder.dtype)
# Generate text using the model's generate method
generated_ids = self.text_encoder.generate(
**inputs,
max_new_tokens=512,
do_sample=True,
return self.text_encoder.upsample_prompt(
prompt,
images=images,
temperature=temperature,
use_cache=True,
device=device,
)
# Decode only the newly generated tokens (skip input tokens)
# Extract only the generated portion
input_length = inputs["input_ids"].shape[1]
generated_tokens = generated_ids[:, input_length:]
upsampled_prompt = self.tokenizer.tokenizer.batch_decode(
generated_tokens, skip_special_tokens=True, clean_up_tokenization_spaces=True
)
return upsampled_prompt
def encode_prompt(
self,
prompt: str | list[str],
@@ -929,6 +902,9 @@ class Flux2Pipeline(nn.Module, CFGParallelMixin, SupportImageInput, ProgressBarM
)
max_sequence_length = req.sampling_params.max_sequence_length or max_sequence_length
text_encoder_out_layers = req.sampling_params.extra_args.get("text_encoder_out_layers", text_encoder_out_layers)
caption_upsample_temperature = req.sampling_params.extra_args.get(
"caption_upsample_temperature", caption_upsample_temperature
)
req_prompt_embeds = [p.get("prompt_embeds") if not isinstance(p, str) else None for p in req.prompts]
if any(p is not None for p in req_prompt_embeds):
@@ -0,0 +1,3 @@
from .mistral_encoder import MistralEncoderModel
__all__ = ["MistralEncoderModel"]
@@ -0,0 +1,667 @@
# SPDX-License-Identifier: Apache-2.0
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
"""
TP-aware Mistral model for use as a text encoder in diffusion pipelines.
Follows the same pattern as T5EncoderModel: uses vLLM's parallel linear layers
for tensor parallelism but simple scaled_dot_product_attention instead of
PagedAttention, so it can be used as a standalone encoder without VllmConfig.
The model supports autoregressive text generation via ``generate()``
using KV caching and the tied embedding weights as a language-model head.
This replaces the dependency on ``Mistral3ForConditionalGeneration`` for
caption upsampling.
"""
from __future__ import annotations
import logging
from collections.abc import Iterable
from typing import Any
import torch
import torch.nn as nn
import torch.nn.functional as F
from transformers import PretrainedConfig
from vllm.distributed import (
get_tensor_model_parallel_world_size,
tensor_model_parallel_all_gather,
)
from vllm.model_executor.layers.activation import SiluAndMul
from vllm.model_executor.layers.layernorm import RMSNorm
from vllm.model_executor.layers.linear import (
MergedColumnParallelLinear,
QKVParallelLinear,
RowParallelLinear,
)
from vllm.model_executor.layers.vocab_parallel_embedding import ParallelLMHead, VocabParallelEmbedding
from vllm.model_executor.model_loader.weight_utils import default_weight_loader
logger = logging.getLogger(__name__)
class MistralRotaryEmbedding(nn.Module):
"""RoPE implementation for the encoder. Precomputes cos/sin tables."""
def __init__(self, head_dim: int, max_position_embeddings: int, rope_theta: float = 1000000.0):
super().__init__()
inv_freq = 1.0 / (rope_theta ** (torch.arange(0, head_dim, 2, dtype=torch.float32) / head_dim))
self.register_buffer("inv_freq", inv_freq, persistent=False)
self.max_position_embeddings = max_position_embeddings
@torch.no_grad()
def forward(self, position_ids: torch.Tensor, dtype: torch.dtype):
# position_ids: (batch, seq_len)
inv_freq = self.inv_freq[None, :, None].float().to(position_ids.device)
inv_freq = inv_freq.expand(position_ids.shape[0], -1, 1)
pos = position_ids[:, None, :].float()
freqs = (inv_freq @ pos).transpose(1, 2) # (batch, seq_len, head_dim/2)
emb = torch.cat((freqs, freqs), dim=-1)
return emb.cos().to(dtype), emb.sin().to(dtype)
def rotate_half(x: torch.Tensor) -> torch.Tensor:
x1 = x[..., : x.shape[-1] // 2]
x2 = x[..., x.shape[-1] // 2 :]
return torch.cat((-x2, x1), dim=-1)
def apply_rotary_pos_emb(
q: torch.Tensor, k: torch.Tensor, cos: torch.Tensor, sin: torch.Tensor
) -> tuple[torch.Tensor, torch.Tensor]:
# cos/sin: (batch, seq_len, head_dim) -> (batch, 1, seq_len, head_dim)
cos = cos.unsqueeze(1)
sin = sin.unsqueeze(1)
q_embed = (q * cos) + (rotate_half(q) * sin)
k_embed = (k * cos) + (rotate_half(k) * sin)
return q_embed, k_embed
def repeat_kv(hidden_states: torch.Tensor, n_rep: int) -> torch.Tensor:
if n_rep == 1:
return hidden_states
batch, num_kv_heads, slen, head_dim = hidden_states.shape
hidden_states = hidden_states[:, :, None, :, :].expand(batch, num_kv_heads, n_rep, slen, head_dim)
return hidden_states.reshape(batch, num_kv_heads * n_rep, slen, head_dim)
def _format_upsample_input(
prompts: list[str],
system_message: str,
images: list | None = None,
) -> list[list[dict[str, Any]]]:
cleaned_txt = [p.replace("[IMG]", "") for p in prompts]
if images is None or len(images) == 0:
return [
[
{"role": "system", "content": [{"type": "text", "text": system_message}]},
{"role": "user", "content": [{"type": "text", "text": prompt}]},
]
for prompt in cleaned_txt
]
assert len(images) == len(prompts), "Number of images must match number of prompts"
messages = [[{"role": "system", "content": [{"type": "text", "text": system_message}]}] for _ in cleaned_txt]
for i, (el, batch_images) in enumerate(zip(messages, images)):
if batch_images is not None:
el.append({"role": "user", "content": [{"type": "image", "image": img} for img in batch_images]})
el.append({"role": "user", "content": [{"type": "text", "text": cleaned_txt[i]}]})
return messages
class MistralEncoderAttention(nn.Module):
def __init__(
self,
hidden_size: int,
num_heads: int,
num_kv_heads: int,
head_dim: int,
prefix: str = "",
):
super().__init__()
self.hidden_size = hidden_size
self.head_dim = head_dim
tp_size = get_tensor_model_parallel_world_size()
self.total_num_heads = num_heads
self.num_heads = num_heads // tp_size
self.total_num_kv_heads = num_kv_heads
self.num_kv_heads = max(1, num_kv_heads // tp_size)
self.num_kv_groups = self.num_heads // self.num_kv_heads
self.q_size = self.num_heads * self.head_dim
self.kv_size = self.num_kv_heads * self.head_dim
self.scaling = self.head_dim**-0.5
self.qkv_proj = QKVParallelLinear(
hidden_size=hidden_size,
head_size=head_dim,
total_num_heads=num_heads,
total_num_kv_heads=num_kv_heads,
bias=False,
prefix=f"{prefix}.qkv_proj",
)
self.o_proj = RowParallelLinear(
input_size=num_heads * head_dim,
output_size=hidden_size,
bias=False,
prefix=f"{prefix}.o_proj",
)
def forward(
self,
hidden_states: torch.Tensor,
cos: torch.Tensor,
sin: torch.Tensor,
attention_mask: torch.Tensor | None = None,
past_key_value: tuple[torch.Tensor, torch.Tensor] | None = None,
use_cache: bool = False,
) -> tuple[torch.Tensor, tuple[torch.Tensor, torch.Tensor] | None]:
batch_size, seq_len, _ = hidden_states.shape
qkv, _ = self.qkv_proj(hidden_states)
q, k, v = qkv.split([self.q_size, self.kv_size, self.kv_size], dim=-1)
q = q.view(batch_size, seq_len, self.num_heads, self.head_dim).transpose(1, 2)
k = k.view(batch_size, seq_len, self.num_kv_heads, self.head_dim).transpose(1, 2)
v = v.view(batch_size, seq_len, self.num_kv_heads, self.head_dim).transpose(1, 2)
q, k = apply_rotary_pos_emb(q, k, cos, sin)
if past_key_value is not None:
past_k, past_v = past_key_value
k = torch.cat([past_k, k], dim=2)
v = torch.cat([past_v, v], dim=2)
new_kv = (k, v) if use_cache else None
k = repeat_kv(k, self.num_kv_groups)
v = repeat_kv(v, self.num_kv_groups)
attn_output = F.scaled_dot_product_attention(q, k, v, attn_mask=attention_mask, scale=self.scaling)
attn_output = attn_output.transpose(1, 2).contiguous()
attn_output = attn_output.view(batch_size, seq_len, -1)
attn_output, _ = self.o_proj(attn_output)
return attn_output, new_kv
class MistralEncoderMLP(nn.Module):
def __init__(
self,
hidden_size: int,
intermediate_size: int,
prefix: str = "",
):
super().__init__()
self.gate_up_proj = MergedColumnParallelLinear(
input_size=hidden_size,
output_sizes=[intermediate_size, intermediate_size],
bias=False,
prefix=f"{prefix}.gate_up_proj",
)
self.down_proj = RowParallelLinear(
input_size=intermediate_size,
output_size=hidden_size,
bias=False,
prefix=f"{prefix}.down_proj",
)
self.act_fn = SiluAndMul()
def forward(self, x: torch.Tensor) -> torch.Tensor:
x, _ = self.gate_up_proj(x)
x = self.act_fn(x)
x, _ = self.down_proj(x)
return x
class MistralEncoderLayer(nn.Module):
def __init__(
self,
hidden_size: int,
num_heads: int,
num_kv_heads: int,
head_dim: int,
intermediate_size: int,
rms_norm_eps: float,
prefix: str = "",
):
super().__init__()
self.self_attn = MistralEncoderAttention(
hidden_size=hidden_size,
num_heads=num_heads,
num_kv_heads=num_kv_heads,
head_dim=head_dim,
prefix=f"{prefix}.self_attn",
)
self.mlp = MistralEncoderMLP(
hidden_size=hidden_size,
intermediate_size=intermediate_size,
prefix=f"{prefix}.mlp",
)
self.input_layernorm = RMSNorm(hidden_size, eps=rms_norm_eps)
self.post_attention_layernorm = RMSNorm(hidden_size, eps=rms_norm_eps)
def forward(
self,
hidden_states: torch.Tensor,
cos: torch.Tensor,
sin: torch.Tensor,
attention_mask: torch.Tensor | None = None,
past_key_value: tuple[torch.Tensor, torch.Tensor] | None = None,
use_cache: bool = False,
) -> tuple[torch.Tensor, tuple[torch.Tensor, torch.Tensor] | None]:
residual = hidden_states
hidden_states = self.input_layernorm(hidden_states)
hidden_states, new_kv = self.self_attn(
hidden_states,
cos,
sin,
attention_mask,
past_key_value,
use_cache,
)
hidden_states = residual + hidden_states
residual = hidden_states
hidden_states = self.post_attention_layernorm(hidden_states)
hidden_states = self.mlp(hidden_states)
hidden_states = residual + hidden_states
return hidden_states, new_kv
class MistralEncoderOutput:
"""Simple output container matching HuggingFace's interface."""
def __init__(
self,
last_hidden_state: torch.Tensor,
hidden_states: tuple[torch.Tensor, ...] | None = None,
past_key_values: list[tuple[torch.Tensor, torch.Tensor]] | None = None,
):
self.last_hidden_state = last_hidden_state
self.hidden_states = hidden_states
self.past_key_values = past_key_values
class MistralEncoderModel(nn.Module):
"""
TP-aware Mistral encoder for use as a text encoder in diffusion pipelines.
Accepts a HuggingFace Mistral3Config (or its text_config). Uses vLLM
parallel layers for TP but simple SDPA for attention (no PagedAttention).
"""
def __init__(self, config: PretrainedConfig, prefix: str = ""):
super().__init__()
self._processor = None
self._system_message_t2i: str | None = None
self._system_message_i2i: str | None = None
# Handle Mistral3Config (has text_config) or plain MistralConfig
if hasattr(config, "text_config"):
text_config = config.text_config
else:
text_config = config
self.config = text_config
self.hidden_size = text_config.hidden_size
self.num_heads = text_config.num_attention_heads
self.num_kv_heads = getattr(text_config, "num_key_value_heads", text_config.num_attention_heads)
self.head_dim = getattr(text_config, "head_dim", None) or (self.hidden_size // self.num_heads)
self.intermediate_size = text_config.intermediate_size
self.num_layers = text_config.num_hidden_layers
self.rms_norm_eps = getattr(text_config, "rms_norm_eps", 1e-5)
self.max_position_embeddings = getattr(text_config, "max_position_embeddings", 131072)
self.rope_theta = getattr(text_config, "rope_theta", 1000000.0)
self.vocab_size = text_config.vocab_size
tp_size = get_tensor_model_parallel_world_size()
logger.info(
"MistralEncoderModel init: hidden_size=%d, num_heads=%d, "
"num_kv_heads=%d, head_dim=%d, num_layers=%d, tp_size=%d",
self.hidden_size,
self.num_heads,
self.num_kv_heads,
self.head_dim,
self.num_layers,
tp_size,
)
# Nest modules to match HF checkpoint hierarchy:
# language_model.model.embed_tokens
# language_model.model.layers.X...
# language_model.model.norm
self.language_model = nn.Module()
self.language_model.model = nn.Module()
m = self.language_model.model
m.embed_tokens = VocabParallelEmbedding(self.vocab_size, self.hidden_size)
m.layers = nn.ModuleList(
[
MistralEncoderLayer(
hidden_size=self.hidden_size,
num_heads=self.num_heads,
num_kv_heads=self.num_kv_heads,
head_dim=self.head_dim,
intermediate_size=self.intermediate_size,
rms_norm_eps=self.rms_norm_eps,
prefix=f"language_model.model.layers.{i}",
)
for i in range(self.num_layers)
]
)
m.norm = RMSNorm(self.hidden_size, eps=self.rms_norm_eps)
m.rotary_emb = MistralRotaryEmbedding(self.head_dim, self.max_position_embeddings, self.rope_theta)
self.language_model.lm_head = ParallelLMHead(self.vocab_size, self.hidden_size, bias=False)
@property
def dtype(self) -> torch.dtype:
return next(self.parameters()).dtype
@property
def device(self) -> torch.device:
return next(self.parameters()).device
def forward(
self,
input_ids: torch.Tensor,
attention_mask: torch.Tensor | None = None,
output_hidden_states: bool = False,
use_cache: bool = False,
past_key_values: list[tuple[torch.Tensor, torch.Tensor]] | None = None,
**kwargs,
) -> MistralEncoderOutput:
m = self.language_model.model
hidden_states = m.embed_tokens(input_ids)
seq_len = input_ids.shape[1]
# Determine position offset from cached KV length
past_len = past_key_values[0][0].shape[2] if past_key_values is not None else 0
total_len = past_len + seq_len
# Compute position_ids from attention_mask so padded tokens get position 0
# and real tokens get contiguous positions starting from 0.
if attention_mask is not None:
position_ids = attention_mask.long().cumsum(-1) - 1
position_ids.clamp_(min=0)
position_ids = position_ids[:, -seq_len:]
else:
position_ids = torch.arange(past_len, past_len + seq_len, device=hidden_states.device).unsqueeze(0)
cos, sin = m.rotary_emb(position_ids, hidden_states.dtype)
# Build causal attention mask combined with padding mask for SDPA.
# Mistral is a decoder-only model, so hidden states are computed with
# causal (autoregressive) attention even when used as an encoder.
min_val = torch.finfo(hidden_states.dtype).min
causal_mask = torch.triu(
torch.full((seq_len, total_len), min_val, device=hidden_states.device, dtype=hidden_states.dtype),
diagonal=past_len + 1,
)
# (seq_len, total_len) -> (1, 1, seq_len, total_len)
sdpa_mask = causal_mask.unsqueeze(0).unsqueeze(0)
if attention_mask is not None:
# Combine with padding mask: (batch, 1, 1, total_len)
padding_mask = attention_mask[:, None, None, :].to(dtype=hidden_states.dtype)
padding_mask = (1.0 - padding_mask) * min_val
sdpa_mask = sdpa_mask + padding_mask
all_hidden_states = () if output_hidden_states else None
new_key_values = [] if use_cache else None
for i, layer in enumerate(m.layers):
if output_hidden_states:
all_hidden_states = all_hidden_states + (hidden_states,)
past_kv = past_key_values[i] if past_key_values is not None else None
hidden_states, layer_kv = layer(
hidden_states,
cos,
sin,
sdpa_mask,
past_kv,
use_cache,
)
if use_cache:
new_key_values.append(layer_kv)
hidden_states = m.norm(hidden_states)
if output_hidden_states:
all_hidden_states = all_hidden_states + (hidden_states,)
return MistralEncoderOutput(
last_hidden_state=hidden_states,
hidden_states=all_hidden_states,
past_key_values=new_key_values,
)
def _compute_logits(self, hidden_states: torch.Tensor) -> torch.Tensor:
"""Compute full-vocab logits from hidden states using the lm_head weight."""
local_logits = F.linear(
hidden_states,
self.language_model.lm_head.weight,
)
if get_tensor_model_parallel_world_size() > 1:
return tensor_model_parallel_all_gather(local_logits)
return local_logits
@staticmethod
def _sample(
logits: torch.Tensor,
do_sample: bool,
temperature: float,
) -> torch.Tensor:
"""Sample or greedily select the next token from logits. Returns (batch, 1)."""
if do_sample:
logits = logits / max(temperature, 1e-7)
probs = F.softmax(logits, dim=-1)
return torch.multinomial(probs, num_samples=1)
return logits.argmax(dim=-1, keepdim=True)
# TODO make common. Potentially with HF mixin
@torch.no_grad()
def generate(
self,
input_ids: torch.Tensor,
attention_mask: torch.Tensor | None = None,
max_new_tokens: int = 512,
do_sample: bool = True,
temperature: float = 1.0,
eos_token_id: int | list[int] | None = None,
**kwargs,
) -> torch.Tensor:
"""Autoregressive text generation with KV caching.
Accepts the same keyword arguments as the HuggingFace
``GenerationMixin.generate`` interface used by the pipeline
(``pixel_values`` etc. are accepted and ignored).
Returns the full token sequence including the input prompt.
"""
eos_token_id = eos_token_id or getattr(self.config, "eos_token_id", None)
if isinstance(eos_token_id, int):
eos_token_ids = {eos_token_id}
elif isinstance(eos_token_id, list):
eos_token_ids = set(eos_token_id)
else:
eos_token_ids = set()
batch_size = input_ids.shape[0]
device = input_ids.device
generated = input_ids
# Prefill ----------------------------------------------------------------
output = self.forward(
input_ids=input_ids,
attention_mask=attention_mask,
use_cache=True,
)
past_key_values = output.past_key_values
logits = self._compute_logits(output.last_hidden_state[:, -1:, :])
next_token = self._sample(logits.squeeze(1), do_sample, temperature)
if get_tensor_model_parallel_world_size() > 1:
torch.distributed.broadcast(next_token, src=0)
generated = torch.cat([generated, next_token], dim=1)
if attention_mask is not None:
attention_mask = torch.cat(
[attention_mask, torch.ones((batch_size, 1), device=device, dtype=attention_mask.dtype)],
dim=1,
)
finished = torch.zeros(batch_size, dtype=torch.bool, device=device)
if eos_token_ids:
eos_tensor = torch.tensor(list(eos_token_ids), device=device)
finished = finished | torch.isin(next_token.squeeze(-1), eos_tensor)
# Decode loop -------------------------------------------------------------
for _ in range(max_new_tokens - 1):
if finished.all():
break
output = self.forward(
input_ids=next_token,
attention_mask=attention_mask,
use_cache=True,
past_key_values=past_key_values,
)
past_key_values = output.past_key_values
logits = self._compute_logits(output.last_hidden_state)
next_token = self._sample(logits.squeeze(1), do_sample, temperature)
if get_tensor_model_parallel_world_size() > 1:
torch.distributed.broadcast(next_token, src=0)
generated = torch.cat([generated, next_token], dim=1)
if attention_mask is not None:
attention_mask = torch.cat(
[attention_mask, torch.ones((batch_size, 1), device=device, dtype=attention_mask.dtype)],
dim=1,
)
if eos_token_ids:
finished = finished | torch.isin(next_token.squeeze(-1), eos_tensor)
return generated
def set_processor(
self,
processor,
system_message_t2i: str | None = None,
system_message_i2i: str | None = None,
) -> None:
self._processor = processor
self._system_message_t2i = system_message_t2i
self._system_message_i2i = system_message_i2i
@torch.no_grad()
def upsample_prompt(
self,
prompt: str | list[str],
images: list | None = None,
temperature: float = 0.15,
device: torch.device | None = None,
max_new_tokens: int = 512,
max_length: int = 2048,
) -> list[str]:
if self._processor is None:
raise RuntimeError("upsample_prompt() requires a processor; call set_processor() first")
prompt = [prompt] if isinstance(prompt, str) else prompt
device = device or self.device
if images is None or len(images) == 0 or (len(images) > 0 and images[0] is None):
system_message = self._system_message_t2i or ""
else:
system_message = self._system_message_i2i or ""
messages_batch = _format_upsample_input(prompt, system_message, images)
inputs = self._processor.apply_chat_template(
messages_batch,
add_generation_prompt=True,
tokenize=True,
return_dict=True,
return_tensors="pt",
padding="max_length",
truncation=True,
max_length=max_length,
)
inputs["input_ids"] = inputs["input_ids"].to(device)
inputs["attention_mask"] = inputs["attention_mask"].to(device)
if "pixel_values" in inputs:
inputs["pixel_values"] = inputs["pixel_values"].to(device, self.dtype)
generated_ids = self.generate(
**inputs,
max_new_tokens=max_new_tokens,
do_sample=True,
temperature=temperature,
use_cache=True,
)
input_length = inputs["input_ids"].shape[1]
generated_tokens = generated_ids[:, input_length:]
return self._processor.tokenizer.batch_decode(
generated_tokens,
skip_special_tokens=True,
clean_up_tokenization_spaces=True,
)
def load_weights(self, weights: Iterable[tuple[str, torch.Tensor]]) -> set[str]:
stacked_params_mapping = [
# (param_name, weight_name, shard_id)
(".qkv_proj", ".q_proj", "q"),
(".qkv_proj", ".k_proj", "k"),
(".qkv_proj", ".v_proj", "v"),
(".gate_up_proj", ".gate_proj", 0),
(".gate_up_proj", ".up_proj", 1),
]
params_dict = dict(self.named_parameters())
params_dict.update(self.named_buffers())
loaded_params: set[str] = set()
for name, loaded_weight in weights:
# Skip vision components (lm_head is needed — weights are not tied)
if any(name.startswith(p) for p in ("vision_tower.", "multi_modal_projector.")):
continue
for param_name, weight_name, shard_id in stacked_params_mapping:
if weight_name not in name:
continue
name = name.replace(weight_name, param_name)
if name not in params_dict:
break
param = params_dict[name]
weight_loader = param.weight_loader
weight_loader(param, loaded_weight, shard_id)
loaded_params.add(name)
break
else:
if name not in params_dict:
logger.warning("Skipping weight %s", name)
continue
param = params_dict[name]
weight_loader = getattr(param, "weight_loader", default_weight_loader)
weight_loader(param, loaded_weight)
loaded_params.add(name)
total_param_bytes = sum(p.numel() * p.element_size() for p in self.parameters())
logger.info(
"MistralEncoderModel load_weights: loaded %d params, total param memory: %.2f GiB",
len(loaded_params),
total_param_bytes / (1024**3),
)
return loaded_params