VipLlava
概述
VipLlava 模型由 Mu Cai、Haotian Liu、Siva Karthik Mustikovela、Gregory P. Meyer、Yuning Chai、Dennis Park 和 Yong Jae Lee 在 Making Large Multimodal Models Understand Arbitrary Visual Prompts 中提出。
VipLlava 通过标记图像并在训练期间使用“红色边框”或“指向箭头”等自然提示与模型进行交互来增强 Llava 的训练协议。
论文的摘要如下：
虽然现有的大型视觉语言多模态模型侧重于对整个图像的理解，但在实现特定区域的理解方面存在显著差距。目前使用文本坐标或空间编码的方法通常无法为视觉提示提供用户友好的界面。为了解决这一挑战，我们引入了一种能够解码任意视觉提示的新型多模态模型。这允许用户直观地标记图像，并使用诸如“红色边框”或“指向箭头”之类的自然提示与模型进行交互。我们的简单设计直接将视觉标记叠加在 RGB 图像上，无需复杂的区域编码，但在诸如 Visual7W、PointQA 和 Visual Commonsense Reasoning 基准测试等区域理解任务中取得了最先进的性能。此外，我们还推出了 ViP-Bench，这是一个全面的基准测试，用于评估模型在跨多个维度理解视觉提示方面的能力，从而推动该领域未来的研究。代码、数据和模型已公开发布。
原始代码可在 此处 找到。
该模型由 Younes Belkada 贡献。
使用技巧：
该架构与 llava 架构类似，只是多模态投影仪接收一组连接的视觉隐藏状态，并且在该模块上额外增加了一个层归一化层。
我们建议用户在计算批次生成时使用
padding_side="left"，因为它会导致更准确的结果。只需确保在生成之前调用processor.tokenizer.padding_side = "left"即可。请注意，该模型尚未经过明确训练来处理同一提示中的多个图像，虽然从技术上讲这可能，但您可能会遇到不准确的结果。
为了获得更好的结果，我们建议用户使用处理器的
apply_chat_template()方法来正确格式化您的提示。为此，您需要构建一个对话历史记录，传入一个普通字符串将无法格式化您的提示。对话历史记录中的每个消息对于聊天模板来说都是一个具有键“role”和“content”的字典。“content”应该是一个字典列表，用于“text”和“image”模态，如下所示：
from transformers import AutoProcessor
processor = AutoProcessor.from_pretrained("llava-hf/vip-llava-7b-hf")
conversation = [
{
"role": "user",
"content": [
{"type": "image"},
{"type": "text", "text": "What’s shown in this image?"},
,
},
{
"role": "assistant",
"content": [{"type": "text", "text": "This image shows a red stop sign."},]
},
{
"role": "user",
"content": [
{"type": "text", "text": "Describe the image in more details."},
],
},
]
text_prompt = processor.apply_chat_template(conversation, add_generation_prompt=True)
# Note that the template simply formats your prompt, you still have to tokenize it and obtain pixel values for your images
print(text_prompt)
>>> "###Human: <image>\nWhat’s shown in this image?###Assistant: This image shows a red stop sign.###Human: Describe the image in more details.###Assistant:"- 如果您想自己构建一个聊天提示，以下列出了 VipLLaVa 检查点接受的提示格式
A chat between a curious human and an artificial intelligence assistant. The assistant gives helpful, detailed, and polite answers to the human's questions.###Human: <image>\n<prompt>###Assistant:对于多轮对话
A chat between a curious human and an artificial intelligence assistant. The assistant gives helpful, detailed, and polite answers to the human's questions.###Human: <image>\n<prompt1>###Assistant: <answer1>###Human: <prompt2>###Assistant:VipLlavaConfig
class transformers.VipLlavaConfig
< source >( vision_config = None text_config = None ignore_index = -100 image_token_index = 32000 projector_hidden_act = 'gelu' projector_layernorm_eps = 1e-05 vision_feature_layers = [-2, -5, -8, -11, 6] image_seq_length = 576 **kwargs )
参数
- vision_config (
VipLlavaVisionConfig, 可选) — 自定义视觉配置或字典 - text_config (
Union[AutoConfig, dict], 可选) — 文本主干的配置对象。可以是LlamaConfig或MistralConfig中的任何一个。 - ignore_index (
int, 可选, 默认值 -100) — 损失函数的忽略索引。 - image_token_index (
int, 可选, 默认值 32000) — 用于编码图像提示的图像 token 索引。 - projector_hidden_act (
str, 可选, 默认值"gelu") — 多模态投影仪使用的激活函数。 - projector_layernorm_eps (
float, 可选, 默认值为 1e-05) — 投影层归一化层的层归一化 epsilon - vision_feature_layers (
List[int], 可选, 默认值为[-2, -5, -8, -11, 6]) — 用于选择视觉特征的层列表。 - image_seq_length (
int, 可选, 默认值为 576) — 单个图像嵌入的序列长度。
这是用于存储 VipLlavaForConditionalGeneration 配置的配置类。它用于根据指定的参数实例化 VipLlava 模型，定义模型架构。使用默认值实例化配置将产生与 VipLlava-9B 类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。阅读 PretrainedConfig 的文档以了解更多信息。
示例
>>> from transformers import VipLlavaForConditionalGeneration, VipLlavaConfig, CLIPVisionConfig, LlamaConfig
>>> # Initializing a CLIP-vision config
>>> vision_config = CLIPVisionConfig()
>>> # Initializing a Llama config
>>> text_config = LlamaConfig()
>>> # Initializing a VipLlava vipllava-7b style configuration
>>> configuration = VipLlavaConfig(vision_config, text_config)
>>> # Initializing a model from the vipllava-7b style configuration
>>> model = VipLlavaForConditionalGeneration(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configVipLlavaForConditionalGeneration
class transformers.VipLlavaForConditionalGeneration
< 源代码 >( config: VipLlavaConfig )
参数
- config (VipLlavaConfig 或
VipLlavaVisionConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
VIPLLAVA 模型，包含视觉主干和语言模型。此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解与一般用法和行为相关的所有事宜。
forward
< 源代码 >( input_ids: LongTensor = None pixel_values: FloatTensor = None attention_mask: Optional = None position_ids: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None vision_feature_layers: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None cache_position: Optional = None num_logits_to_keep: int = 0 ) → transformers.models.vipllava.modeling_vipllava.VipLlavaCausalLMOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供填充，默认情况下将忽略填充。索引可以使用 AutoTokenizer 获取。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- pixel_values (
torch.FloatTensor形状为(batch_size, num_channels, image_size, image_size)) -- 与输入图像相对应的张量。可以使用 [AutoImageProcessor](/docs/transformers/v4.45.2/en/model_doc/auto#transformers.AutoImageProcessor) 获取像素值。有关详细信息，请参见 [CLIPImageProcessor.__call__()](/docs/transformers/v4.45.2/en/model_doc/videomae#transformers.VideoMAEFeatureExtractor.__call__) ([]LlavaProcessor`] 使用 CLIPImageProcessor 处理图像)。 - attention_mask (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 掩码，用于避免对填充标记索引执行注意力。在[0, 1]中选择掩码值：- 1 表示未掩码的标记，
- 0 表示掩码的标记。
索引可以使用 AutoTokenizer 获取。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
如果使用
past_key_values，则可以选择仅输入最后一个decoder_input_ids（见past_key_values），而不是所有decoder_input_ids（形状为(batch_size, sequence_length)）。如果您想更改填充行为，您应该阅读
modeling_opt._prepare_decoder_attention_mask并修改为您的需求。有关默认策略的更多信息，请参见 论文 中的图 1。- 1 表示头未掩码，
- 0 表示头掩码。
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 每个输入序列标记在位置嵌入中的位置索引。在[0, config.n_positions - 1]范围内选择。 什么是位置 ID？ - past_key_values (
tuple(tuple(torch.FloatTensor)), 可选，在传递use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的tuple(torch.FloatTensor)元组，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)) 的张量和 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的附加张量。包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。如果使用
past_key_values，用户可以选择仅输入最后一个decoder_input_ids（形状为(batch_size, 1)，而不是所有decoder_input_ids（形状为(batch_size, sequence_length)），这些decoder_input_ids的过去键值状态没有提供给此模型。 - inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想对如何将input_ids索引转换为关联的向量（而不是模型的内部嵌入查找矩阵）有更多控制权，这将很有用。 - use_cache (
bool, 可选) — 如果设置为True，将返回past_key_values键值状态，可用于加速解码（参见past_key_values）。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参见返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参见返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。 - cache_position (
torch.LongTensor形状为(sequence_length), 可选) — 表示输入序列令牌在序列中的位置的索引。与position_ids相反，此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。参数 — labels (
torch.LongTensor形状为(batch_size, sequence_length), 可选): 用于计算掩码语言建模损失的标签。索引应为[0, ..., config.vocab_size]或 -100（参见input_ids文档字符串）。索引设置为-100的令牌被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]中的令牌计算。num_logits_to_keep (
int, 可选): 计算最后num_logits_to_keep个令牌的 logits。如果为0，则计算所有input_ids的 logits（特殊情况）。生成只需要最后一个令牌的 logits，仅为该令牌计算 logits 可以节省内存，对于长序列或大词汇量来说，这将非常重要。
返回
transformers.models.vipllava.modeling_vipllava.VipLlavaCausalLMOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.models.vipllava.modeling_vipllava.VipLlavaCausalLMOutputWithPast 或一个 torch.FloatTensor 的元组（如果传递 return_dict=False 或当 config.return_dict=False 时），包含取决于配置 (VipLlavaConfig) 和输入的各种元素。
-
loss (
torch.FloatTensor形状为(1,), 可选, 当提供labels时返回) — 语言建模损失（用于下一个令牌预测）。 -
logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（在 SoftMax 之前每个词汇表令牌的分数）。 -
past_key_values (
tuple(tuple(torch.FloatTensor)), 可选, 当传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的tuple(torch.FloatTensor)的元组，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。包含预先计算的隐藏状态（自注意力块中的键和值），可用于（参见
past_key_values输入）加快顺序解码速度。 -
hidden_states (
tuple(torch.FloatTensor), 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入的输出，如果模型具有嵌入层，加上每个层的输出）形状为(batch_size, sequence_length, hidden_size)。模型在每个层的输出处的隐藏状态，加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
-
image_hidden_states (
torch.FloatTensor, 可选) — 尺寸为 (batch_size, num_images, sequence_length, hidden_size) 的torch.FloatTensor。由视觉编码器生成的模型的图像隐藏状态，以及在投影最后一个隐藏状态之后。
The VipLlavaForConditionalGeneration forward 方法，覆盖了 __call__ 特殊方法。
虽然前向传递的配方需要在此函数中定义，但应随后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> import torch
>>> from PIL import Image
>>> import requests
>>> from transformers import AutoProcessor, VipLlavaForConditionalGeneration
>>> model = VipLlavaForConditionalGeneration.from_pretrained("llava-hf/vip-llava-7b-hf", device_map="auto", torch_dtype=torch.float16)
>>> processor = AutoProcessor.from_pretrained("llava-hf/vip-llava-7b-hf")
>>> prompt = "A chat between a curious human and an artificial intelligence assistant. The assistant gives helpful, detailed, and polite answers to the human's questions.###Human: <image>\n{}###Assistant:"
>>> question = "Can you please describe this image?"
>>> prompt = prompt.format(question)
>>> url = "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/diffusers/compel-neg.png"
>>> image = Image.open(requests.get(url, stream=True).raw)
>>> inputs = processor(text=text, images=image, return_tensors="pt").to(0, torch.float16)
>>> # Generate
>>> generate_ids = model.generate(**inputs, max_new_tokens=20)
>>> processor.decode(generate_ids[0][len(inputs["input_ids"][0]):], skip_special_tokens=True)
The image features a brown and white cat sitting on a green surface, with a red ball in its