VipLlava

概述

VipLlava 模型由 Mu Cai、Haotian Liu、Siva Karthik Mustikovela、Gregory P. Meyer、Yuning Chai、Dennis Park 和 Yong Jae Lee 在《让大型多模态模型理解任意视觉提示》一文中提出。

VipLlava 通过在训练过程中标记图像并使用“红色边界框”或“指向箭头”等自然线索与模型交互来增强 Llava 的训练协议。

论文摘要如下：

虽然现有的视觉-语言多模态大模型专注于对整幅图像的理解，但在实现区域特定理解方面存在显著差距。目前使用文本坐标或空间编码的方法往往无法提供用户友好的视觉提示界面。为解决这一挑战，我们引入了一种新型的多模态模型，能够解码任意视觉提示。这使得用户可以直观地标记图像，并使用“红色边界框”或“指向箭头”等自然线索与模型交互。我们简单的设计直接将视觉标记叠加到 RGB 图像上，无需复杂的区域编码，却在 Visual7W、PointQA 和 Visual Commonsense Reasoning 基准等区域理解任务上取得了最先进的性能。此外，我们还提出了 ViP-Bench，这是一个全面的基准，用于评估模型在多个维度上理解视觉提示的能力，从而推动该领域未来的研究。代码、数据和模型均已公开。

原始代码可在此处找到：这里。

此模型由 Younes Belkada 贡献。

使用技巧：

该架构类似于Llava架构，不同之处在于多模态投影器接受一组连接的视觉隐藏状态，并且在该模块上有一个额外的层范数层。
我们建议用户在计算批生成时使用 padding_side="left"，因为它能带来更准确的结果。只需确保在生成前调用 processor.tokenizer.padding_side = "left"。
请注意，该模型尚未明确训练以在同一提示中处理多张图像，尽管这在技术上是可能的，但您可能会遇到不准确的结果。

[!NOTE] v4.46 版本之后发布的 LLaVA 模型将发出关于添加 `processor.patch_size = {{patch_size}}`、`processor.num_additional_image_tokens = {{num_additional_image_tokens}}` 和 `processor.vision_feature_select_strategy = {{vision_feature_select_strategy}}` 的警告。强烈建议如果您拥有模型检查点，则将这些属性添加到处理器中；如果不是您拥有的，则打开 PR。添加这些属性意味着 LLaVA 将尝试推断每张图像所需的图像标记数量，并用与标记数量相同数量的 `` 占位符扩展文本。通常每张图像大约 500 个标记，因此请确保文本未被截断，否则在合并嵌入时会出现故障。这些属性可以从模型配置中获取，例如 `model.config.vision_config.patch_size` 或 `model.config.vision_feature_select_strategy`。如果视觉主干添加了 CLS 标记，则 `num_additional_image_tokens` 应为 `1`；如果未向视觉补丁添加任何额外内容，则应为 `0`。

为了获得更好的结果，我们建议用户使用处理器的 `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

< 来源 >

( vision_config = None text_config = None 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 中的任何一个。
image_token_index (int, 可选, 默认为 32000) — 用于编码图像提示的图像 token 索引。
projector_hidden_act (str, 可选, 默认为 "gelu") — 多模态投影器使用的激活函数。
projector_layernorm_eps (float, 可选, 默认为 1e-05) — 投影器层范数的层范数 epsilon
vision_feature_layers (Union[int, list[int]], 可选, 默认为 [-2, -5, -8, -11, 6]) — 视觉特征层，或从中选择视觉特征的层索引列表。
image_seq_length (int, 可选, 默认为 576) — 单个图像嵌入的序列长度。

这是用于存储 VipLlavaForConditionalGeneration 配置的配置类。它用于根据指定的参数实例化 VipLlava 模型，定义模型架构。使用默认值实例化配置将生成与 VipLlava-9B 类似的配置。

例如 ybelkada/vip-llava-7b-hf

配置对象继承自 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.config

VipLlava模型

class transformers.VipLlavaModel

< 来源 >

( config: VipLlavaConfig )

参数

配置 (VipLlavaConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化并不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法以加载模型权重。

VipLlava 模型由视觉骨干和语言模型组成，不带语言建模头。

此模型继承自 PreTrainedModel。请查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。

此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并参考 PyTorch 文档以了解所有与一般用法和行为相关的事项。

前向传播

< 来源 >

( input_ids: LongTensor = None pixel_values: FloatTensor = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[list[torch.FloatTensor]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None vision_feature_layers: typing.Union[int, list[int], NoneType] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None **lm_kwargs ) → transformers.models.vipllava.modeling_vipllava.VipLlavaModelOutputWithPast 或 tuple(torch.FloatTensor)

参数

input_ids (形状为 (batch_size, sequence_length) 的 torch.LongTensor) — 词汇表中输入序列 token 的索引。默认情况下将忽略填充。

可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什么是输入 ID？
pixel_values (形状为 (batch_size, num_channels, image_size, image_size) 的 torch.FloatTensor) — 对应于输入图像的张量。像素值可以使用 {image_processor_class} 获得。有关详细信息，请参见 {image_processor_class}.__call__（{processor_class} 使用 {image_processor_class} 处理图像）。
attention_mask (形状为 (batch_size, sequence_length) 的 torch.Tensor, 可选) — 避免对填充 token 索引执行注意力操作的掩码。在 [0, 1] 中选择的掩码值：
- 1 表示未被掩码的 token，
- 0 表示被掩码的 token。
什么是注意力掩码？
position_ids (形状为 (batch_size, sequence_length) 的 torch.LongTensor, 可选) — 每个输入序列 token 在位置嵌入中的位置索引。选择范围为 [0, config.n_positions - 1]。

什么是位置 ID？
past_key_values (list[torch.FloatTensor], 可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加快序列解码。这通常包括模型在解码上一阶段返回的 past_key_values，当 use_cache=True 或 config.use_cache=True 时。

允许两种格式：
- Cache 实例，请参见我们的 kv 缓存指南；
- 长度为 config.n_layers 的 tuple(torch.FloatTensor) 元组，每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量）。这也被称为旧版缓存格式。
模型将输出与作为输入提供给它的缓存相同的缓存格式。如果没有传入 past_key_values，将返回旧版缓存格式。

如果使用 past_key_values，用户可以选择只输入最后 input_ids（那些没有将其过去键值状态提供给此模型的）的形状 (batch_size, 1)，而不是所有 input_ids 的形状 (batch_size, sequence_length)。
inputs_embeds (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor, 可选) — 另外，除了传递 input_ids 之外，您还可以选择直接传递嵌入表示。如果您希望对如何将 input_ids 索引转换为相关向量拥有比模型内部嵌入查找矩阵更多的控制，这会很有用。
vision_feature_layers (Union[int, list[int]], 可选) — 视觉特征层，或选择视觉特征的层索引列表。
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 (形状为 (sequence_length) 的 torch.LongTensor, 可选) — 表示输入序列 token 在序列中位置的索引。与 position_ids 不同，此张量不受填充影响。它用于在正确位置更新缓存并推断完整的序列长度。

transformers.models.vipllava.modeling_vipllava.VipLlavaModelOutputWithPast 或 tuple(torch.FloatTensor)

一个 transformers.models.vipllava.modeling_vipllava.VipLlavaModelOutputWithPast 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置（VipLlavaConfig）和输入的不同元素。

last_hidden_state (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor, 可选) — 模型最后一层输出的隐藏状态序列。
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。模型由视觉编码器生成并投影最后一个隐藏状态后的 image_hidden_states。

VipLlavaModel 前向方法，覆盖了 __call__ 特殊方法。

尽管前向传播的配方需要在此函数中定义，但之后应该调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则会默默地忽略它们。

get_image_features

< 来源 >

( pixel_values: FloatTensor vision_feature_layers: typing.Union[int, list[int], NoneType] = None ) → image_features (torch.Tensor)

参数

pixel_values (形状为 (batch_size, channels, height, width) 的 torch.FloatTensor]) — 对应于输入图像的张量。
vision_feature_layers (Union[int, list[int]]) — 视觉特征层，或选择视觉特征的层索引列表。

图像特征 (torch.Tensor)

形状为 (num_images, image_length, embed_dim) 的图像特征张量。

从视觉塔获取图像最后隐藏状态并应用多模态投影。

VipLlavaForConditionalGeneration

class transformers.VipLlavaForConditionalGeneration

< 来源 >

( config: VipLlavaConfig )

参数

config (VipLlavaConfig) — 模型的配置类，包含模型的所有参数。使用配置文件初始化并不会加载与模型相关的权重，只加载配置。请查阅 from_pretrained() 方法以加载模型权重。

VIPLLAVA 模型，由视觉骨干网络和语言模型组成。

此模型继承自 PreTrainedModel。请查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。

此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并参考 PyTorch 文档以了解所有与一般用法和行为相关的事项。

前向传播

< 来源 >

( input_ids: LongTensor = None pixel_values: FloatTensor = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[list[torch.FloatTensor]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None vision_feature_layers: typing.Union[int, list[int], NoneType] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None logits_to_keep: typing.Union[int, torch.Tensor] = 0 **lm_kwargs ) → transformers.models.vipllava.modeling_vipllava.VipLlavaCausalLMOutputWithPast 或 tuple(torch.FloatTensor)

参数

input_ids (形状为 (batch_size, sequence_length) 的 torch.LongTensor) — 词汇表中输入序列 token 的索引。默认情况下会忽略填充。

索引可以通过 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什么是 input IDs？
pixel_values (形状为 (batch_size, num_channels, image_size, image_size) 的 torch.FloatTensor) — 对应于输入图像的张量。像素值可以通过 {image_processor_class} 获取。详情请参阅 {image_processor_class}.__call__（{processor_class} 使用 {image_processor_class} 处理图像）。
attention_mask (形状为 (batch_size, sequence_length) 的 torch.Tensor, 可选) — 避免对填充 token 索引执行注意力操作的掩码。掩码值选择在 [0, 1] 之间：
- 1 表示未被掩盖的 token，
- 0 表示被掩盖的 token。
什么是注意力掩码？
position_ids (形状为 (batch_size, sequence_length) 的 torch.LongTensor, 可选) — 每个输入序列 token 在位置嵌入中的位置索引。选择范围为 [0, config.n_positions - 1]。

什么是位置 ID？
past_key_values (list[torch.FloatTensor], 可选) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括模型在先前解码阶段返回的 past_key_values，当 use_cache=True 或 config.use_cache=True 时。

允许两种格式：
- Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为 config.n_layers 的 tuple(torch.FloatTensor) 元组，每个元组包含两个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量）。这也称为旧版缓存格式。
模型将输出与作为输入提供的缓存格式相同的缓存格式。如果未传递 past_key_values，将返回旧版缓存格式。

如果使用 past_key_values，用户可以选择只输入形状为 (batch_size, 1) 的最新 input_ids（那些没有将其过去键值状态提供给此模型的），而不是形状为 (batch_size, sequence_length) 的所有 input_ids。
inputs_embeds (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor, 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望对如何将 input_ids 索引转换为关联向量（而不是模型的内部嵌入查找矩阵）有更多控制，这会很有用。
vision_feature_layers (Union[int, list[int]], 可选) — 视觉特征层，或选择视觉特征的层索引列表。
labels (形状为 (batch_size, sequence_length) 的 torch.LongTensor, 可选) — 用于计算掩码语言建模损失的标签。索引应在 [0, ..., config.vocab_size] 或 -100 之间（参见 input_ids 文档字符串）。索引设置为 -100 的 token 将被忽略（掩码），损失仅针对标签在 [0, ..., config.vocab_size] 之间的 token 进行计算。
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 (形状为 (sequence_length) 的 torch.LongTensor, 可选) — 描述输入序列 token 在序列中位置的索引。与 position_ids 不同，此张量不受填充影响。它用于在正确位置更新缓存并推断完整的序列长度。
logits_to_keep (Union[int, torch.Tensor], 默认为 0) — 如果是 int，则计算最后 logits_to_keep 个 token 的 logits。如果为 0，则计算所有 input_ids 的 logits（特殊情况）。生成时只需要最后一个 token 的 logits，只计算该 token 可以节省内存，这对于长序列或大词汇量来说非常显著。如果是 torch.Tensor，则必须是 1D，对应于序列长度维度中要保留的索引。这在使用打包张量格式（批次和序列长度为单维度）时很有用。

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 时返回) — 语言建模损失（用于下一个 token 预测）。
logits (形状为 (batch_size, sequence_length, config.vocab_size) 的 torch.FloatTensor) — 语言建模头部的预测分数（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 时返回) — 形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元组（一个用于嵌入层的输出（如果模型有嵌入层），加上每个层的输出）。

模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (tuple[torch.FloatTensor], 可选, 当传递 output_attentions=True 或 config.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元组（每个层一个）。

注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
image_hidden_states (torch.FloatTensor, 可选) — 大小为 (batch_size, num_images, sequence_length, hidden_size) 的 torch.FloatTensor。模型由视觉编码器生成并投影最后一个隐藏状态后的 image_hidden_states。

VipLlavaForConditionalGeneration 的 forward 方法，重写了 __call__ 特殊方法。

示例

>>> 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

< > 在 GitHub 上更新

Transformers

VipLlava

概述

使用技巧：

VipLlavaConfig

class transformers.VipLlavaConfig

VipLlava模型

class transformers.VipLlavaModel

前向传播

get_image_features

VipLlavaForConditionalGeneration

class transformers.VipLlavaForConditionalGeneration

前向传播