File size: 33,242 Bytes
27e1dd7 f1a36c5 27e1dd7 f1a36c5 27e1dd7 f1a36c5 27e1dd7 d632d6b 27e1dd7 d632d6b 27e1dd7 f1a36c5 d632d6b f1a36c5 d632d6b f1a36c5 d632d6b f1a36c5 e6d91bc 27e1dd7 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 | """HF remote-code modeling for the fusion-embedding family (AutoModel + trust_remote_code).
One embedding space for text, images, video, and audio. The checkpoint on this repository holds
ONLY the trained components (perceiver-resampler connector, diagonal text whitening,
logit scale and — generation 2 — the modality-gated deep adapters); the frozen
Qwen3-VL-Embedding-2B base and the frozen Qwen2.5-Omni audio tower are downloaded from
their own repositories on first use and are byte-identical to their releases.
from transformers import AutoModel
model = AutoModel.from_pretrained(
"EximiusLabs/fusion-embedding-1-2b-preview", trust_remote_code=True)
t = model.embed_text("a dog barks in the distance")
a = model.embed_audio("dog.wav")
i = model.embed_image("dog.jpg")
v = model.embed_video("dog.mp4") # or a list of PIL frames
The embed_* methods reproduce the repository's reference ``inference.py`` exactly (same
chat templates, truncation, pooling, whitening, Matryoshka truncation and normalization);
outputs are bitwise-identical to that loader on the same hardware. Non-audio inputs never
execute the generation-2 adapter branch (the gate returns the frozen layers' output
untouched), so text/image/video outputs are bit-for-bit those of generation 1 and of the
base's computation path.
Requires: transformers>=4.46 (with the Qwen2.5-Omni model classes), torchvision, pillow,
soundfile, librosa; embedding a video by file path additionally requires torchcodec
(decoded frame tensors and frame sequences need nothing extra). A CUDA GPU is
recommended (~14 GB at bf16).
"""
from __future__ import annotations
import math
import os
from typing import Optional, Union
import torch
import torch.nn as nn
import torch.nn.functional as F
from transformers import PreTrainedModel
from .configuration_fusion_embedding import FusionEmbeddingConfig
DEFAULT_QUERY_INSTRUCTION = "Retrieve images or text relevant to the user's query."
DOC_INSTRUCTION = "Represent the user's input."
_ACTS = {"silu": nn.SiLU, "gelu": nn.GELU, "relu": nn.ReLU}
# --------------------------------------------------------------------------- #
# helpers (mirrors of the training package, kept self-contained on purpose)
# --------------------------------------------------------------------------- #
def _chat(instruction: str, user_content: str) -> str:
"""The base's official embedding format: system-turn instruction, assistant opener."""
return (f"<|im_start|>system\n{instruction}<|im_end|>\n"
f"<|im_start|>user\n{user_content}<|im_end|>\n"
f"<|im_start|>assistant\n")
def sinusoidal_positions(length: int, dim: int, device, dtype) -> torch.Tensor:
if dim % 2 != 0:
pe = sinusoidal_positions(length, dim + 1, device, dtype)
return pe[:, :dim]
pos = torch.arange(length, device=device, dtype=torch.float32).unsqueeze(1)
div = torch.exp(torch.arange(0, dim, 2, device=device, dtype=torch.float32)
* (-math.log(10000.0) / dim))
pe = torch.zeros(length, dim, device=device, dtype=torch.float32)
pe[:, 0::2] = torch.sin(pos * div)
pe[:, 1::2] = torch.cos(pos * div)
return pe.to(dtype)
def last_token_pool(hidden: torch.Tensor, attention_mask: torch.Tensor) -> torch.Tensor:
lengths = attention_mask.long().sum(dim=1) - 1
lengths = lengths.clamp(min=0)
idx = lengths.view(-1, 1, 1).expand(-1, 1, hidden.size(-1))
return hidden.gather(1, idx).squeeze(1)
def mrl_truncate_normalize(x: torch.Tensor, dim: int) -> torch.Tensor:
return F.normalize(x[..., :dim], p=2, dim=-1)
class TextWhitening(nn.Module):
"""Diagonal (per-dim, MRL-safe) standardization of frozen text embeddings."""
def __init__(self, dim: int):
super().__init__()
self.register_buffer("mean", torch.zeros(dim))
self.register_buffer("std", torch.ones(dim))
self.register_buffer("fitted", torch.zeros((), dtype=torch.uint8))
def forward(self, x: torch.Tensor) -> torch.Tensor:
if int(self.fitted) == 0:
return x
mean = self.mean.to(device=x.device, dtype=x.dtype)
std = self.std.to(device=x.device, dtype=x.dtype)
return (x - mean) / std
class _ResamplerBlock(nn.Module):
"""Pre-norm: latent self-attention -> cross-attention -> FFN."""
def __init__(self, dim: int, heads: int, ffn_mult: int, dropout: float):
super().__init__()
self.norm_sa = nn.LayerNorm(dim)
self.self_attn = nn.MultiheadAttention(dim, heads, dropout=dropout, batch_first=True)
self.norm_q = nn.LayerNorm(dim)
self.norm_kv = nn.LayerNorm(dim)
self.cross_attn = nn.MultiheadAttention(dim, heads, dropout=dropout, batch_first=True)
self.norm_ff = nn.LayerNorm(dim)
self.ffn = nn.Sequential(
nn.Linear(dim, dim * ffn_mult),
nn.GELU(),
nn.Dropout(dropout),
nn.Linear(dim * ffn_mult, dim),
)
def forward(self, q, kv, key_padding_mask):
h = self.norm_sa(q)
q = q + self.self_attn(h, h, h, need_weights=False)[0]
h = self.norm_q(q)
kv_n = self.norm_kv(kv)
q = q + self.cross_attn(h, kv_n, kv_n, key_padding_mask=key_padding_mask,
need_weights=False)[0]
q = q + self.ffn(self.norm_ff(q))
return q
class FusionResampler(nn.Module):
"""Perceiver-resampler: variable-length audio frames -> N fixed latent tokens."""
def __init__(self, cfg: FusionEmbeddingConfig):
super().__init__()
dr = cfg.d_resampler
self.in_proj = nn.Linear(cfg.d_audio, dr)
self.queries = nn.Parameter(torch.empty(cfg.n_query, dr))
nn.init.normal_(self.queries, std=0.02)
self.blocks = nn.ModuleList(
_ResamplerBlock(dr, cfg.resampler_heads, cfg.resampler_ffn_mult,
cfg.resampler_dropout)
for _ in range(cfg.resampler_depth)
)
self.out_proj = nn.Linear(dr, cfg.d_llm)
self.out_norm = nn.LayerNorm(cfg.d_llm)
def forward(self, frames: torch.Tensor, frame_mask: Optional[torch.Tensor] = None):
B, T, _ = frames.shape
if frame_mask is None:
frame_mask = torch.ones(B, T, dtype=torch.bool, device=frames.device)
kv = self.in_proj(frames)
kv = kv + sinusoidal_positions(T, kv.size(-1), kv.device, kv.dtype).unsqueeze(0)
key_padding = ~frame_mask
fully_masked = key_padding.all(dim=1)
if fully_masked.any():
key_padding = key_padding.clone()
key_padding[fully_masked, 0] = False
q = self.queries.unsqueeze(0).expand(B, -1, -1)
for block in self.blocks:
q = block(q, kv, key_padding)
return self.out_norm(self.out_proj(q))
class AdapterGate:
"""Depth-counted on/off switch shared by every adapter hook (generation 2)."""
__slots__ = ("_depth",)
def __init__(self) -> None:
self._depth = 0
@property
def active(self) -> bool:
return self._depth > 0
def __enter__(self) -> "AdapterGate":
self._depth += 1
return self
def __exit__(self, *exc) -> None:
self._depth -= 1
if self._depth < 0:
raise RuntimeError("AdapterGate depth underflow — unbalanced enter/exit")
class GatedAdapter(nn.Module):
"""Parallel bottleneck adapter: ``h + up(act(down(LN(h))))``, computed in fp32."""
def __init__(self, d_model: int, rank: int, act: str = "silu"):
super().__init__()
self.norm = nn.LayerNorm(d_model)
self.down = nn.Linear(d_model, rank, bias=False)
self.act = _ACTS[act]()
self.up = nn.Linear(rank, d_model, bias=False)
nn.init.zeros_(self.up.weight)
def forward(self, h: torch.Tensor) -> torch.Tensor:
return self.up(self.act(self.down(self.norm(h.float())))).to(h.dtype)
def _make_hook(adapter: GatedAdapter, gate: AdapterGate):
def hook(_module, _inputs, output):
if not gate.active:
return None # keep original output — bitwise no-op
if isinstance(output, tuple): # HF decoder layers -> (hidden, ...)
h = output[0]
return (h + adapter(h),) + tuple(output[1:])
return output + adapter(output)
return hook
class OmniAudioAdapter(nn.Module):
"""Frozen Qwen2.5-Omni audio encoder -> (frames [B,T,d_audio], frame_mask [B,T])."""
def __init__(self, encoder: nn.Module, d_audio: int):
super().__init__()
self.encoder = encoder
self.d_audio = d_audio
@torch.no_grad()
def forward(self, mel: torch.Tensor, mel_mask: Optional[torch.Tensor] = None):
B, n_mels, Fdim = mel.shape
if mel_mask is None:
feat_lens = torch.full((B,), Fdim, dtype=torch.long, device=mel.device)
else:
feat_lens = mel_mask.long().sum(dim=1)
dtype = next(self.encoder.parameters()).dtype
per_item = []
for i in range(B):
Li = max(int(feat_lens[i].item()), 1)
feats = mel[i, :, :Li].to(dtype)
out = self.encoder(input_features=feats,
feature_lens=torch.tensor([Li], device=mel.device))
frames = out.last_hidden_state
if frames.dim() == 3:
frames = frames[0]
per_item.append(frames.float())
T_max = max(f.shape[0] for f in per_item)
frames_out = mel.new_zeros(B, T_max, self.d_audio)
frame_mask = torch.zeros(B, T_max, dtype=torch.bool, device=mel.device)
for i, f in enumerate(per_item):
frames_out[i, : f.shape[0]] = f
frame_mask[i, : f.shape[0]] = True
return frames_out, frame_mask
# --------------------------------------------------------------------------- #
# the AutoModel entry point
# --------------------------------------------------------------------------- #
# --------------------------------------------------------------------------- #
# video preprocessing (native)
#
# Faithful reimplementation of the base model's reference video preprocessing
# (the Qwen3-VL-Embedding scripts' vision pipeline at image_patch_size=16), so
# no extra vision package is needed: frame selection, the per-frame image
# resize applied to frame-sequence inputs, the per-video smart resize under the
# total-pixel budget, and the processor kwargs (do_resize=False,
# do_sample_frames=False, video_metadata) match the reference exactly; outputs
# are verified bitwise-equal against the reference implementation on identical
# inputs. Decoded-video inputs (frame tensors, file paths via torchcodec) take
# the reference path-input treatment: a single per-video resize, no per-frame
# image resize.
# --------------------------------------------------------------------------- #
_V_PATCH_FACTOR = 32 # image_patch_size 16 x spatial merge 2
_V_FRAME_FACTOR = 2
_V_DEFAULT_FPS = 1.0
_V_DEFAULT_MAX_FRAMES = 64
_V_MIN_PIXELS = 128 * _V_PATCH_FACTOR ** 2 # per-frame floor
_V_MAX_PIXELS = 768 * _V_PATCH_FACTOR ** 2 # per-frame ceiling
_V_TOTAL_PIXELS = 10 * _V_MAX_PIXELS # per-video budget
_V_IMG_MIN_PIXELS = 4 * _V_PATCH_FACTOR ** 2 # per-frame image defaults
_V_IMG_MAX_PIXELS = 16384 * _V_PATCH_FACTOR ** 2
_V_FPS_MIN_FRAMES = 4
_V_MAX_RATIO = 200
def _v_round(n: float, f: int) -> int:
return round(n / f) * f
def _v_ceil(n: float, f: int) -> int:
return math.ceil(n / f) * f
def _v_floor(n: float, f: int) -> int:
return math.floor(n / f) * f
def _v_smart_resize(height: int, width: int, factor: int,
min_pixels: int, max_pixels: int):
if max(height, width) / min(height, width) > _V_MAX_RATIO:
raise ValueError(
f"absolute aspect ratio must be smaller than {_V_MAX_RATIO}, "
f"got {max(height, width) / min(height, width)}")
h_bar = max(factor, _v_round(height, factor))
w_bar = max(factor, _v_round(width, factor))
if h_bar * w_bar > max_pixels:
beta = math.sqrt((height * width) / max_pixels)
h_bar = _v_floor(height / beta, factor)
w_bar = _v_floor(width / beta, factor)
elif h_bar * w_bar < min_pixels:
beta = math.sqrt(min_pixels / (height * width))
h_bar = _v_ceil(height * beta, factor)
w_bar = _v_ceil(width * beta, factor)
return h_bar, w_bar
def _v_frame_to_image(frame):
"""Frame-sequence element -> resized RGB PIL image (reference fetch_image)."""
from PIL import Image
if isinstance(frame, (str, os.PathLike)):
image = Image.open(str(frame))
else:
image = frame
if image.mode == "RGBA":
white = Image.new("RGB", image.size, (255, 255, 255))
white.paste(image, mask=image.split()[3])
image = white
else:
image = image.convert("RGB")
width, height = image.size
rh, rw = _v_smart_resize(height, width, _V_PATCH_FACTOR,
_V_IMG_MIN_PIXELS, _V_IMG_MAX_PIXELS)
return image.resize((rw, rh))
def _v_prepare(video, fps, max_frames):
"""Normalize any supported video input to (uint8 tensor [T,C,H,W], metadata).
Frame sequences follow the reference list-input treatment (per-frame image
resize, pad to an even count by repeating the last frame, synthetic
metadata at 2 fps). Frame tensors and file paths follow the reference
decoded-video treatment (frame selection only; single per-video resize).
"""
import numpy as np
if isinstance(video, torch.Tensor):
if video.ndim != 4 or video.shape[1] not in (1, 3):
raise ValueError(
f"expected a [T, C, H, W] frame tensor, got {list(video.shape)}")
frames = video
if frames.shape[1] == 1:
frames = frames.expand(-1, 3, -1, -1)
if frames.dtype != torch.uint8:
frames = frames.clamp(0, 255).to(torch.uint8)
t = frames.shape[0]
mf = max_frames or _V_DEFAULT_MAX_FRAMES
if t > mf:
idx = np.linspace(0, t - 1, mf, dtype=int)
frames = frames[torch.as_tensor(idx.copy())]
t = mf
n = _v_ceil(t, _V_FRAME_FACTOR)
if t < n:
frames = torch.cat([frames, frames[-1:].expand(n - t, -1, -1, -1)])
metadata = dict(fps=2.0, frames_indices=list(range(n)),
total_num_frames=float(n))
return frames, metadata
if isinstance(video, (str, os.PathLike)):
v = str(video)
if v.startswith("file://"):
v = v[7:]
try:
from torchcodec.decoders import VideoDecoder
except ImportError as e:
raise ImportError(
"embedding a video by file path requires torchcodec "
"(pip install torchcodec); alternatively pass decoded frames "
"(a [T, C, H, W] tensor or a list of PIL images)") from e
decoder = VideoDecoder(v)
video_fps = decoder.metadata.average_fps
total = decoder.metadata.num_frames
want_fps = fps or _V_DEFAULT_FPS
min_frames = _v_ceil(_V_FPS_MIN_FRAMES, _V_FRAME_FACTOR)
max_f = _v_floor(max_frames or _V_DEFAULT_MAX_FRAMES, _V_FRAME_FACTOR)
n = total / video_fps * want_fps
n = min(min(max(n, min_frames), max_f), total)
n = _v_floor(n, _V_FRAME_FACTOR)
if not (_V_FRAME_FACTOR <= n <= total):
raise ValueError(
f"video too short: {total} frames; need >= {_V_FRAME_FACTOR}")
idx = torch.linspace(0, total - 1, n).round().long().tolist()
frames = decoder.get_frames_at(indices=idx).data
metadata = dict(fps=video_fps, frames_indices=idx,
total_num_frames=total, video_backend="torchcodec")
return frames, metadata
# frame sequence (PIL images and/or paths)
frames = list(video)
if not frames:
raise ValueError("empty frame sequence")
mf = max_frames or _V_DEFAULT_MAX_FRAMES
if len(frames) > mf:
idx = np.linspace(0, len(frames) - 1, mf, dtype=int)
frames = [frames[i] for i in idx]
images = [_v_frame_to_image(f) for f in frames]
n = _v_ceil(len(images), _V_FRAME_FACTOR)
if len(images) < n:
images.extend([images[-1]] * (n - len(images)))
tensor = torch.stack([
torch.from_numpy(np.array(image).transpose(2, 0, 1)) for image in images
])
metadata = dict(fps=2.0, frames_indices=list(range(n)),
total_num_frames=float(n))
return tensor, metadata
def _v_resize_video(frames: torch.Tensor) -> torch.Tensor:
"""Per-video smart resize under the total-pixel budget (reference exact)."""
from torchvision.transforms import InterpolationMode
from torchvision.transforms import functional as TF
n, _, height, width = frames.shape
max_pixels = max(min(_V_MAX_PIXELS, _V_TOTAL_PIXELS / n * _V_FRAME_FACTOR),
int(_V_MIN_PIXELS * 1.05))
rh, rw = _v_smart_resize(height, width, _V_PATCH_FACTOR,
_V_MIN_PIXELS, max_pixels)
return TF.resize(frames, [rh, rw],
interpolation=InterpolationMode.BICUBIC,
antialias=True).float()
class FusionEmbeddingModel(PreTrainedModel):
"""fusion-embedding for transformers AutoModel (trust_remote_code).
The registered submodules are exactly the trained components shipped in this
repository's ``model.safetensors`` (resampler + text whitening + logit scale
+ generation-2 adapters). The frozen base and audio tower load lazily from
their own repositories on the first ``embed_*`` call, onto the device the
trained components are on at that moment — call ``.to("cuda")`` (or pass
``device_map``) before embedding.
"""
config_class = FusionEmbeddingConfig
base_model_prefix = "fusion_embedding"
main_input_name = "input_ids"
_supports_flash_attn_2 = False
def __init__(self, config: FusionEmbeddingConfig):
super().__init__(config)
self.resampler = FusionResampler(config)
self.text_whitening = TextWhitening(config.d_llm)
self.logit_scale = nn.Parameter(torch.zeros(1))
self.audio_adapters: Optional[nn.ModuleList] = None
if config.adapter_rank and config.adapter_rank > 0:
self.audio_adapters = nn.ModuleList(
GatedAdapter(config.d_llm, config.adapter_rank, config.adapter_act)
for _ in range(config.n_decoder_layers)
)
# runtime-only state (plain dict: never in state_dict / parameters / save)
self._rt: dict = {}
self.post_init()
def _init_weights(self, module): # trained weights always come from the checkpoint
pass
# ------------------------------------------------------------- backbones
@property
def _device(self) -> torch.device:
return self.resampler.out_proj.weight.device
def _ensure_backbones(self) -> None:
if "full" in self._rt:
return
from transformers import (AutoConfig, AutoFeatureExtractor, AutoModel,
AutoProcessor)
device, dtype = self._device, torch.bfloat16
full = AutoModel.from_pretrained(self.config.base_model, trust_remote_code=True,
dtype=dtype)
full = full.to(device).eval()
for p in full.parameters():
p.requires_grad_(False)
proc = AutoProcessor.from_pretrained(self.config.base_model, trust_remote_code=True)
acfg = AutoConfig.from_pretrained(self.config.audio_model, trust_remote_code=True)
audio_cfg = acfg.thinker_config.audio_config
tower = self._load_audio_encoder(audio_cfg, dtype).to(device)
fe_audio = AutoFeatureExtractor.from_pretrained(self.config.audio_model,
trust_remote_code=True)
self._rt.update(full=full, proc=proc, tok=proc.tokenizer,
tower=OmniAudioAdapter(tower, self.config.d_audio),
fe_audio=fe_audio, gate=AdapterGate(), adapter_handles=[])
if self.audio_adapters is not None:
layers = self._find_decoder_layers(full.language_model)
if len(layers) != len(self.audio_adapters):
raise RuntimeError(
f"decoder has {len(layers)} layers but the checkpoint carries "
f"{len(self.audio_adapters)} adapters")
gate = self._rt["gate"]
self._rt["adapter_handles"] = [
layer.register_forward_hook(_make_hook(ad, gate))
for layer, ad in zip(layers, self.audio_adapters)
]
def _load_audio_encoder(self, audio_cfg, dtype):
"""Instantiate the Omni audio encoder and load only ``thinker.audio_tower.*``."""
import glob
from huggingface_hub import snapshot_download
from safetensors.torch import load_file
from transformers.models.qwen2_5_omni import modeling_qwen2_5_omni as mod
snap = snapshot_download(self.config.audio_model,
allow_patterns=["*.safetensors", "*.json"])
encoder = mod.Qwen2_5OmniAudioEncoder(audio_cfg)
prefix = "thinker.audio_tower."
collected = {}
for shard in sorted(glob.glob(os.path.join(snap, "*.safetensors"))):
for k, v in load_file(shard).items():
if k.startswith(prefix):
collected[k[len(prefix):]] = v
encoder.load_state_dict(collected, strict=False)
return encoder.to(dtype).eval()
@staticmethod
def _find_decoder_layers(base_lm: nn.Module) -> nn.ModuleList:
best = None
for name, mod_ in base_lm.named_modules():
if isinstance(mod_, nn.ModuleList) and name.rsplit(".", 1)[-1] == "layers":
if best is None or len(mod_) > len(best):
best = mod_
if best is None or len(best) == 0:
raise ValueError("no decoder ModuleList named 'layers' found in the base")
return best
# ------------------------------------------------------------- internals
def _finish(self, pooled: torch.Tensor, dim: Optional[int]) -> torch.Tensor:
dim = dim or self.config.mrl_default
return mrl_truncate_normalize(pooled.float(), dim).squeeze(0).cpu()
def _encode_text_ids(self, ids_t: torch.Tensor) -> torch.Tensor:
full = self._rt["full"]
embeds = full.get_input_embeddings()(ids_t)
out = full.language_model(inputs_embeds=embeds,
attention_mask=torch.ones_like(ids_t))
hidden = out.last_hidden_state if hasattr(out, "last_hidden_state") else out[0]
return last_token_pool(hidden, torch.ones_like(ids_t))
# ------------------------------------------------------------- embedding
@torch.no_grad()
def embed_text(self, text: str, instruction: str = DEFAULT_QUERY_INSTRUCTION,
dim: Optional[int] = None) -> torch.Tensor:
self._ensure_backbones()
if self._rt["gate"].active:
raise RuntimeError("adapter gate is open during a text encode — "
"non-audio inputs must run with the gate closed")
ids = self._rt["tok"].encode(_chat(instruction, text),
add_special_tokens=False)[: self.config.max_text_tokens]
ids_t = torch.tensor([ids], device=self._device)
pooled = self._encode_text_ids(ids_t)
return self._finish(self.text_whitening(pooled), dim)
@torch.no_grad()
def embed_audio(self, audio: Union[str, "object"], sr: Optional[int] = None,
dim: Optional[int] = None) -> torch.Tensor:
import librosa
import soundfile as sf
self._ensure_backbones()
if isinstance(audio, (str, os.PathLike)):
wav, sr = sf.read(str(audio), dtype="float32")
else:
wav = audio
assert sr is not None, "pass sr= when embedding a raw array"
if getattr(wav, "ndim", 1) > 1:
wav = wav.mean(axis=1)
fe_audio = self._rt["fe_audio"]
target_sr = fe_audio.sampling_rate
if sr != target_sr:
wav = librosa.resample(wav, orig_sr=sr, target_sr=target_sr)
feats = fe_audio(wav, sampling_rate=target_sr, return_tensors="pt",
return_attention_mask=True, padding="max_length", truncation=True)
mel = feats["input_features"][0]
am = feats.get("attention_mask")
if am is not None:
mel = mel[:, : int(am[0].sum().item())]
frames, frame_mask = self._rt["tower"](
mel.unsqueeze(0).to(self._device),
torch.ones(1, mel.shape[1], dtype=torch.bool, device=self._device))
audio_tok = self.resampler(frames, frame_mask)
cfg = self.config
ids = torch.tensor([[cfg.audio_pad_id] * cfg.n_query + [cfg.eos_id]],
device=self._device)
attention_mask = torch.ones_like(ids)
full = self._rt["full"]
embeds = full.get_input_embeddings()(ids).clone()
embeds[ids == cfg.audio_pad_id] = (
audio_tok.reshape(-1, audio_tok.size(-1)).to(embeds.dtype))
with self._rt["gate"]: # adapters ON for audio (gen 2)
out = full.language_model(inputs_embeds=embeds, attention_mask=attention_mask)
hidden = out.last_hidden_state if hasattr(out, "last_hidden_state") else out[0]
pooled = last_token_pool(hidden, attention_mask)
return self._finish(pooled, dim)
@torch.no_grad()
def embed_image(self, image, dim: Optional[int] = None) -> torch.Tensor:
from PIL import Image
self._ensure_backbones()
if self._rt["gate"].active:
# The vision path runs through the same (hook-carrying) decoder layers;
# non-audio inputs must execute with the gate closed so the adapter
# branch never runs.
raise RuntimeError("adapter gate is open during an image embed — "
"non-audio inputs must run with the gate closed")
if isinstance(image, (str, os.PathLike)):
image = Image.open(str(image))
image = image.convert("RGB")
text = _chat(DOC_INSTRUCTION, "<|vision_start|><|image_pad|><|vision_end|>")
inputs = self._rt["proc"](text=[text], images=[image],
return_tensors="pt").to(self._device)
h = self._rt["full"](**inputs).last_hidden_state
pooled = last_token_pool(h, inputs["attention_mask"])
return self._finish(pooled, dim)
@torch.no_grad()
def embed_video(self, video, fps: Optional[float] = None,
max_frames: Optional[int] = None,
dim: Optional[int] = None) -> torch.Tensor:
"""Embed a video through the frozen base model's own video path.
``video`` is a decoded frame tensor ([T, C, H, W], e.g. straight from
a torchcodec ``VideoDecoder``), a file path/URL (decoded with
torchcodec, 1 fps up to 64 frames), or a pre-extracted frame sequence
(PIL images and/or frame paths, sampled uniformly to 64).
Preprocessing natively reimplements the base model's reference
scripts (see the module-level helpers above); no extra vision package
is required. Like images, video is a non-audio input: it takes the
frozen path (no whitening, no adapters).
"""
self._ensure_backbones()
if self._rt["gate"].active:
# The video path runs through the same (hook-carrying) decoder
# layers as text and images; non-audio inputs must execute with
# the gate closed so the adapter branch never runs.
raise RuntimeError("adapter gate is open during a video embed — "
"non-audio inputs must run with the gate closed")
frames, metadata = _v_prepare(video, fps, max_frames)
frames = _v_resize_video(frames)
text = _chat(DOC_INSTRUCTION, "<|vision_start|><|video_pad|><|vision_end|>")
inputs = self._rt["proc"](text=[text], videos=[frames],
video_metadata=[metadata],
do_resize=False, do_sample_frames=False,
return_tensors="pt").to(self._device)
h = self._rt["full"](**inputs).last_hidden_state
pooled = last_token_pool(h, inputs["attention_mask"])
return self._finish(pooled, dim)
# ------------------------------------------------------------- batched
@torch.no_grad()
def embed_text_batch(self, texts, instruction: str = DEFAULT_QUERY_INSTRUCTION,
dim: Optional[int] = None,
max_tokens: Optional[int] = None) -> torch.Tensor:
"""Batch text embedding [B, dim] (right-padded, mask-aware last-token pooling)."""
self._ensure_backbones()
if self._rt["gate"].active:
raise RuntimeError("adapter gate is open during a text encode — "
"non-audio inputs must run with the gate closed")
cfg, tok = self.config, self._rt["tok"]
max_tokens = max_tokens or cfg.max_text_tokens
seqs = [tok.encode(_chat(instruction, t), add_special_tokens=False)[:max_tokens]
for t in texts]
L = max(len(s) for s in seqs)
ids = torch.full((len(seqs), L), cfg.pad_id, dtype=torch.long, device=self._device)
mask = torch.zeros(len(seqs), L, dtype=torch.long, device=self._device)
for b, s in enumerate(seqs):
ids[b, : len(s)] = torch.tensor(s, device=self._device)
mask[b, : len(s)] = 1
full = self._rt["full"]
out = full.language_model(inputs_embeds=full.get_input_embeddings()(ids),
attention_mask=mask)
hidden = out.last_hidden_state if hasattr(out, "last_hidden_state") else out[0]
pooled = self.text_whitening(last_token_pool(hidden, mask))
return mrl_truncate_normalize(pooled.float(), dim or cfg.mrl_default).cpu()
@torch.no_grad()
def embed_audio_batch(self, wavs, sr: int, dim: Optional[int] = None) -> torch.Tensor:
"""Batch audio embedding [B, dim] from raw waveform arrays at a common rate."""
import librosa
import numpy as np
self._ensure_backbones()
cfg, fe_audio = self.config, self._rt["fe_audio"]
target_sr = fe_audio.sampling_rate
prepped = []
for wav in wavs:
wav = np.asarray(wav, dtype=np.float32)
if wav.ndim > 1:
wav = wav.mean(axis=-1)
if sr != target_sr:
wav = librosa.resample(wav, orig_sr=sr, target_sr=target_sr)
prepped.append(wav)
feats = fe_audio(prepped, sampling_rate=target_sr, return_tensors="pt",
return_attention_mask=True, padding="max_length", truncation=True)
mel, am = feats["input_features"], feats.get("attention_mask")
if am is not None:
tmax = int(am.sum(dim=1).max().item())
mel, am = mel[:, :, :tmax], am[:, :tmax]
fmask = (am.bool() if am is not None
else torch.ones(mel.shape[0], mel.shape[2], dtype=torch.bool))
frames, frame_mask = self._rt["tower"](mel.to(self._device),
fmask.to(self._device))
audio_tok = self.resampler(frames, frame_mask)
ids = torch.tensor([[cfg.audio_pad_id] * cfg.n_query + [cfg.eos_id]] * mel.shape[0],
device=self._device)
attention_mask = torch.ones_like(ids)
full = self._rt["full"]
embeds = full.get_input_embeddings()(ids).clone()
embeds[ids == cfg.audio_pad_id] = (
audio_tok.reshape(-1, audio_tok.size(-1)).to(embeds.dtype))
with self._rt["gate"]:
out = full.language_model(inputs_embeds=embeds, attention_mask=attention_mask)
hidden = out.last_hidden_state if hasattr(out, "last_hidden_state") else out[0]
pooled = last_token_pool(hidden, attention_mask)
return mrl_truncate_normalize(pooled.float(), dim or cfg.mrl_default).cpu()
# ------------------------------------------------------------- read-out
@staticmethod
def center(embs: torch.Tensor) -> torch.Tensor:
"""Per-modality mean-centering + renormalization (cross-modal ranking readout)."""
c = embs - embs.mean(dim=0, keepdim=True)
return F.normalize(c, dim=-1)
def forward(self, *args, **kwargs):
raise NotImplementedError(
"fusion-embedding is an embedding model: use embed_text(str), "
"embed_audio(path_or_array, sr=...), embed_image(path_or_PIL), and "
"center(embs) for cross-modal ranking.")
|