KOSMOS-2
概述
KOSMOS-2 模型由彭智良、王文辉、董力、郝亚茹、黄绍涵、马树明、魏福如在 Kosmos-2: Grounding Multimodal Large Language Models to the World 中提出。
KOSMOS-2 是一种基于 Transformer 的因果语言模型，它使用基于 Web 规模的、包含地面实况图像文本对的数据集 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 获取。
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 贡献。原始代码可以在这里找到：here.
Kosmos2Config
class transformers.Kosmos2Config
< 源代码 >( text_config = None vision_config = None latent_query_num = 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.configKosmos2ImageProcessor
Kosmos2Processor
class transformers.Kosmos2Processor
< source >( 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__
< source >( images: Union = None text: Union = None audio = None videos = None **kwargs: Unpack )
参数
- 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, 可选) — 用于存储图像信息的子序列第一个位置的 token id。如果未设置，则默认为self.tokenizer.unk_token_id + 1。 - add_eos_token (
bool, 默认为False) — 当add_special_tokens=True时，是否在编码中包含EOStoken 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: Optional = None input_ids: Optional = None image_embeds_position_mask: Optional = None attention_mask: Optional = None head_mask: Optional = None past_key_values: Optional = None image_embeds: Optional = None inputs_embeds: Optional = None position_ids: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.models.kosmos2.modeling_kosmos2.Kosmos2ModelOutput 或 tuple(torch.FloatTensor)
参数
- pixel_values (
torch.FloatTensor形状为(batch_size, num_channels, height, width)) — 像素值。可以使用 AutoImageProcessor 获取像素值。有关详细信息，请参阅 CLIPImageProcessor.call()。 - input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。如果您提供填充，默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- image_embeds_position_mask (
torch.Tensor形状为(batch_size, sequence_length)，可选) — 掩码指示在序列中插入图像特征的位置。掩码值在[0, 1]中选择：- 1 用于放置图像特征的位置，
- 0 用于不属于图像特征的位置（即文本标记）。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length)，可选) — 掩码以避免对填充标记索引执行注意力。掩码值在[0, 1]中选择：- 1 表示未屏蔽的标记，
- 0 表示屏蔽的标记。
- head_mask (
torch.FloatTensor形状为(num_heads,)或(num_layers, num_heads)，可选) — 掩码以使自注意力模块的选定头部失效。掩码值在[0, 1]中选择：- 1 表示未屏蔽的头部，
- 0 表示屏蔽的头部。
- past_key_values (
tuple(tuple(torch.FloatTensor))长度为config.n_layers，每个元组包含 4 个形状为(batch_size, num_heads, sequence_length - 1, embed_size_per_head)的张量) — 包含注意力块的预计算键和值隐藏状态。可用于加快解码速度。如果使用
past_key_values，用户可以选择仅输入形状为(batch_size, 1)的最后一个decoder_input_ids（那些没有为此模型提供过去键值状态的）而不是形状为(batch_size, sequence_length)的所有decoder_input_ids。image_embeds — (torch.FloatTensor形状为(batch_size, latent_query_num, hidden_size)，可选)：Kosmos2ImageToTextProjection输出处的隐藏状态序列。 - inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入式表示，而不是传递input_ids。如果您想要更多地控制如何将input_ids索引转换为关联的向量，而不是模型的内部嵌入查找矩阵，这将很有用。 - position_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记位置的索引。在范围[0, config.max_position_embeddings - 1]中选择。 - use_cache (
bool，可选) — 如果设置为True，将返回past_key_values键值状态，可用于加快解码速度（请参阅past_key_values）。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量中的attentions。
返回
transformers.models.kosmos2.modeling_kosmos2.Kosmos2ModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.kosmos2.modeling_kosmos2.Kosmos2ModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (<class 'transformers.models.kosmos2.configuration_kosmos2.Kosmos2Config'>) 和输入而异的各种元素。
-
last_hidden_state (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。 -
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_embeds (
torch.FloatTensor形状为(batch_size, latent_query_num, hidden_size), 可选) —Kosmos2ImageToTextProjection输出的隐藏状态序列。 -
projection_attentions (
tuple(torch.FloatTensor), 可选) —torch.FloatTensor元组（每一层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。由
Kosmos2ImageToTextProjection给出的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均值。 -
vision_model_output(
BaseModelOutputWithPooling, 可选) —Kosmos2VisionModel的输出。 -
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)的张量，以及可选的，如果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输入) 加速顺序解码。
Kosmos2Model 正向方法，覆盖了 __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: Optional = None input_ids: Optional = None image_embeds_position_mask: Optional = None attention_mask: Optional = None head_mask: Optional = None past_key_values: Optional = None image_embeds: Optional = None inputs_embeds: Optional = None position_ids: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.models.kosmos2.modeling_kosmos2.Kosmos2ForConditionalGenerationModelOutput 或 tuple(torch.FloatTensor)
参数
- pixel_values (
torch.FloatTensor形状为(batch_size, num_channels, height, width)) — 像素值。 像素值可以使用 AutoImageProcessor 获取。 查看 CLIPImageProcessor.call() 获取详细信息。 - input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。默认情况下，如果您提供填充，则会忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 。
- image_embeds_position_mask (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 用于指示在序列中插入图像特征的位置的掩码。掩码值选择在[0, 1]中：- 1 用于放置图像特征的位置，
- 0 用于不是图像特征的位置（即文本标记）。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 用于避免在填充标记索引上执行注意的掩码。掩码值选择在[0, 1]中：- 1 表示未屏蔽的标记，
- 0 表示屏蔽的标记。
- head_mask (
torch.FloatTensor形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择在[0, 1]中：- 1 表示头部未屏蔽，
- 0 表示头部已屏蔽。
- past_key_values (
tuple(tuple(torch.FloatTensor))长度为config.n_layers，每个元组包含 4 个形状为(batch_size, num_heads, sequence_length - 1, embed_size_per_head)的张量) — 包含预先计算的注意块的关键和值隐藏状态。可用于加快解码速度。如果使用
past_key_values，用户可以选择仅输入形状为(batch_size, 1)的最后一个decoder_input_ids（这些没有提供给此模型的过去键值状态），而不是所有形状为(batch_size, sequence_length)的decoder_input_ids。image_embeds — (torch.FloatTensor形状为(batch_size, latent_query_num, hidden_size), 可选):Kosmos2ImageToTextProjection输出处的隐藏状态序列。 - inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，而不是传递input_ids，您可以选择直接传递嵌入式表示。如果您希望对如何将input_ids索引转换为关联向量有更多控制，而不是模型的内部嵌入查找矩阵，这将很有用。 - position_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列标记的位置索引。选择范围在[0, config.max_position_embeddings - 1]内。 - use_cache (
bool, 可选) — 如果设置为True，将返回past_key_values键值状态，可用于加快解码速度（参见past_key_values）。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参见返回张量中的attentions。 - labels (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 用于计算从左到右语言建模损失（下一个词预测）的标签。 索引应在[-100, 0, ..., config.vocab_size]中（参见input_ids文档字符串） 索引设置为-100的标记被忽略（屏蔽），损失仅针对标签在[0, ..., config.vocab_size]中的标记计算
返回
transformers.models.kosmos2.modeling_kosmos2.Kosmos2ForConditionalGenerationModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.kosmos2.modeling_kosmos2.Kosmos2ForConditionalGenerationModelOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包括取决于配置（<class 'transformers.models.kosmos2.configuration_kosmos2.Kosmos2Config'>）和输入的各种元素。
-
loss (
torch.FloatTensor形状为(1,), 可选, 当提供labels时返回) — 语言建模损失（用于下一个标记预测）。 -
logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（每个词汇表标记在 SoftMax 之前的分数）。 -
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_embeds (
torch.FloatTensor形状为(batch_size, latent_query_num, hidden_size), 可选) —Kosmos2ImageToTextProjection输出的隐藏状态序列。 -
projection_attentions (
tuple(torch.FloatTensor), 可选) —torch.FloatTensor元组（每一层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。由
Kosmos2ImageToTextProjection给出的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均值。 -
vision_model_output(
BaseModelOutputWithPooling, 可选) —Kosmos2VisionModel的输出。 -
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)的张量，以及可选的，如果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输入) 加速顺序解码。
该 Kosmos2ForConditionalGeneration 正向方法，覆盖了 __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)])]