Image-Text-to-Text
Transformers
Safetensors
lfm2_vl
liquid
lfm2.5
edge
decision
classification
calibration
system-one
multimodal
decision-model
conversational
custom_code
Eval Results
Instructions to use LiquidAI/d1-3B with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use LiquidAI/d1-3B with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("image-text-to-text", model="LiquidAI/d1-3B", trust_remote_code=True) messages = [ { "role": "user", "content": [ {"type": "image", "url": "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/p-blog/candy.JPG"}, {"type": "text", "text": "What animal is on the candy?"} ] }, ] pipe(text=messages)# pip install -U transformers accelerate # Load model directly from transformers import AutoProcessor, AutoModelForMultimodalLM processor = AutoProcessor.from_pretrained("LiquidAI/d1-3B", trust_remote_code=True) model = AutoModelForMultimodalLM.from_pretrained("LiquidAI/d1-3B", trust_remote_code=True, device_map="auto") messages = [ { "role": "user", "content": [ {"type": "image", "url": "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/p-blog/candy.JPG"}, {"type": "text", "text": "What animal is on the candy?"} ] }, ] inputs = processor.apply_chat_template( messages, add_generation_prompt=True, tokenize=True, return_dict=True, return_tensors="pt", ).to(model.device) outputs = model.generate(**inputs, max_new_tokens=256) print(processor.decode(outputs[0][inputs["input_ids"].shape[-1]:])) - Notebooks
- Google Colab
- Kaggle
- Local Apps Settings
- vLLM
How to use LiquidAI/d1-3B with vLLM:
Install from pip and serve model
# Install vLLM from pip: pip install vllm # Start the vLLM server: vllm serve "LiquidAI/d1-3B" # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:8000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "LiquidAI/d1-3B", "messages": [ { "role": "user", "content": [ { "type": "text", "text": "Describe this image in one sentence." }, { "type": "image_url", "image_url": { "url": "https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg" } } ] } ] }'Use Docker
docker model run hf.co/LiquidAI/d1-3B
- SGLang
How to use LiquidAI/d1-3B with SGLang:
Install from pip and serve model
# Install SGLang from pip: pip install sglang # Start the SGLang server: python3 -m sglang.launch_server \ --model-path "LiquidAI/d1-3B" \ --host 0.0.0.0 \ --port 30000 # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:30000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "LiquidAI/d1-3B", "messages": [ { "role": "user", "content": [ { "type": "text", "text": "Describe this image in one sentence." }, { "type": "image_url", "image_url": { "url": "https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg" } } ] } ] }'Use Docker images
docker run --gpus all \ --shm-size 32g \ -p 30000:30000 \ -v ~/.cache/huggingface:/root/.cache/huggingface \ --env "HF_TOKEN=<secret>" \ --ipc=host \ lmsysorg/sglang:latest \ python3 -m sglang.launch_server \ --model-path "LiquidAI/d1-3B" \ --host 0.0.0.0 \ --port 30000 # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:30000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "LiquidAI/d1-3B", "messages": [ { "role": "user", "content": [ { "type": "text", "text": "Describe this image in one sentence." }, { "type": "image_url", "image_url": { "url": "https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg" } } ] } ] }' - Docker Model Runner
How to use LiquidAI/d1-3B with Docker Model Runner:
docker model run hf.co/LiquidAI/d1-3B
File size: 5,602 Bytes
da1fe36 | 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 | """LFM2-VL and LFM2 on the hybrid stack.
HF's classes stay the frame (the SigLIP2 tower, the projector, the image
features, loading and saving); only the language model is replaced, with HF's
module names, so checkpoints load and save unchanged. A state with any number
of questions runs as one `hybrid.Tree`, with the same outputs as HF's own
implementation.
"""
from __future__ import annotations
import torch
import torch.nn as nn
import torch.nn.functional as F
from transformers import Lfm2Config, Lfm2VlConfig
from transformers.models.lfm2.modeling_lfm2 import Lfm2ForCausalLM as HfLfm2
from transformers.models.lfm2_vl.modeling_lfm2_vl import Lfm2VlForConditionalGeneration as HfLfm2Vl
from .hybrid import LanguageModel, RMSNorm, Tree, attention, causal_conv, rope
class Attention(nn.Module):
"""GQA with per-head q/k norms and RoPE over the whole head."""
def __init__(self, cfg):
super().__init__()
self.heads, self.kv_heads = cfg.num_attention_heads, cfg.num_key_value_heads
self.head_dim = getattr(cfg, "head_dim", None) or cfg.hidden_size // self.heads
self.q_proj = nn.Linear(cfg.hidden_size, self.heads * self.head_dim, bias=False)
self.k_proj = nn.Linear(cfg.hidden_size, self.kv_heads * self.head_dim, bias=False)
self.v_proj = nn.Linear(cfg.hidden_size, self.kv_heads * self.head_dim, bias=False)
self.out_proj = nn.Linear(self.heads * self.head_dim, cfg.hidden_size, bias=False)
self.q_layernorm = RMSNorm(self.head_dim, cfg.norm_eps)
self.k_layernorm = RMSNorm(self.head_dim, cfg.norm_eps)
self.theta = cfg.rope_parameters["rope_theta"]
self.scale = self.head_dim**-0.5
def forward(self, x: torch.Tensor, pos: torch.Tensor, tree: Tree | None) -> torch.Tensor:
batch, length, _ = x.shape
q = self.q_layernorm(self.q_proj(x).view(batch, length, self.heads, self.head_dim))
k = self.k_layernorm(self.k_proj(x).view(batch, length, self.kv_heads, self.head_dim))
v = self.v_proj(x).view(batch, length, self.kv_heads, self.head_dim)
q, k = rope(q, pos, self.theta, self.head_dim // 2), rope(k, pos, self.theta, self.head_dim // 2)
y = attention(q.transpose(1, 2), k.transpose(1, 2), v.transpose(1, 2), tree, None, self.scale)
return self.out_proj(y.transpose(1, 2).flatten(2))
class ShortConv(nn.Module):
"""`out(C * conv(B * x))`; HF's `nn.Conv1d` holds the taps, `causal_conv` runs them."""
def __init__(self, cfg):
super().__init__()
dim, taps = cfg.hidden_size, cfg.conv_L_cache
self.conv = nn.Conv1d(dim, dim, taps, groups=dim, bias=cfg.conv_bias, padding=taps - 1)
self.in_proj = nn.Linear(dim, 3 * dim, bias=cfg.conv_bias)
self.out_proj = nn.Linear(dim, dim, bias=cfg.conv_bias)
def forward(self, x: torch.Tensor, pos: torch.Tensor, tree: Tree | None) -> torch.Tensor:
b, c, u = self.in_proj(x).transpose(1, 2).chunk(3, dim=1)
z = causal_conv(b * u, self.conv.weight, tree)
if self.conv.bias is not None:
z = z + self.conv.bias[:, None]
return self.out_proj((c * z).transpose(1, 2))
class MLP(nn.Module):
def __init__(self, cfg):
super().__init__()
hidden = cfg.intermediate_size
if cfg.block_auto_adjust_ff_dim: # HF's sizing rule, kept exactly
hidden = int(2 * hidden / 3)
if cfg.block_ffn_dim_multiplier is not None:
hidden = int(cfg.block_ffn_dim_multiplier * hidden)
hidden = cfg.block_multiple_of * ((hidden + cfg.block_multiple_of - 1) // cfg.block_multiple_of)
self.w1 = nn.Linear(cfg.hidden_size, hidden, bias=False)
self.w3 = nn.Linear(cfg.hidden_size, hidden, bias=False)
self.w2 = nn.Linear(hidden, cfg.hidden_size, bias=False)
def forward(self, x: torch.Tensor) -> torch.Tensor:
return self.w2(F.silu(self.w1(x)) * self.w3(x))
def language_model(cfg) -> LanguageModel:
return LanguageModel(cfg, lambda kind: ShortConv(cfg) if kind == "conv" else Attention(cfg),
lambda: MLP(cfg), cfg.norm_eps)
class Lfm2VlForConditionalGeneration(HfLfm2Vl):
"""HF's LFM2-VL with the hybrid language model, under HF's name so a saved
checkpoint reads as HF's."""
def __init__(self, config: Lfm2VlConfig):
super().__init__(config)
self.model.language_model = language_model(config.text_config)
def answer(self, trunk: torch.Tensor, questions: torch.Tensor, lengths: torch.Tensor, **vision) -> torch.Tensor:
"""Logits at the last token of every question, the state (and its image)
read once: `trunk` `(1, P)` ids, `questions` their ids back to back."""
embeds = self.get_input_embeddings()(trunk)
if vision:
features = torch.cat(self.model.get_image_features(**vision).pooler_output).to(embeds.dtype)
slots = self.model.get_placeholder_mask(trunk, inputs_embeds=embeds, image_features=features)
embeds = embeds.masked_scatter(slots, features)
return self.lm_head(self.model.language_model.answer(embeds, questions, lengths))
class Lfm2ForCausalLM(HfLfm2):
"""HF's LFM2 with the hybrid language model, under HF's name."""
def __init__(self, config: Lfm2Config):
super().__init__(config)
self.model = language_model(config)
def answer(self, trunk: torch.Tensor, questions: torch.Tensor, lengths: torch.Tensor) -> torch.Tensor:
return self.lm_head(self.model.answer(self.model.embed_tokens(trunk), questions, lengths))
|