263 lines
9.1 KiB
Python
263 lines
9.1 KiB
Python
# SPDX-License-Identifier: Apache-2.0
|
|
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
|
|
# Adapted from https://huggingface.co/jinaai/jina-reranker-v3/blob/main/modeling.py
|
|
import json
|
|
import logging
|
|
from collections import defaultdict
|
|
from collections.abc import Iterable
|
|
|
|
import torch
|
|
from safetensors.torch import load as safetensors_load
|
|
from torch import nn
|
|
|
|
from vllm.config import VllmConfig
|
|
from vllm.sequence import IntermediateTensors
|
|
from vllm.tasks import PoolingTask
|
|
from vllm.transformers_utils.repo_utils import get_hf_file_bytes
|
|
from vllm.v1.pool.metadata import PoolingMetadata
|
|
|
|
from ..layers.pooler import DispatchPooler
|
|
from ..layers.pooler.tokwise import (
|
|
StepPool,
|
|
TokenPooler,
|
|
TokenPoolingMethodOutputItem,
|
|
)
|
|
from .interfaces import SupportsLateInteraction
|
|
from .interfaces_base import VllmModelForPooling
|
|
from .qwen3 import Qwen3ForCausalLM, Qwen3Model
|
|
from .utils import AutoWeightsLoader, WeightsMapper, maybe_prefix
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class JinaForRanking(nn.Module, SupportsLateInteraction):
|
|
is_pooling_model = True
|
|
|
|
def __init__(self, *, vllm_config: VllmConfig, prefix: str = ""):
|
|
super().__init__()
|
|
config = vllm_config.model_config.hf_config
|
|
quant_config = vllm_config.quant_config
|
|
|
|
self.config = config
|
|
self.projector_dim: int = config.embedding_size
|
|
|
|
self.vllm_config = vllm_config
|
|
self.quant_config = quant_config
|
|
self.model = Qwen3Model(
|
|
vllm_config=vllm_config, prefix=maybe_prefix(prefix, "model")
|
|
)
|
|
|
|
self.projector = nn.Sequential(
|
|
nn.Linear(config.hidden_size, config.hidden_size // 2, bias=False),
|
|
nn.ReLU(),
|
|
nn.Linear(config.hidden_size // 2, self.projector_dim, bias=False),
|
|
)
|
|
|
|
self.pooler = DispatchPooler(
|
|
{
|
|
"token_embed": TokenPooler(
|
|
pooling=JinaForRankingPool(self.projector),
|
|
)
|
|
}
|
|
)
|
|
|
|
def embed_input_ids(self, input_ids: torch.Tensor) -> torch.Tensor:
|
|
return self.model.embed_input_ids(input_ids)
|
|
|
|
def forward(
|
|
self,
|
|
input_ids: torch.Tensor | None,
|
|
positions: torch.Tensor,
|
|
intermediate_tensors: IntermediateTensors | None = None,
|
|
inputs_embeds: torch.Tensor | None = None,
|
|
) -> torch.Tensor | IntermediateTensors:
|
|
hidden_states = self.model(
|
|
input_ids, positions, intermediate_tensors, inputs_embeds
|
|
)
|
|
return hidden_states
|
|
|
|
def load_weights(self, weights: Iterable[tuple[str, torch.Tensor]]) -> set[str]:
|
|
loader = AutoWeightsLoader(self, skip_prefixes=(["lm_head."]))
|
|
return loader.load_weights(weights)
|
|
|
|
|
|
class JinaForRankingPool(StepPool):
|
|
def __init__(self, projector: nn.Sequential):
|
|
super().__init__()
|
|
|
|
self.doc_token_id = 151670
|
|
self.query_token_id = 151671
|
|
self.projector = projector
|
|
|
|
def get_supported_tasks(self) -> set[PoolingTask]:
|
|
return {"token_embed"}
|
|
|
|
def forward(
|
|
self,
|
|
hidden_states: torch.Tensor,
|
|
pooling_metadata: PoolingMetadata,
|
|
) -> list[TokenPoolingMethodOutputItem]:
|
|
pooled_data_lst = super().forward(hidden_states, pooling_metadata)
|
|
prompt_token_ids = pooling_metadata.get_prompt_token_ids()
|
|
|
|
embeds_list = list[torch.Tensor | None]()
|
|
for data, token_ids in zip(pooled_data_lst, prompt_token_ids):
|
|
# for unfinished chunked prefill
|
|
if data is None:
|
|
embeds_list.append(None)
|
|
else:
|
|
docs_indexes = torch.where(torch.eq(token_ids, self.doc_token_id))[0]
|
|
query_indexes = torch.where(torch.eq(token_ids, self.query_token_id))[0]
|
|
|
|
# The JinaForRanking model concatenates docs first, then query.
|
|
# Let's stay consistent with this novel design.
|
|
indexes = torch.cat([docs_indexes, query_indexes])
|
|
embeds = self.projector(data[indexes])
|
|
embeds_list.append(embeds)
|
|
|
|
return embeds_list
|
|
|
|
|
|
# jina-embeddings-v5-text-small wraps Qwen3-0.6B-Base with four task-specific
|
|
# LoRA adapters. This implementation merges the selected adapter into the base
|
|
# weights at load time to avoid any runtime dependency on peft.
|
|
#
|
|
# Task selection:
|
|
# Pass --hf-overrides '{"jina_task": "retrieval"}' to select one of:
|
|
# retrieval (default), text-matching, classification, clustering.
|
|
|
|
_DEFAULT_TASK = "retrieval"
|
|
_SUPPORTED_TASKS = {"retrieval", "text-matching", "classification", "clustering"}
|
|
|
|
|
|
def _load_adapter(
|
|
model: str,
|
|
task: str,
|
|
revision: str | None,
|
|
) -> tuple[dict, dict[str, torch.Tensor]] | None:
|
|
"""Load adapter config and weights from a local path or HF repo.
|
|
|
|
Returns (adapter_config, adapter_weights) or None if not found.
|
|
"""
|
|
config_bytes = get_hf_file_bytes(
|
|
f"adapters/{task}/adapter_config.json",
|
|
model,
|
|
revision,
|
|
)
|
|
if config_bytes is None:
|
|
return None
|
|
|
|
adapter_config = json.loads(config_bytes)
|
|
|
|
weights_bytes = get_hf_file_bytes(
|
|
f"adapters/{task}/adapter_model.safetensors",
|
|
model,
|
|
revision,
|
|
)
|
|
if weights_bytes is None:
|
|
return None
|
|
|
|
adapter_weights = safetensors_load(weights_bytes)
|
|
return adapter_config, adapter_weights
|
|
|
|
|
|
def _build_lora_pairs(adapter_weights: dict) -> dict:
|
|
"""Group raw adapter tensors into {base_key: {"A": tensor, "B": tensor}} pairs.
|
|
|
|
Transforms adapter keys like:
|
|
base_model.model.layers.0.self_attn.q_proj.lora_A.weight
|
|
Into base keys like:
|
|
layers.0.self_attn.q_proj.weight
|
|
"""
|
|
lora_pairs = defaultdict(dict)
|
|
for key, tensor in adapter_weights.items():
|
|
clean_key = key
|
|
if clean_key.startswith("base_model.model."):
|
|
clean_key = clean_key[len("base_model.model.") :]
|
|
|
|
if ".lora_A." in clean_key:
|
|
base_key = clean_key.split(".lora_A.")[0] + ".weight"
|
|
lora_pairs[base_key]["A"] = tensor
|
|
elif ".lora_B." in clean_key:
|
|
base_key = clean_key.split(".lora_B.")[0] + ".weight"
|
|
lora_pairs[base_key]["B"] = tensor
|
|
|
|
return dict(lora_pairs)
|
|
|
|
|
|
class JinaEmbeddingsV5Model(Qwen3ForCausalLM, VllmModelForPooling):
|
|
"""Jina Embeddings V5 with task-specific LoRA adapters merged at load time.
|
|
|
|
Extends Qwen3ForCausalLM (the underlying architecture) and declares itself
|
|
as a pooling model so that as_embedding_model() does not wrap it.
|
|
"""
|
|
|
|
is_pooling_model = True
|
|
hf_to_vllm_mapper = Qwen3ForCausalLM.hf_to_vllm_mapper | WeightsMapper(
|
|
orig_to_new_prefix={"": "model."}
|
|
)
|
|
|
|
def __init__(self, *, vllm_config: VllmConfig, prefix: str = ""):
|
|
super().__init__(vllm_config=vllm_config, prefix=prefix)
|
|
|
|
self._model_name = vllm_config.model_config.model
|
|
self._revision = vllm_config.model_config.revision
|
|
|
|
self._task = getattr(
|
|
vllm_config.model_config.hf_config, "jina_task", _DEFAULT_TASK
|
|
)
|
|
if self._task not in _SUPPORTED_TASKS:
|
|
logger.warning(
|
|
"Unknown jina_task=%r. Falling back to %r.",
|
|
self._task,
|
|
_DEFAULT_TASK,
|
|
)
|
|
self._task = _DEFAULT_TASK
|
|
|
|
pooler_config = vllm_config.model_config.pooler_config
|
|
assert pooler_config is not None
|
|
self.pooler = DispatchPooler.for_embedding(pooler_config)
|
|
|
|
def load_weights(self, weights: Iterable[tuple[str, torch.Tensor]]) -> set[str]:
|
|
lora_pairs: dict = {}
|
|
scaling = 1.0
|
|
|
|
result = _load_adapter(self._model_name, self._task, self._revision)
|
|
if result is None:
|
|
logger.warning(
|
|
"No adapter found for task %r in %r. Loading raw base weights.",
|
|
self._task,
|
|
self._model_name,
|
|
)
|
|
else:
|
|
adapter_config, adapter_weights = result
|
|
scaling = adapter_config["lora_alpha"] / adapter_config["r"]
|
|
lora_pairs = _build_lora_pairs(adapter_weights)
|
|
logger.info(
|
|
"Loaded %d adapter tensors for task %r (scaling=%.4f, %d LoRA pairs)",
|
|
len(adapter_weights),
|
|
self._task,
|
|
scaling,
|
|
len(lora_pairs),
|
|
)
|
|
|
|
def _merge_weights(
|
|
weights: Iterable[tuple[str, torch.Tensor]],
|
|
) -> Iterable[tuple[str, torch.Tensor]]:
|
|
for name, tensor in weights:
|
|
clean_name = name
|
|
if clean_name.startswith("model."):
|
|
clean_name = clean_name[len("model.") :]
|
|
|
|
if clean_name in lora_pairs:
|
|
pair = lora_pairs[clean_name]
|
|
if "A" in pair and "B" in pair:
|
|
lora_A = pair["A"].to(device=tensor.device, dtype=tensor.dtype)
|
|
lora_B = pair["B"].to(device=tensor.device, dtype=tensor.dtype)
|
|
tensor = tensor + (lora_B @ lora_A) * scaling
|
|
yield name, tensor
|
|
|
|
loader = AutoWeightsLoader(self, ignore_unexpected_prefixes=["lm_head."])
|
|
weights = _merge_weights(weights)
|
|
return loader.load_weights(weights, mapper=self.hf_to_vllm_mapper)
|