Transformers 文档

KOSMOS-2

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

KOSMOS-2

PyTorch

概述

KOSMOS-2 模型由 Zhiliang Peng, Wenhui Wang, Li Dong, Yaru Hao, Shaohan Huang, Shuming Ma, Furu Wei 在 Kosmos-2: Grounding Multimodal Large Language Models to the World 中提出。

KOSMOS-2 是一个基于 Transformer 的因果语言模型,使用接词预测任务在接地图像-文本对的网络规模数据集 GRIT 上进行训练。数据集中边界框的空间坐标被转换为一系列位置标记,并附加到其各自的实体文本跨度(例如,`a snowman` 后跟 `<patch_index_0044><patch_index_0863>`)。数据格式类似于“超链接”,它将图像中的对象区域连接到相应标题中的文本跨度。

论文摘要如下:

我们引入了 Kosmos-2,一个多模态大型语言模型(MLLM),它能够感知对象描述(例如,边界框)并将文本与视觉世界关联起来。具体来说,我们将引用表达式表示为 Markdown 中的链接,即“[文本跨度](边界框)”,其中对象描述是位置标记的序列。结合多模态语料库,我们构建了大规模的接地图像-文本对数据(称为 GrIT)来训练模型。除了 MLLM 的现有功能(例如,感知一般模态、遵循指令和执行上下文学习)之外,Kosmos-2 还将接地能力集成到下游应用程序中。我们评估了 Kosmos-2 在各种任务上的性能,包括 (i) 多模态接地,例如引用表达式理解和短语接地,(ii) 多模态引用,例如引用表达式生成,(iii) 感知语言任务,以及 (iv) 语言理解和生成。这项工作为具身 AI 的发展奠定了基础,并阐明了语言、多模态感知、行动和世界建模的大融合,这是迈向通用人工智能的关键一步。代码和预训练模型可在 https://aka.ms/kosmos-2 获取。

drawing KOSMOS-2 可以处理的任务概述。摘自原始论文

示例

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

>>> model = Kosmos2ForConditionalGeneration.from_pretrained("microsoft/kosmos-2-patch14-224")
>>> processor = AutoProcessor.from_pretrained("microsoft/kosmos-2-patch14-224")

>>> url = "https://huggingface.co/microsoft/kosmos-2-patch14-224/resolve/main/snowman.jpg"
>>> image = Image.open(requests.get(url, stream=True).raw)

>>> prompt = "<grounding> An image of"

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

>>> generated_ids = model.generate(
...     pixel_values=inputs["pixel_values"],
...     input_ids=inputs["input_ids"],
...     attention_mask=inputs["attention_mask"],
...     image_embeds=None,
...     image_embeds_position_mask=inputs["image_embeds_position_mask"],
...     use_cache=True,
...     max_new_tokens=64,
... )
>>> generated_text = processor.batch_decode(generated_ids, skip_special_tokens=True)[0]
>>> processed_text = processor.post_process_generation(generated_text, cleanup_and_extract=False)
>>> processed_text
'<grounding> An image of<phrase> a snowman</phrase><object><patch_index_0044><patch_index_0863></object> warming himself by<phrase> a fire</phrase><object><patch_index_0005><patch_index_0911></object>.'

>>> caption, entities = processor.post_process_generation(generated_text)
>>> caption
'An image of a snowman warming himself by a fire.'

>>> entities
[('a snowman', (12, 21), [(0.390625, 0.046875, 0.984375, 0.828125)]), ('a fire', (41, 47), [(0.171875, 0.015625, 0.484375, 0.890625)])]

此模型由 Yih-Dar SHIEH 贡献。原始代码可在 此处 找到。

Kosmos2Config

class transformers.Kosmos2Config

< >

( text_config = None vision_config = None latent_query_num = 64 **kwargs )

参数

  • text_config (dict, 可选) — 用于初始化 Kosmos2TextConfig 的配置选项字典。
  • vision_config (dict, 可选) — 用于初始化 Kosmos2VisionConfig 的配置选项字典。
  • latent_query_num (int, 可选, 默认为 64) — 用于文本解码器组件中表示图像特征的潜在查询标记的数量。
  • kwargs (可选) — 关键字参数字典。

这是用于存储 Kosmos2Model 配置的配置类。它用于根据指定参数实例化 KOSMOS-2 模型,定义模型架构。使用默认值实例化配置将产生类似于 KOSMOS-2 microsoft/kosmos-2-patch14-224 架构的配置。

示例

>>> from transformers import Kosmos2Config, Kosmos2Model

>>> # Initializing a Kosmos-2 kosmos-2-patch14-224 style configuration
>>> configuration = Kosmos2Config()

>>> # Initializing a model (with random weights) from the kosmos-2-patch14-224 style configuration
>>> model = Kosmos2Model(configuration)

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

Kosmos2ImageProcessor

Kosmos2Processor

class transformers.Kosmos2Processor

< >

( image_processor tokenizer num_patch_index_tokens = 1024 *kwargs )

参数

  • image_processor (CLIPImageProcessor) — 一个 CLIPImageProcessor 实例。图像处理器是必需输入。
  • tokenizer (XLMRobertaTokenizerFast) — 一个 [‘XLMRobertaTokenizerFast`]] 实例。分词器是必需输入。
  • num_patch_index_tokens (int, 可选, 默认为 1024) — 表示补丁索引的标记数量。

构建一个 KOSMOS-2 处理器,它将 KOSMOS-2 图像处理器和 KOSMOS-2 分词器包装成一个单一的处理器。

Kosmos2Processor 提供了 CLIPImageProcessor 的所有功能和 XLMRobertaTokenizerFast 的部分功能。有关更多信息,请参阅 call()decode() 的文档字符串。

__call__

< >

( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']] = None text: typing.Union[str, list[str]] = None audio = None videos = None **kwargs: typing_extensions.Unpack[transformers.models.kosmos2.processing_kosmos2.Kosmos2ProcessorKwargs] )

参数

  • bboxes (Union[list[tuple[int]], list[tuple[float]], list[list[tuple[int]]], list[list[tuple[float]]]], 可选) — 与 texts 相关的边界框。
  • num_image_tokens (int, 可选,默认为 64) — 用于标记保留图像信息占位符的(连续)位置数量。这应与您使用的 Kosmos2Config 实例中的 latent_query_num 相同。
  • first_image_token_id (int, 可选) — 将用于子序列中第一个位置的标记 ID,该子序列保留用于存储图像信息。如果未设置,则默认为 self.tokenizer.unk_token_id + 1
  • add_eos_token (bool, 默认为 False) — 当 add_special_tokens=True 时,是否在编码中包含 EOS 标记 ID。

此方法使用 CLIPImageProcessor.call() 方法准备模型图像,并使用 XLMRobertaTokenizerFast.call() 准备模型文本。

有关更多信息,请参阅上述两种方法的文档字符串。

本文档的其余部分显示了 Kosmos2Processor 的特定参数。

Kosmos2Model

class transformers.Kosmos2Model

< >

( config: Kosmos2Config )

参数

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

用于生成文本和图像特征的 KOSMOS-2 模型。该模型由视觉编码器和语言模型组成。

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

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

forward

< >

( pixel_values: typing.Optional[torch.Tensor] = None input_ids: typing.Optional[torch.Tensor] = None image_embeds_position_mask: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[list[torch.FloatTensor]] = None image_embeds: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None interpolate_pos_encoding: bool = False return_dict: typing.Optional[bool] = None **kwargs: typing_extensions.Unpack[transformers.modeling_flash_attention_utils.FlashAttentionKwargs] ) transformers.models.kosmos2.modeling_kosmos2.Kosmos2ModelOutputtuple(torch.FloatTensor)

参数

  • pixel_values (形状为 (batch_size, num_channels, image_size, image_size)torch.Tensor可选) — 对应于输入图像的张量。像素值可以通过 {image_processor_class} 获取。有关详细信息,请参阅 {image_processor_class}.__call__{processor_class} 使用 {image_processor_class} 处理图像)。
  • input_ids (形状为 (batch_size, sequence_length)torch.Tensor可选) — 词汇表中输入序列标记的索引。默认情况下会忽略填充。

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

    什么是输入 ID?

  • image_embeds_position_mask (形状为 (batch_size, sequence_length)torch.Tensor可选) — 用于指示序列中插入图像特征位置的掩码。掩码值选择在 [0, 1] 之间:

    • 1 表示放置图像特征的位置,
    • 0 表示不用于图像特征的位置(即用于文本标记的位置)。
  • attention_mask (形状为 (batch_size, sequence_length)torch.Tensor可选) — 避免对填充标记索引执行注意力操作的掩码。掩码值选择在 [0, 1] 之间:

    • 1 表示未被掩盖的标记,
    • 0 表示被掩盖的标记。

    什么是注意力掩码?

  • head_mask (形状为 (num_heads,)(num_layers, num_heads)torch.Tensor可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择在 [0, 1] 之间:

    • 1 表示头部未被掩盖
    • 0 表示头部被掩盖
  • past_key_values (list[torch.FloatTensor], 可选) — 预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于加速顺序解码。这通常由模型在解码的先前阶段返回的 past_key_values 组成,当 use_cache=Trueconfig.use_cache=True 时。

    允许两种格式:

    • 一个 Cache 实例,请参阅我们的 kv 缓存指南
    • 长度为 config.n_layerstuple(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)

  • image_embeds (形状为 (batch_size, latent_query_num, hidden_size)torch.FloatTensor可选) — Kosmos2ImageToTextProjection 输出的隐藏状态序列。
  • inputs_embeds (形状为 (batch_size, sequence_length, hidden_size)torch.Tensor可选) — 可选地,您可以直接传递嵌入表示,而不是传递 input_ids。如果您希望更好地控制如何将 input_ids 索引转换为关联向量,而不是模型内部的嵌入查找矩阵,这将很有用。
  • position_ids (形状为 (batch_size, sequence_length)torch.Tensor可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为 [0, config.n_positions - 1]

    什么是位置 ID?

  • use_cache (bool, 可选) — 如果设置为 True,则返回 past_key_values 键值状态,并可用于加速解码(请参阅 past_key_values)。
  • output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。更多详细信息请参阅返回张量中的 attentions
  • output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。更多详细信息请参阅返回张量中的 hidden_states
  • interpolate_pos_encoding (bool, 默认为 False) — 是否对预训练的位置编码进行插值。
  • return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通元组。

返回

transformers.models.kosmos2.modeling_kosmos2.Kosmos2ModelOutputtuple(torch.FloatTensor)

一个 transformers.models.kosmos2.modeling_kosmos2.Kosmos2ModelOutputtorch.FloatTensor 元组(如果传递 return_dict=Falseconfig.return_dict=False),包含根据配置(Kosmos2Config)和输入而变化的不同元素。

  • last_hidden_state (形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor, 可选,默认为 None) — 模型最后一层输出的隐藏状态序列。

  • past_key_values (tuple(tuple(torch.FloatTensor)), optional, 当传递 use_cache=Trueconfig.use_cache=True 时返回) — 长度为 config.n_layerstuple(torch.FloatTensor) 元组,每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量,如果 config.is_encoder_decoder=True,则可选包含 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

    包含预计算的隐藏状态(自注意力块中的键和值,如果 config.is_encoder_decoder=True 则可选包含交叉注意力块中的键和值),可用于(请参阅 past_key_values 输入)加速顺序解码。

  • hidden_states (tuple[torch.FloatTensor], optional, 当传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — 形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor 元组(一个用于嵌入层的输出,如果模型有嵌入层,+ 一个用于每层的输出)。

    模型在每个层输出的隐藏状态以及可选的初始嵌入输出。

  • attentions (tuple[torch.FloatTensor], optional, 当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length)torch.FloatTensor 元组(每个层一个)。

    注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均值。

  • image_embeds (形状为 (batch_size, latent_query_num, hidden_size)torch.FloatTensor, optional) — Kosmos2ImageToTextProjection 输出的隐藏状态序列。

  • projection_attentions (tuple(torch.FloatTensor), optional) — 形状为 (batch_size, num_heads, sequence_length, sequence_length)torch.FloatTensor 元组(每个层一个)。

    Kosmos2ImageToTextProjection 给出的注意力权重,在注意力softmax之后,用于计算自注意力头中的加权平均值。

  • vision_model_output (BaseModelOutputWithPooling, optional) — Kosmos2VisionModel 的输出。

Kosmos2Model forward 方法,覆盖 __call__ 特殊方法。

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

示例

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

>>> model = Kosmos2Model.from_pretrained("microsoft/kosmos-2-patch14-224")
>>> processor = AutoProcessor.from_pretrained("microsoft/kosmos-2-patch14-224")

>>> url = "https://huggingface.co/microsoft/kosmos-2-patch14-224/resolve/main/snowman.jpg"
>>> image = Image.open(requests.get(url, stream=True).raw)

>>> text = (
...     "<grounding> An image of<phrase> a snowman</phrase><object><patch_index_0044><patch_index_0863>"
...     "</object> warming himself by<phrase> a fire</phrase><object><patch_index_0005><patch_index_0911>"
...     "</object>"
... )

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

>>> last_hidden_state = model(
...     pixel_values=inputs["pixel_values"],
...     input_ids=inputs["input_ids"],
...     attention_mask=inputs["attention_mask"],
...     image_embeds_position_mask=inputs["image_embeds_position_mask"],
... ).last_hidden_state
>>> list(last_hidden_state.shape)
[1, 91, 2048]

Kosmos2ForConditionalGeneration

class transformers.Kosmos2ForConditionalGeneration

< >

( config: Kosmos2Config )

参数

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

用于生成给定图像的文本和边界框的 KOSMOS-2 模型。该模型由视觉编码器和语言模型组成。

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

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

forward

< >

( pixel_values: typing.Optional[torch.Tensor] = None input_ids: typing.Optional[torch.Tensor] = None image_embeds_position_mask: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[list[torch.FloatTensor]] = None image_embeds: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = 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 **kwargs: typing_extensions.Unpack[transformers.models.kosmos2.modeling_kosmos2.KwargsForCausalLM] ) transformers.models.kosmos2.modeling_kosmos2.Kosmos2ForConditionalGenerationModelOutputtuple(torch.FloatTensor)

参数

  • pixel_values (形状为 (batch_size, num_channels, image_size, image_size)torch.Tensor, optional) — 对应于输入图像的张量。像素值可以使用 {image_processor_class} 获得。有关详细信息,请参阅 {image_processor_class}.__call__{processor_class} 使用 {image_processor_class} 进行图像处理)。
  • input_ids (形状为 (batch_size, sequence_length)torch.Tensor, optional) — 词汇表中输入序列 token 的索引。默认情况下将忽略填充。

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

    什么是输入 ID?

  • image_embeds_position_mask (形状为 (batch_size, sequence_length)torch.Tensor, optional) — 用于指示序列中插入图像特征位置的掩码。掩码值选择在 [0, 1] 之间:

    • 1 表示放置图像特征的位置,
    • 0 表示不放置图像特征的位置(即文本 token)。
  • attention_mask (形状为 (batch_size, sequence_length)torch.Tensor, optional) — 用于避免对填充 token 索引执行注意力的掩码。掩码值选择在 [0, 1] 之间:

    • 1 表示 未被掩盖 的 token,
    • 0 表示 被掩盖 的 token。

    什么是注意力掩码?

  • head_mask (形状为 (num_heads,)(num_layers, num_heads)torch.Tensor, optional) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择在 [0, 1] 之间:

    • 1 表示头部 未被掩盖
    • 0 表示头部 被掩盖
  • past_key_values (list[torch.FloatTensor], optional) — 预计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于加速顺序解码。这通常包括模型在解码上一阶段返回的 past_key_values,当 use_cache=Trueconfig.use_cache=True 时。

    允许两种格式:

    • 一个 Cache 实例,请参阅我们的 kv 缓存指南
    • 长度为 config.n_layerstuple(torch.FloatTensor) 元组,每个元组包含 2 个形状为 (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

  • image_embeds (形状为 (batch_size, latent_query_num, hidden_size)torch.FloatTensor, optional) — Kosmos2ImageToTextProjection 输出的隐藏状态序列。
  • inputs_embeds (形状为 (batch_size, sequence_length, hidden_size)torch.Tensor, optional) — 可选地,除了传递 input_ids 之外,您还可以选择直接传递嵌入表示。如果您希望对 input_ids 索引如何转换为关联向量拥有比模型内部嵌入查找矩阵更多的控制权,这将非常有用。
  • position_ids (形状为 (batch_size, sequence_length)torch.Tensor, optional) — 每个输入序列 token 在位置嵌入中的位置索引。选择范围为 [0, config.n_positions - 1]

    什么是位置 ID?

  • labels (形状为 (batch_size, sequence_length)torch.LongTensor, optional) — 用于计算从左到右语言建模损失(下一词预测)的标签。索引应在 [-100, 0, ..., config.vocab_size] 范围内(请参阅 input_ids 文档字符串)索引设置为 -100 的 token 将被忽略(被掩盖),损失仅针对标签在 [0, ..., config.vocab_size] 范围内的 token 计算。
  • use_cache (bool, optional) — 如果设置为 True,将返回 past_key_values 键值状态,可用于加速解码(请参阅 past_key_values)。
  • output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。更多详细信息请参阅返回张量中的 attentions
  • output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。更多详细信息请参阅返回张量中的 hidden_states

返回

transformers.models.kosmos2.modeling_kosmos2.Kosmos2ForConditionalGenerationModelOutputtuple(torch.FloatTensor)

一个 transformers.models.kosmos2.modeling_kosmos2.Kosmos2ForConditionalGenerationModelOutputtorch.FloatTensor 元组(如果传递 return_dict=Falseconfig.return_dict=False),包含根据配置(Kosmos2Config)和输入而变化的不同元素。

  • loss (torch.FloatTensor 形状为 (1,)可选,当提供 labels 时返回) — 语言建模损失(用于下一个 token 预测)。

  • logits (形状为 (batch_size, sequence_length, config.vocab_size)torch.FloatTensor) — 语言建模头部的预测分数(SoftMax 之前的每个词汇标记的分数)。

  • past_key_values (tuple(tuple(torch.FloatTensor)), optional, 当传递 use_cache=Trueconfig.use_cache=True 时返回) — 长度为 config.n_layerstuple(torch.FloatTensor) 元组,每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量,如果 config.is_encoder_decoder=True,则可选包含 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

    包含预计算的隐藏状态(自注意力块中的键和值,如果 config.is_encoder_decoder=True 则可选包含交叉注意力块中的键和值),可用于(请参阅 past_key_values 输入)加速顺序解码。

  • hidden_states (tuple[torch.FloatTensor], optional, 当传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — 形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor 元组(一个用于嵌入层的输出,如果模型有嵌入层,+ 一个用于每层的输出)。

    模型在每个层输出的隐藏状态以及可选的初始嵌入输出。

  • attentions (tuple[torch.FloatTensor], optional, 当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length)torch.FloatTensor 元组(每个层一个)。

    注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均值。

  • image_embeds (形状为 (batch_size, latent_query_num, hidden_size)torch.FloatTensor, optional) — Kosmos2ImageToTextProjection 输出的隐藏状态序列。

  • projection_attentions (tuple(torch.FloatTensor), optional) — 形状为 (batch_size, num_heads, sequence_length, sequence_length)torch.FloatTensor 元组(每个层一个)。

    Kosmos2ImageToTextProjection 给出的注意力权重,在注意力softmax之后,用于计算自注意力头中的加权平均值。

  • vision_model_output (BaseModelOutputWithPooling, optional) — Kosmos2VisionModel 的输出。

Kosmos2ForConditionalGeneration forward 方法,覆盖 __call__ 特殊方法。

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

示例

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

>>> model = Kosmos2ForConditionalGeneration.from_pretrained("microsoft/kosmos-2-patch14-224")
>>> processor = AutoProcessor.from_pretrained("microsoft/kosmos-2-patch14-224")

>>> url = "https://huggingface.co/microsoft/kosmos-2-patch14-224/resolve/main/snowman.jpg"
>>> image = Image.open(requests.get(url, stream=True).raw)

>>> prompt = "<grounding> An image of"

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

>>> generated_ids = model.generate(
...     pixel_values=inputs["pixel_values"],
...     input_ids=inputs["input_ids"],
...     attention_mask=inputs["attention_mask"],
...     image_embeds=None,
...     image_embeds_position_mask=inputs["image_embeds_position_mask"],
...     use_cache=True,
...     max_new_tokens=64,
... )
>>> generated_text = processor.batch_decode(generated_ids, skip_special_tokens=True)[0]
>>> processed_text = processor.post_process_generation(generated_text, cleanup_and_extract=False)
>>> processed_text
'<grounding> An image of<phrase> a snowman</phrase><object><patch_index_0044><patch_index_0863></object> warming himself by<phrase> a fire</phrase><object><patch_index_0005><patch_index_0911></object>.'

>>> caption, entities = processor.post_process_generation(generated_text)
>>> caption
'An image of a snowman warming himself by a fire.'

>>> entities
[('a snowman', (12, 21), [(0.390625, 0.046875, 0.984375, 0.828125)]), ('a fire', (41, 47), [(0.171875, 0.015625, 0.484375, 0.890625)])]
< > 在 GitHub 上更新