Transformers 文档

LLaVa

Hugging Face's logo
加入Hugging Face社区

并获得增强文档体验

开始使用

LLaVa

概述

LLaVa 是一款开源聊天机器人,通过在 GPT 生成的多模态指令遵循数据上微调 LlamA/Vicuna 进行训练。它是一个基于 Transformer 架构的自回归语言模型。换句话说,它是针对聊天/指令进行微调的大语言模型 (LLM) 的多模态版本。

LLaVa 模型在 Haotian Liu、Chunyuan Li、Yuheng Li 和 Yong Jae Lee 的论文 视觉指令调优 中提出,并在 使用视觉指令调优改进基线 中得到改进。

论文摘要如下:

大型多模态模型 (LMM) 最近在视觉指令调优方面取得了令人鼓舞的进展。在本篇笔记中,我们展示了 LLaVA 中的全连接视觉-语言跨模态连接器具有惊人的强大性和数据效率。通过对 LLaVA 进行简单的修改,即使用带有 MLP 投影的 CLIP-ViT-L-336px 并在具有简单响应格式提示的学术任务导向 VQA 数据上进行添加,我们建立了更强的基线,在 11 个基准测试中实现了最先进的性能。我们的最终 13B 检查点仅使用了 120 万个公开可用的数据,并且在单个 8-A100 节点上完成完整训练大约需要 1 天。我们希望这能够使最先进的 LMM 研究更容易获得。代码和模型将公开发布。

绘图 LLaVa 架构。摘自 原始论文。

该模型由 ArthurZybelkada 贡献。原始代码可以在这里找到 这里

使用技巧

  • 我们建议用户在计算批量生成时使用 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/llava-1.5-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)
>>> "USER: <image>\n<What’s shown in this image? ASSISTANT: This image shows a red stop sign.</s>USER: Describe the image in more details. ASSISTANT:"
  • 如果您想自己构建聊天提示,以下是每个 llava 检查点接受的提示格式列表

llava-interleave 模型 需要以下格式

"<|im_start|>user <image>\nWhat is shown in this image?<|im_end|><|im_start|>assistant"

对于多轮对话

"<|im_start|>user <image>\n<prompt1><|im_end|><|im_start|>assistant <answer1><|im_end|><|im_start|>user <image>\n<prompt1><|im_end|><|im_start|>assistant "

llava-1.5 模型 需要以下格式

"USER: <image>\n<prompt> ASSISTANT:"

对于多轮对话

"USER: <image>\n<prompt1> ASSISTANT: <answer1></s>USER: <prompt2> ASSISTANT: <answer2></s>USER: <prompt3> ASSISTANT:"

使用 Flash Attention 2

Flash Attention 2 是先前优化的更快、更优化的版本,请参考 性能文档中 Flash Attention 2 部分

资源

一系列官方 Hugging Face 和社区(以 🌎 表示)资源,可帮助您开始使用 BEiT。

图像到文本
  • 一个关于如何在免费层级的 Google Colab 实例上运行 Llava 的 Google Colab 演示,利用 4 位推理。
  • 一个展示批量推理的 类似笔记本。🌎

LlavaConfig

transformers.LlavaConfig

< >

( vision_config = None text_config = None ignore_index = -100 image_token_index = 32000 projector_hidden_act = 'gelu' vision_feature_select_strategy = 'default' vision_feature_layer = -2 image_seq_length = 576 **kwargs )

参数

  • vision_config (Union[AutoConfig, dict], 可选,默认为 CLIPVisionConfig) — 视觉主干的配置对象或字典。
  • text_config (Union[AutoConfig, dict], 可选,默认为 LlamaConfig) — 文本主干的配置对象或字典。
  • ignore_index (int可选,默认为 -100) — 损失函数的忽略索引。
  • image_token_index (int可选,默认为 32000) — 用于编码图像提示的图像 token 索引。
  • projector_hidden_act (str可选,默认为 "gelu") — 多模态投影仪使用的激活函数。
  • vision_feature_select_strategy (str可选,默认为 "default") — 用于从视觉主干中选择视觉特征的特征选择策略。可以是 "default""full" 之一。
  • vision_feature_layer (int可选,默认为 -2) — 用于选择视觉特征的层的索引。
  • image_seq_length (int可选,默认为 576) — 一个图像嵌入的序列长度。

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

例如 llava-hf/llava-9b

配置对象继承自 PretrainedConfig,可用于控制模型输出。阅读 PretrainedConfig 的文档以获取更多信息。

示例

>>> from transformers import LlavaForConditionalGeneration, LlavaConfig, CLIPVisionConfig, LlamaConfig

>>> # Initializing a CLIP-vision config
>>> vision_config = CLIPVisionConfig()

>>> # Initializing a Llama config
>>> text_config = LlamaConfig()

>>> # Initializing a Llava llava-1.5-7b style configuration
>>> configuration = LlavaConfig(vision_config, text_config)

>>> # Initializing a model from the llava-1.5-7b style configuration
>>> model = LlavaForConditionalGeneration(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

LlavaProcessor

transformers.LlavaProcessor

< >

( image_processor = None tokenizer = None patch_size = None vision_feature_select_strategy = None chat_template = None image_token = '<image>' **kwargs )

参数

  • image_processor (CLIPImageProcessor可选) — 图像处理器是必需的输入。
  • patch_size (int可选) — 来自视觉塔的补丁大小。
  • vision_feature_select_strategy (str可选) — 用于从视觉主干中选择视觉特征的特征选择策略。应与模型的配置相同
  • chat_template (str可选) — 将用于将聊天中的消息列表转换为可标记字符串的 Jinja 模板。
  • image_token (str可选,默认为 "<image>") — 用于表示图像位置的特殊标记。

构建一个 Llava 处理器,它将 Llava 图像处理器和 Llava 分词器包装到单个处理器中。

LlavaProcessor 提供了 CLIPImageProcessorLlamaTokenizerFast 的所有功能。有关更多信息,请参阅 __call__()decode()

batch_decode

< >

( *args **kwargs )

此方法将其所有参数转发到 LlamaTokenizerFast 的 batch_decode()。有关更多信息,请参阅此方法的文档字符串。

decode

< >

( *args **kwargs )

此方法将其所有参数转发到 LlamaTokenizerFast 的 decode()。有关更多信息,请参阅此方法的文档字符串。

LlavaForConditionalGeneration

transformers.LlavaForConditionalGeneration

< >

( config: LlavaConfig )

参数

  • config (LlavaConfigLlavaVisionConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,只会加载配置。查看 from_pretrained() 方法以加载模型权重。

由视觉主干和语言模型组成的 LLAVA 模型。此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入的大小、修剪 head 等)。

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

forward

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。默认情况下,如果您提供填充,填充将被忽略。

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

    什么是输入 ID?

  • 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)。

    如果您想更改填充行为,您应该阅读 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=Trueconfig.use_cache=True 时返回) — 长度为 config.n_layerstuple(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)

  • inputs_embeds (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size), 可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递 input_ids。如果您希望对如何将 input_ids 索引转换为关联向量进行更多控制,而不是模型的内部嵌入查找矩阵,这将很有用。
  • vision_feature_layer (int, 可选, 默认为 -2) — 用于选择视觉特征的层的索引。
  • vision_feature_select_strategy (str, 可选, 默认为 "default") — 用于从视觉主干中选择视觉特征的特征选择策略。可以是 "default""full" 之一。
  • 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,并且仅为该标记计算它们可以节省内存,对于长序列或大词汇量大小,这将变得非常重要。

返回

transformers.models.llava.modeling_llava.LlavaCausalLMOutputWithPasttuple(torch.FloatTensor)

一个 transformers.models.llava.modeling_llava.LlavaCausalLMOutputWithPasttorch.FloatTensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含根据配置 (LlavaConfig) 和输入而变化的各种元素。

  • 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_layerstuple(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 以及投影最后一个隐藏状态后的结果。

LlavaForConditionalGeneration 前向方法,覆盖了 __call__ 特殊方法。

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

示例

>>> from PIL import Image
>>> import requests
>>> from transformers import AutoProcessor, LlavaForConditionalGeneration

>>> model = LlavaForConditionalGeneration.from_pretrained("llava-hf/llava-1.5-7b-hf")
>>> processor = AutoProcessor.from_pretrained("llava-hf/llava-1.5-7b-hf")

>>> prompt = "USER: <image>\nWhat's the content of the image? ASSISTANT:"
>>> url = "https://www.ilankelman.org/stopsigns/australia.jpg"
>>> image = Image.open(requests.get(url, stream=True).raw)

>>> inputs = processor(images=image, text=prompt, return_tensors="pt")

>>> # Generate
>>> generate_ids = model.generate(**inputs, max_new_tokens=15)
>>> processor.batch_decode(generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
"USER:  \nWhat's the content of the image? ASSISTANT: The image features a busy city street with a stop sign prominently displayed"
< > 在 GitHub 上更新