Image-Text-to-Text
Transformers
Safetensors
English
dmllm
feature-extraction
multimodal
diffusion-language-model
dllm
vision-language-model
perception
conversational
custom_code
Instructions to use MSALab/PerceptionDLM-Base with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use MSALab/PerceptionDLM-Base with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("image-text-to-text", model="MSALab/PerceptionDLM-Base", 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)# Load model directly from transformers import AutoModel model = AutoModel.from_pretrained("MSALab/PerceptionDLM-Base", trust_remote_code=True, dtype="auto") - Notebooks
- Google Colab
- Kaggle
- Local Apps Settings
- vLLM
How to use MSALab/PerceptionDLM-Base with vLLM:
Install from pip and serve model
# Install vLLM from pip: pip install vllm # Start the vLLM server: vllm serve "MSALab/PerceptionDLM-Base" # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:8000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "MSALab/PerceptionDLM-Base", "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/MSALab/PerceptionDLM-Base
- SGLang
How to use MSALab/PerceptionDLM-Base 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 "MSALab/PerceptionDLM-Base" \ --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": "MSALab/PerceptionDLM-Base", "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 "MSALab/PerceptionDLM-Base" \ --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": "MSALab/PerceptionDLM-Base", "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 MSALab/PerceptionDLM-Base with Docker Model Runner:
docker model run hf.co/MSALab/PerceptionDLM-Base
File size: 21,150 Bytes
db8eff4 | 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 | from typing import Optional, List
import torch
from torch import nn
from torch.nn import functional as F
import transformers
from transformers import PreTrainedModel, AutoModel, AutoModelForCausalLM, GenerationConfig
from transformers import AutoConfig
from transformers.feature_extraction_utils import BatchFeature
from .configuration_dmllm import DMLLMConfig
from .modeling_abstractor import PerceiverProjection
from .modeling_llada import LLaDAModelLM
from .cache import *
from .configuration_llada import LLaDAConfig
def build_vision_model(config, model=None):
assert hasattr(config, "name_or_path")
if model is None:
model = AutoModel.from_pretrained(
config.name_or_path, config=config, trust_remote_code=True)
return model
def forward_process(bsz,seq_len,device, eps=1e-3):
b, l = bsz,seq_len
t = torch.rand(b, device=device)
# t = torch.sigmoid(t)
p_mask = (1 - eps) * t + eps
p_mask = p_mask[:, None]#.repeat(1, l)
masked_indices = torch.rand((b, l), device=device)
mask_cutoff = torch.max(p_mask,masked_indices.min(-1,keepdim=True).values)
masked_indices = masked_indices <= mask_cutoff
# mask at least one token
# 126336 is used for [MASK] token
#noisy_batch = torch.where(masked_indices, 126336, input_ids)
return masked_indices, p_mask
def forward_process_blocks(bsz, seq_len, device, block_length=8, eps=1e-3):
"""
Block-level forward diffusion process for SDAR-v2
Args:
bsz: batch size
seq_len: sequence length
device: torch device
block_length: length of each block
eps: minimum masking probability
Returns:
masked_indices: boolean tensor indicating which tokens to mask
p_mask: masking probabilities
"""
b, l = bsz, seq_len
t = torch.rand(b, device=device)
p_mask = (1 - eps) * t + eps
# Calculate number of blocks
num_blocks = (l + block_length - 1) // block_length
# Block-level masking probability
block_p_mask = p_mask[:, None].expand(b, num_blocks) # [batch, num_blocks]
# Decide which blocks to mask
block_mask_decisions = torch.rand(b, num_blocks, device=device) < block_p_mask
# Expand block decisions to token level
masked_indices = torch.zeros(b, l, device=device, dtype=torch.bool)
for i in range(num_blocks):
start_idx = i * block_length
end_idx = min((i + 1) * block_length, l)
# If block is selected for masking, mask all tokens in the block
masked_indices[:, start_idx:end_idx] = block_mask_decisions[:, i:i+1]
# Add some randomness within blocks (optional)
within_block_randomness = 0.2 # 20% chance to flip individual tokens
random_flip = torch.rand(b, l, device=device) < within_block_randomness
masked_indices = masked_indices ^ (random_flip & masked_indices)
return masked_indices, p_mask
def create_block_attention_mask(seq_len, block_length, device, batch_size=1):
"""
Create block diagonal attention mask for SDAR-v2
"""
num_blocks = (seq_len + block_length - 1) // block_length
# Create block-level lower triangular mask
block_mask = torch.tril(torch.ones(num_blocks, num_blocks, device=device, dtype=torch.bool))
# Expand to token level
token_mask = block_mask.repeat_interleave(block_length, dim=0)\
.repeat_interleave(block_length, dim=1)
# Crop to actual sequence length
token_mask = token_mask[:seq_len, :seq_len]
# Convert to 4D format [batch, 1, seq_len, seq_len]
attention_mask = token_mask.unsqueeze(0).unsqueeze(0).expand(batch_size, 1, -1, -1)
# Convert to additive mask format (0 for attend, -inf for mask)
attention_mask = torch.where(
attention_mask,
torch.zeros_like(attention_mask, dtype=torch.float),
torch.full_like(attention_mask, float('-inf'))
)
return attention_mask
class DMLLM(PreTrainedModel):
config_class = DMLLMConfig
supports_gradient_checkpointing = True
_skip_keys_device_placement = "past_key_values"
_supports_cache_class = False
_supports_flash_attn_2 = True
_supports_sdpa = True
accepts_loss_kwargs=False
def __init__(self,
config: DMLLMConfig,
language_model=None,
vision_model=None,
processor=None):
super().__init__(config)
self.image_size = config.image_size
self.patch_size = config.patch_size
self.downsample_ratio = config.downsample_ratio
self.num_image_token = config.num_image_token
self.vision_select_layer = config.vision_select_layer
self.replacement_noise_mode = config.replacement_noise_mode
try:
vision_hidden_states = self.config.vision_model_config.hidden_size
except:
vision_hidden_states = self.config.vision_model_config.vision_config.hidden_size
self.config.vision_model_config.hidden_size = vision_hidden_states
vision_model = build_vision_model(config.vision_model_config, vision_model)
vision_abstractor = PerceiverProjection(**config.vision_abstractor_config,
in_dim=self.config.vision_model_config.hidden_size * (int(1 / self.downsample_ratio) ** 2),
out_dim=self.config.language_model_config.hidden_size)
if language_model is None:
kwargs_ = {}
if config._attn_implementation_internal is not None:
kwargs_['attn_implementation'] = config._attn_implementation_internal
if 'llada' in config.language_model_config.name_or_path.lower():
with transformers.modeling_utils.no_init_weights():
language_model = LLaDAModelLM(config.language_model_config)
else:
raise ValueError(f"Unsupported language model: {config.language_model_config.name_or_path}")
self.vision_model = vision_model
self.vision_abstractor = vision_abstractor
self.language_model = language_model
def forward_vision(self, pixel_values):
# pixel_values: (n, c, h, w) or (b, tiles, c, h, w)
# Handle BatchFeature input
if isinstance(pixel_values, BatchFeature):
pixel_values = pixel_values["pixel_values"]
# Handle 5D input: (b, tiles, c, h, w) -> (b*tiles, c, h, w)
if pixel_values.dim() == 5:
b, tiles, c, h, w = pixel_values.shape
pixel_values = pixel_values.view(b * tiles, c, h, w)
# flags for dummy images (all-zero images)
image_flags = torch.sum(pixel_values, dim=(1, 2, 3)) != 0
image_flags = image_flags.long()
if image_flags.dim() > 1:
image_flags = image_flags.squeeze(-1)
# extract vision features
if self.vision_select_layer == -1:
image_embeddings = self.vision_model.vision_model(
pixel_values=pixel_values,
).last_hidden_state
else:
image_embeddings = self.vision_model.vision_model(
pixel_values=pixel_values, output_hidden_states=True
).hidden_states[self.vision_select_layer] # (B, N, C)
vit_embeds = image_embeddings[image_flags == 1]
if self.downsample_ratio != 1:
patch_num = self.image_size // self.patch_size
vit_embeds = vit_embeds.reshape(vit_embeds.shape[0], patch_num, patch_num, vit_embeds.shape[-1])
vit_embeds = self.pixel_shuffle(vit_embeds, scale_factor=self.downsample_ratio)
vit_embeds = vit_embeds.flatten(1, 2)
vit_embeds = self.vision_abstractor(vit_embeds)
return vit_embeds
def prepare_for_lm(self, input_ids, vision_embeds):
inputs_embeds = self.get_input_embeddings()(input_ids)
vision_embeds_ = vision_embeds
if vision_embeds is not None:
try:
vision_mask = input_ids == self.config.image_token_id
if torch.count_nonzero(vision_mask).item() != vision_embeds.shape[:-1].numel():
info = "vision embeddings mismatch input embeddings: " \
f"vision_mask shape={vision_mask.shape}; " \
f"vision_mask count={torch.count_nonzero(vision_mask)}; " \
f"vision_embeds shape={vision_embeds.shape}"
#print(info)
num_vision_1 = torch.count_nonzero(vision_mask).item()
num_vision_2 = vision_embeds.shape[:-1].numel()
vision_embeds = vision_embeds.contiguous()
if num_vision_1 <= num_vision_2:
vision_embeds = vision_embeds.view(-1, vision_embeds.size(-1))[:num_vision_1]
else:
vision_embeds = vision_embeds.view(-1, vision_embeds.size(-1))
less_nums = num_vision_1 - num_vision_2
vision_embeds = torch.cat([vision_embeds, vision_embeds[-less_nums:]], dim=0)
vision_embeds = vision_embeds.contiguous()
# assert torch.count_nonzero(vision_mask).item() == vision_embeds.shape[:-1].numel(), \
# "vision embeddings mismatch input embeddings: " \
# f"vision_mask shape={vision_mask.shape}; " \
# f"vision_mask count={torch.count_nonzero(vision_mask)}; " \
# f"vision_embeds shape={vision_embeds.shape}"
inputs_embeds = torch.masked_scatter(inputs_embeds, vision_mask.unsqueeze(-1),
vision_embeds.to(inputs_embeds.dtype).view(-1,
vision_embeds.size(-1)))
except:
inputs_embeds = inputs_embeds + torch.sum(vision_embeds_[0, 0, :]) * 0.0
return inputs_embeds
def pixel_shuffle(self, x, scale_factor=0.5):
x = x.contiguous()
n, w, h, c = x.size()
# N, W, H, C --> N, W, H * scale, C // scale
x = x.view(n, w, int(h * scale_factor), int(c / scale_factor))
# N, W, H * scale, C // scale --> N, H * scale, W, C // scale
x = x.permute(0, 2, 1, 3).contiguous()
# N, H * scale, W, C // scale --> N, H * scale, W * scale, C // (scale ** 2)
x = x.view(n, int(h * scale_factor), int(w * scale_factor),
int(c / (scale_factor * scale_factor)))
x = x.permute(0, 2, 1, 3).contiguous()
return x
def forward(self,
input_ids: torch.LongTensor = None,
attention_mask: Optional[torch.BoolTensor] = None,
position_ids: Optional[torch.LongTensor] = None,
pixel_values: Optional[torch.Tensor] = None,
past_key_values: Optional[List[torch.FloatTensor]] = None,
labels: Optional[torch.LongTensor] = None,
return_dict: bool = True,
**kwargs,
):
return_dict = return_dict if return_dict is not None else self.config.use_return_dict
# ========Get visual embedding========
if pixel_values is not None:
vision_embeds = self.forward_vision(pixel_values)
else:
vision_embeds = None
# print(f"input_ids.shape: {input_ids.shape}", {vision_embeds.shape})
inputs_embeds = self.prepare_for_lm(input_ids, vision_embeds)
# print(f"inputs_embeds.shape: {inputs_embeds.shape}")
p_mask = None
answer_length = None
if self.is_gradient_checkpointing and torch.is_grad_enabled():
inputs_embeds.requires_grad_(True)
# ========Forward into LM========
outputs = self.language_model(
input_ids=None,
inputs_embeds=inputs_embeds,
attention_mask=attention_mask,
position_ids=position_ids,
past_key_values=past_key_values,
return_dict=return_dict,
labels=labels,
use_cache=False,
conversation_ids=None,
replacement_noise_mode=self.replacement_noise_mode,
p_mask = p_mask,
answer_length = answer_length,
**kwargs,
)
return outputs
def gradient_checkpointing_enable(self, gradient_checkpointing_kwargs=None):
super().gradient_checkpointing_enable(gradient_checkpointing_kwargs)
self.language_model.enable_input_require_grads()
def get_input_embeddings(self):
return self.language_model.get_input_embeddings()
def set_input_embeddings(self, value):
self.language_model.set_input_embeddings(value)
def get_output_embeddings(self):
return self.language_model.get_output_embeddings()
def set_output_embeddings(self, new_embeddings):
self.language_model.set_output_embeddings(new_embeddings)
def set_decoder(self, decoder):
self.language_model.set_decoder(decoder)
def get_decoder(self):
return self.language_model.get_decoder()
def tie_weights(self):
return self.language_model.tie_weights()
@torch.no_grad()
def generate(
self,
pixel_values: Optional[torch.FloatTensor] = None,
input_ids: Optional[torch.FloatTensor] = None,
**generate_kwargs,
) -> torch.LongTensor:
if pixel_values is not None:
vision_embeds = self.forward_vision(pixel_values)
else:
vision_embeds = None
inputs_embeds = self.prepare_for_lm(input_ids, vision_embeds)
if 'llada' in self.config.language_model_config.name_or_path.lower():
outputs = self.language_model.generate_with_embeds(
inputs_embeds=inputs_embeds, **generate_kwargs
)
else:
raise NotImplementedError(f"Generation not implemented for model: {self.config.language_model_config.name_or_path}")
return outputs
@torch.no_grad()
def generate_replace_noise(
self,
pixel_values: Optional[torch.FloatTensor] = None,
input_ids: Optional[torch.FloatTensor] = None,
**generate_kwargs,
) -> torch.LongTensor:
if pixel_values is not None:
vision_embeds = self.forward_vision(pixel_values)
else:
vision_embeds = None
inputs_embeds = self.prepare_for_lm(input_ids, vision_embeds)
outputs, all_steps_response = self.language_model.generate_with_embeds_replace_noise(
inputs_embeds=inputs_embeds, **generate_kwargs
)
return outputs, all_steps_response
def get_template(self):
template = dict(
SYSTEM=("<|start_header_id|>system<|end_header_id|>\n{system}<|eot_id|>\n"),
INSTRUCTION=("<|start_header_id|>user<|end_header_id|>\n{input}<|eot_id|><|start_header_id|>assistant<|end_header_id|>\n"),
SUFFIX="<|eot_id|>",
SUFFIX_AS_EOS=True,
SEP="\n",
STOP_WORDS=["<|eot_id|>"],
)
return template
@torch.no_grad()
def chat(
self,
tokenizer,
pixel_values,
question,
generation_config,
history=None,
return_history=False,
num_patches_list=None,
IMG_START_TOKEN='<img>',
IMG_END_TOKEN='</img>',
IMG_CONTEXT_TOKEN='<IMG_CONTEXT>',
verbose=False
):
if history is None and pixel_values is not None and '<image>' not in question:
question = '<image>\n' + question
if num_patches_list is None:
num_patches_list = [pixel_values.shape[0]] if pixel_values is not None else []
assert pixel_values is None or len(pixel_values) == sum(num_patches_list)
img_context_token_id = tokenizer.convert_tokens_to_ids(IMG_CONTEXT_TOKEN)
self.img_context_token_id = img_context_token_id
template = self.get_template()
eos_token_id = tokenizer.convert_tokens_to_ids(template["SUFFIX"].strip())
history = "" if history is None else history
prompt = history
prompt = prompt + template["INSTRUCTION"].format(input=question)
if verbose and pixel_values is not None:
image_bs = pixel_values.shape[0]
print(f'dynamic ViT batch size: {image_bs}')
prompt = prompt[::-1]
for num_patches in num_patches_list[::-1]:
image_tokens = IMG_START_TOKEN + IMG_CONTEXT_TOKEN * self.num_image_token * num_patches + IMG_END_TOKEN
prompt = prompt.replace('<image>'[::-1], image_tokens[::-1], 1)
prompt = prompt[::-1]
model_inputs = tokenizer(prompt, return_tensors='pt')
device = torch.device(self.language_model.device if torch.cuda.is_available() else 'cpu')
input_ids = model_inputs['input_ids'].to(device)
attention_mask = model_inputs['attention_mask'].to(device)
generation_config['eos_token_id'] = eos_token_id
generation_output = self.generate(
pixel_values=pixel_values,
input_ids=input_ids,
**generation_config
)
# response = [
# tokenizer.decode(g[len(p) :].tolist())
# for p, g in zip(input_ids, generation_output)
# ][0]
#print("generation_output:", tokenizer.batch_decode(generation_output, skip_special_tokens=False)[0])
response = tokenizer.batch_decode(generation_output, skip_special_tokens=False)[0]
history = history + prompt + response
response = response.split(template["SUFFIX"].strip())[0].strip()
if return_history:
return response, history
else:
if verbose:
print(response)
return response
return
@torch.no_grad()
def chat_replace_noise(
self,
tokenizer,
pixel_values,
question,
generation_config,
history=None,
return_history=False,
num_patches_list=None,
IMG_START_TOKEN='<img>',
IMG_END_TOKEN='</img>',
IMG_CONTEXT_TOKEN='<IMG_CONTEXT>',
verbose=False
):
if history is None and pixel_values is not None and '<image>' not in question:
question = '<image>\n' + question
if num_patches_list is None:
num_patches_list = [pixel_values.shape[0]] if pixel_values is not None else []
assert pixel_values is None or len(pixel_values) == sum(num_patches_list)
img_context_token_id = tokenizer.convert_tokens_to_ids(IMG_CONTEXT_TOKEN)
self.img_context_token_id = img_context_token_id
template = self.get_template()
eos_token_id = tokenizer.convert_tokens_to_ids(template["SUFFIX"].strip())
history = "" if history is None else history
prompt = history
prompt = prompt + template["INSTRUCTION"].format(input=question)
if verbose and pixel_values is not None:
image_bs = pixel_values.shape[0]
print(f'dynamic ViT batch size: {image_bs}')
prompt = prompt[::-1]
for num_patches in num_patches_list[::-1]:
image_tokens = IMG_START_TOKEN + IMG_CONTEXT_TOKEN * self.num_image_token * num_patches + IMG_END_TOKEN
prompt = prompt.replace('<image>'[::-1], image_tokens[::-1], 1)
prompt = prompt[::-1]
model_inputs = tokenizer(prompt, return_tensors='pt')
device = torch.device(self.language_model.device if torch.cuda.is_available() else 'cpu')
input_ids = model_inputs['input_ids'].to(device)
attention_mask = model_inputs['attention_mask'].to(device)
generation_config['eos_token_id'] = eos_token_id
generation_output, all_steps_response = self.generate_replace_noise(
pixel_values=pixel_values,
input_ids=input_ids,
**generation_config
)
response = tokenizer.batch_decode(generation_output, skip_special_tokens=False)[0]
all_steps_response_ = []
for step_response in all_steps_response:
step_response = tokenizer.batch_decode(step_response, skip_special_tokens=False)[0]
all_steps_response_.append(step_response)
all_steps_response = all_steps_response_
for i, step_response in enumerate(all_steps_response):
print(f"Step {i}: {step_response}\n")
history = history + prompt + response
response = response.split(template["SUFFIX"].strip())[0].strip()
if return_history:
return response, history
else:
if verbose:
print(response)
return response
return
AutoConfig.register("dmllm", DMLLMConfig)
AutoModel.register(DMLLMConfig, DMLLM)
|