Hugging Face 的 LOGO

Transformers 文档

Idefics3

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

Idefics3

PyTorch FlashAttention SDPA

概述

Idefics3 模型由 Hugo Laurençon、Andrés Marafioti、Victor Sanh 和 Léo Tronchon 在论文《构建并更好地理解视觉-语言模型：见解与未来方向》中提出。

Idefics3 是 Idefics2 模型的改编版，主要有三个不同之处：

  • 文本模型使用 Llama3。
  • 对图像使用更新的处理逻辑。
  • 移除了 perceiver。

论文摘要如下：

视觉-语言模型（VLM）领域正在迅速发展，该领域模型以图像和文本为输入，输出文本。在开发流程的几个关键方面，包括数据、架构和训练方法，尚未达成共识。本文可视为构建 VLM 的教程。我们首先全面概述了当前最先进的方法，强调了每种方法的优缺点，解决了该领域的主要挑战，并为尚未充分探索的领域提出了有前景的研究方向。然后，我们逐步介绍了构建 Idefics3-8B 的实际步骤，这是一个强大的 VLM，其性能显著优于其前身 Idefics2-8B，同时训练效率高，完全基于开放数据集，并使用了简单的流程。这些步骤包括创建 Docmatix，这是一个用于提高文档理解能力的数据集，其规模比以往可用的数据集大 240 倍。我们发布了该模型以及用于其训练的数据集。

使用技巧

输入图像要么通过上采样（如果启用了调整大小）处理，要么以其原始分辨率处理。调整大小的行为取决于两个参数：`do_resize` 和 `size`。

如果 do_resize 设置为 True，模型默认将图像的最长边调整为 4*364 像素。默认的调整大小行为可以通过向 size 参数传递一个字典来自定义。例如，`{“longest_edge”: 4 * 364}` 是默认值，但如果需要，您可以将其更改为不同的值。

以下是如何控制调整大小并设置自定义尺寸的方法：

image_processor = Idefics3ImageProcessor(do_resize=True, size={"longest_edge": 2 * 364}, max_image_size=364)

此外，`max_image_size` 参数控制图像被分解成的每个方形图块的大小，默认设置为 364，但可以根据需要进行调整。调整大小后（如果适用），图像处理器会根据 `max_image_size` 参数将图像分解为方形图块。

该模型由 amyeroberts 和 andimarafioti 贡献。

Idefics3Config

class transformers.Idefics3Config

< >

( use_cache = True image_token_id = 128257 tie_word_embeddings = False vision_config = None text_config = None scale_factor = 2 pad_token_id = 128002 **kwargs )

参数

  • use_cache (bool, 可选, 默认为 True) — 模型是否应缓存注意力机制的键/值对。仅当 `config.is_decoder=True` 时相关。
  • image_token_id (int, 可选, 默认为 128257) — “image” 标记的 ID。
  • tie_word_embeddings (bool, 可选, 默认为 False) — 是否将词嵌入与标记嵌入绑定。
  • vision_config (IdeficsVisionConfig 或 dict, 可选, 默认为 IdeficsVisionConfig) — 视觉塔的自定义视觉配置或字典。
  • text_config (PretrainedConfig 或 dict, 可选, 默认为 LlamaConfig) — 文本模型的自定义文本配置或字典。
  • scale_factor (int, 可选, 默认为 2) — 图像编码器的缩放因子。
  • pad_token_id (int, 可选, 默认为 128002) — 填充标记的 ID。

这是用于存储 Idefics3Model 配置的配置类。它用于根据指定的参数实例化 Idefics3 模型，定义模型架构。使用默认值实例化配置将产生与 Idefics3 HuggingFaceM4/Idefics3-8B-Llama3 架构模型类似的配置。

配置对象继承自 PretrainedConfig，可用于控制模型输出。有关更多信息，请阅读 PretrainedConfig 的文档。

示例

>>> from transformers import Idefics3Model, Idefics3Config
>>> # Initializing configuration
>>> configuration = Idefics3Config()
>>> # Initializing a model from the configuration
>>> model = Idefics3Model(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config

Idefics3VisionConfig

class transformers.Idefics3VisionConfig

< >

( hidden_size = 1152 intermediate_size = 3072 num_hidden_layers = 12 num_attention_heads = 16 num_channels = 3 image_size = 224 patch_size = 32 hidden_act = 'gelu_pytorch_tanh' layer_norm_eps = 1e-06 attention_dropout = 0.0 initializer_range = 0.02 **kwargs )

参数

  • hidden_size (int, 可选, 默认为 1152) — 编码器层和池化层的维度。
  • intermediate_size (int, 可选, 默认为 3072) — Transformer 编码器中“中间”（即前馈）层的维度。
  • num_hidden_layers (int, 可选, 默认为 12) — Transformer 编码器中的隐藏层数量。
  • num_attention_heads (int, 可选, 默认为 16) — Transformer 编码器中每个注意力层的注意力头数量。
  • num_channels (int, 可选, 默认为 3) — 输入图像中的通道数。
  • image_size (int, 可选, 默认为 224) — 每张图像的大小（分辨率）。
  • patch_size (int, 可选, 默认为 32) — 每个图块的大小（分辨率）。
  • hidden_act (str 或 function, 可选, 默认为 "gelu_pytorch_tanh") — 编码器和池化层中的非线性激活函数（函数或字符串）。如果为字符串，支持 `"gelu"`、`"relu"`、`"selu"`、`"gelu_new"` 和 `"quick_gelu"`。
  • layer_norm_eps (float, 可选, 默认为 1e-06) — 层归一化层使用的 epsilon 值。
  • attention_dropout (float, 可选, 默认为 0.0) — 注意力概率的 dropout 比率。
  • initializer_range (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。

这是用于存储 Idefics3VisionModel 配置的配置类。它用于根据指定的参数实例化 Idefics3 视觉编码器，定义模型架构。使用默认值实例化配置将产生与 Idefics3 模型 HuggingFaceM4/Idefics3-8B-Llama3 中使用的 SigLIP checkpoint google/siglip-base-patch16-224 类似的配置。

配置对象继承自 PretrainedConfig，可用于控制模型输出。有关更多信息，请阅读 PretrainedConfig 的文档。

示例

>>> from transformers.models.idefics3.modeling_idefics3 import Idefics3VisionTransformer
>>> from transformers.models.idefics3.configuration_idefics3 import Idefics3VisionConfig

>>> # Initializing a Idefics3VisionConfig with google/siglip-base-patch16-224 style configuration
>>> configuration = Idefics3VisionConfig()

>>> # Initializing a Idefics3VisionTransformer (with random weights) from the google/siglip-base-patch16-224 style configuration
>>> model = Idefics3VisionTransformer(configuration)

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

Idefics3VisionTransformer

class transformers.Idefics3VisionTransformer

< >

( config: Idefics3VisionConfig )

参数

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

Idefics3 Vision Transformer 模型输出原始图像嵌入。

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

该模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。

Idefics3Model

class transformers.Idefics3Model

< >

( config: Idefics3Config )

参数

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

Idefics3 模型由 SIGLIP 视觉编码器和 Llama3 语言解码器组成。

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

该模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = 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 pixel_values: typing.Optional[torch.FloatTensor] = None pixel_attention_mask: typing.Optional[torch.BoolTensor] = None image_hidden_states: typing.Optional[torch.FloatTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None return_dict: typing.Optional[bool] = None **kwargs: typing_extensions.Unpack[transformers.modeling_flash_attention_utils.FlashAttentionKwargs] ) → `transformers.models.idefics3.modeling_idefics3.Idefics3BaseModelOutputWithPast` 或 `tuple(torch.FloatTensor)`

参数

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

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

    什么是输入 ID？

  • attention_mask (形状为 `(batch_size, sequence_length)` 的 `torch.Tensor`, 可选) — 避免对填充标记索引执行注意力的掩码。掩码值在 `[0, 1]` 中选择：

    • 1 表示**未被屏蔽**的标记，
    • 0 表示**被屏蔽**的标记。

    什么是注意力掩码？

  • position_ids (形状为 `(batch_size, sequence_length)` 的 `torch.LongTensor`, 可选) — 位置嵌入中每个输入序列标记的位置索引。在 `[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)`，而不是所有形状为 `(batch_size, sequence_length)` 的 `input_ids`。

  • inputs_embeds (形状为 `(batch_size, sequence_length, hidden_size)` 的 `torch.FloatTensor`, 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递 `input_ids`。如果您希望比模型内部的嵌入查找矩阵更好地控制如何将 `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}` 处理图像）。
  • pixel_attention_mask (形状为 `(batch_size, image_size, image_size)` 的 `torch.Tensor`, 可选) — 避免对填充像素索引执行注意力的掩码。
  • image_hidden_states (形状为 `(batch_size, num_channels, image_size, image_size)` 的 `torch.FloatTensor`) — 经过模态投影后的图像编码器的隐藏状态。
  • use_cache (bool, 可选) — 如果设置为 True，将返回 past_key_values 键值状态，可用于加速解码（参见 past_key_values）。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的 attentions。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的 hidden_states。
  • cache_position (torch.LongTensor，形状为 (sequence_length), 可选) — 描述输入序列中标记位置的索引。与 position_ids 不同，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。
  • return_dict (bool, 可选) — 是返回一个 ModelOutput 而不是一个普通的元组。

返回

transformers.models.idefics3.modeling_idefics3.Idefics3BaseModelOutputWithPast 或 tuple(torch.FloatTensor)

一个 transformers.models.idefics3.modeling_idefics3.Idefics3BaseModelOutputWithPast 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置（Idefics3Config）和输入的不同元素。

  • last_hidden_state (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。如果使用 past_key_values，则只输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。

  • 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 输入）。

  • 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 (tuple(torch.FloatTensor), 可选) — torch.FloatTensor 元组（一个用于图像嵌入的输出，形状为 (batch_size, num_images, sequence_length, hidden_size)）。由视觉编码器生成的模型的 image_hidden_states。

输入到模型的图像数量可以是任意的。为了解决这个问题，输入到模型的 pixel_values 带有图像填充 -> (batch_size, max_num_images, 3, max_heights, max_widths)，其中 max_num_images 是批次中 batch_size 个样本中的最大图像数。除了在模型入口处填充 pixel_values 外，不需要对图像进行填充。为了提高效率，我们只通过 vision_model 的前向传播传递真实图像，丢弃填充图像，即 pixel_values 的大小为 (image_batch_size, 3, height, width)，其中当 num_images_per_sample=[1, 3, 1, 2] 且 max_num_images 为 3 时，image_batch_size 将为 7。

Idefics3ForConditionalGeneration

class transformers.Idefics3ForConditionalGeneration

< >

( config )

参数

Idefics3 模型带有一个语言模型头。它由一个 SigLIP 视觉编码器和一个顶部的语言模型头组成。

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

该模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = 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 pixel_values: typing.Optional[torch.FloatTensor] = None pixel_attention_mask: typing.Optional[torch.BoolTensor] = None image_hidden_states: typing.Optional[torch.FloatTensor] = 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 cache_position: typing.Optional[torch.LongTensor] = None return_dict: typing.Optional[bool] = None logits_to_keep: typing.Union[int, torch.Tensor] = 0 **kwargs: typing_extensions.Unpack[transformers.models.idefics3.modeling_idefics3.KwargsForCausalLM] ) → transformers.models.idefics3.modeling_idefics3.Idefics3CausalLMOutputWithPast 或 tuple(torch.FloatTensor)

参数

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

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

    什么是输入 ID？

  • attention_mask (torch.Tensor，形状为 (batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值在 [0, 1] 中选择：

    • 1 表示标记未被遮盖，
    • 0 表示标记被遮盖。

    什么是注意力掩码？

  • position_ids (torch.LongTensor，形状为 (batch_size, sequence_length), 可选) — 每个输入序列标记在位置嵌入中的位置索引。在 [0, config.n_positions - 1] 范围内选择。

    什么是位置 ID？

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

    允许两种格式：

    • 一个 Cache 实例，请参阅我们的 kv cache 指南；
    • 长度为 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)，而不是所有形状为 (batch_size, sequence_length) 的 input_ids。

  • inputs_embeds (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您想比模型的内部嵌入查找矩阵更好地控制如何将 input_ids 索引转换为关联向量，这将非常有用。
  • pixel_values (torch.FloatTensor，形状为 (batch_size, num_channels, image_size, image_size), 可选) — 对应于输入图像的张量。可以使用 {image_processor_class} 获取像素值。有关详细信息，请参见 {image_processor_class}.__call__（{processor_class} 使用 {image_processor_class} 处理图像）。
  • pixel_attention_mask (torch.Tensor，形状为 (batch_size, image_size, image_size), 可选) — 用于避免对填充像素索引执行注意力的掩码。
  • image_hidden_states (torch.FloatTensor，形状为 (batch_size, num_channels, image_size, image_size)) — 经过模态投影后的图像编码器的隐藏状态。
  • labels (torch.LongTensor，形状为 (batch_size, sequence_length), 可选) — 用于计算掩码语言建模损失的标签。索引应在 [0, ..., config.vocab_size] 或 model.image_token_id（其中 model 是您的 Idefics3ForConditionalGeneration 实例）中。索引设置为 model.image_token_id 的标记将被忽略（掩码），损失仅针对标签在 [0, ..., config.vocab_size] 中的标记计算。
  • use_cache (bool, 可选) — 如果设置为 True，将返回 past_key_values 键值状态，可用于加速解码（参见 past_key_values）。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的 attentions。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的 hidden_states。
  • cache_position (torch.LongTensor，形状为 (sequence_length), 可选) — 描述输入序列中标记位置的索引。与 position_ids 不同，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。
  • return_dict (bool, 可选) — 是返回一个 ModelOutput 而不是一个普通的元组。
  • logits_to_keep (Union[int, torch.Tensor], 默认为 0) — 如果是 int，则计算最后 logits_to_keep 个标记的 logits。如果是 0，则计算所有 input_ids 的 logits（特殊情况）。生成时只需要最后一个标记的 logits，仅为该标记计算它们可以节省内存，这对于长序列或大词汇表大小非常重要。如果是 torch.Tensor，则必须是一维的，对应于序列长度维度中要保留的索引。这在使用打包张量格式（批次和序列长度的单个维度）时很有用。

返回

transformers.models.idefics3.modeling_idefics3.Idefics3CausalLMOutputWithPast 或 tuple(torch.FloatTensor)

一个 transformers.models.idefics3.modeling_idefics3.Idefics3CausalLMOutputWithPast 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置（Idefics3Config）和输入的不同元素。

  • 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 (tuple(torch.FloatTensor), 可选) — torch.FloatTensor 元组（一个用于图像嵌入的输出，形状为 (batch_size, num_images, sequence_length, hidden_size)）。由视觉编码器生成的模型的 image_hidden_states。

Idefics3ForConditionalGeneration 的前向方法会覆盖 __call__ 特殊方法。

虽然前向传播的流程需要在此函数内定义，但之后应调用 Module 实例而不是此函数，因为前者会处理运行前后处理步骤，而后者会静默忽略它们。

示例

>>> import requests
>>> import torch
>>> from PIL import Image
>>> from io import BytesIO

>>> from transformers import AutoProcessor, AutoModelForVision2Seq
>>> from transformers.image_utils import load_image

>>> # Note that passing the image urls (instead of the actual pil images) to the processor is also possible
>>> image1 = load_image("https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg")
>>> image2 = load_image("https://cdn.britannica.com/59/94459-050-DBA42467/Skyline-Chicago.jpg")
>>> image3 = load_image("https://cdn.britannica.com/68/170868-050-8DDE8263/Golden-Gate-Bridge-San-Francisco.jpg")

>>> processor = AutoProcessor.from_pretrained("HuggingFaceM4/Idefics3-8B-Llama3")
>>> model = AutoModelForVision2Seq.from_pretrained("HuggingFaceM4/Idefics3-8B-Llama3", torch_dtype=torch.bfloat16, device_map="auto")

>>> # Create inputs
>>> messages = [
...     {
...         "role": "user",
...         "content": [
...             {"type": "image"},
...             {"type": "text", "text": "In this image, we can see the city of New York, and more specifically the Statue of Liberty."},
...             {"type": "image"},
...             {"type": "text", "text": "What can we see in this image?"},
...         ]
...     },
...     {
...         "role": "user",
...         "content": [
...             {"type": "image"},
...             {"type": "text", "text": "In which city is that bridge located?"},
...         ]
...     }
... ]

>>> prompts = [processor.apply_chat_template([message], add_generation_prompt=True) for message in messages]
>>> images = [[image1, image2], [image3]]
>>> inputs = processor(text=prompts, images=images, padding=True, return_tensors="pt").to(model.device)

>>> # Generate
>>> generated_ids = model.generate(**inputs, max_new_tokens=256)
>>> generated_texts = processor.batch_decode(generated_ids, skip_special_tokens=True)

>>> print(generated_texts[0])
Assistant: There are buildings, trees, lights, and water visible in this image.

>>> print(generated_texts[1])
Assistant: The bridge is in San Francisco.

Idefics3ImageProcessor

class transformers.Idefics3ImageProcessor

< >

( do_convert_rgb: bool = True do_resize: bool = True size: typing.Optional[dict[str, int]] = None resample: Resampling = <Resampling.LANCZOS: 1> do_image_splitting: bool = True max_image_size: typing.Optional[dict[str, int]] = None do_rescale: bool = True rescale_factor: float = 0.00392156862745098 do_normalize: bool = True image_mean: typing.Union[float, list[float], NoneType] = None image_std: typing.Union[float, list[float], NoneType] = None do_pad: bool = True **kwargs )

参数

  • do_convert_rgb (bool, 可选, 默认为 True) — 是否将图像转换为 RGB。如果输入图像是不同格式（例如 RGBA），这将非常有用。仅当输入图像为 PIL 格式时有效。
  • do_resize (bool, 可选, 默认为 True) — 是否调整图像大小。图像的最长边将调整为 <= size["longest_edge"]，最短边将调整以保持输入宽高比。
  • size (Dict, 可选, 默认为 {"longest_edge" -- 4 * 364}): 控制输出图像的大小。这是一个包含键“longest_edge”的字典。图像将被调整大小，使得最长边 <= size["longest_edge"]，最短边将调整以保持输入宽高比。
  • resample (Resampling, 可选, 默认为 Resampling.LANCZOS) — 调整图像大小时使用的重采样滤波器。
  • do_image_splitting (bool, 可选, 默认为 True) — 是否将图像分割成与原始图像连接的子图像。它们被分割成补丁，使得每个补丁的大小为 max_image_size["height"] x max_image_size["width"]。
  • max_image_size (Dict, 可选, 默认为 {"longest_edge" -- 364}): 模型接受的图像补丁的最大分辨率。这是一个包含键“longest_edge”的字典。
  • do_rescale (bool, 可选, 默认为 True) — 是否重新缩放图像。如果设置为 True，图像将被重新缩放，使其像素值在 0 和 1 之间。
  • rescale_factor (float, 可选, 默认为 1/255) — 如果 do_rescale 设置为 True，用于重新缩放图像的缩放因子。
  • do_normalize (bool, 可选, 默认为 True) — 是否对图像进行归一化。如果设置为 True，图像将被归一化，使其均值为 image_mean，标准差为 image_std。
  • image_mean (float 或 list[float], 可选, 默认为 IDEFICS_STANDARD_MEAN) — 如果对图像进行归一化，使用的均值。这是一个浮点数或长度等于图像通道数的浮点数列表。可以在 preprocess 方法中被 image_mean 参数覆盖。
  • image_std (float 或 list[float], 可选, 默认为 IDEFICS_STANDARD_STD) — 如果对图像进行归一化，使用的标准差。这是一个浮点数或长度等于图像通道数的浮点数列表。可以在 preprocess 方法中被 image_std 参数覆盖。
  • do_pad (bool, 可选, 默认为 True) — 是否将图像填充到批次中最大的高度和宽度以及批次中每个样本的图像数量，使得返回的张量形状为 (batch_size, max_num_images, num_channels, max_height, max_width)。

构建一个 Idefics3 图像处理器。

预处理

< >

( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']] do_convert_rgb: typing.Optional[bool] = None do_resize: typing.Optional[bool] = None size: typing.Optional[dict[str, int]] = None resample: Resampling = None do_image_splitting: typing.Optional[bool] = None do_rescale: typing.Optional[bool] = None max_image_size: typing.Optional[dict[str, int]] = None rescale_factor: typing.Optional[float] = None do_normalize: typing.Optional[bool] = None image_mean: typing.Union[float, list[float], NoneType] = None image_std: typing.Union[float, list[float], NoneType] = None do_pad: typing.Optional[bool] = None return_tensors: typing.Union[str, transformers.utils.generic.TensorType, NoneType] = None return_row_col_info: bool = False data_format: typing.Optional[transformers.image_utils.ChannelDimension] = <ChannelDimension.FIRST: 'channels_first'> input_data_format: typing.Union[str, transformers.image_utils.ChannelDimension, NoneType] = None )

参数

  • images (ImageInput) — 要预处理的图像列表。
  • do_convert_rgb (bool, 可选, 默认为 self.do_convert_rgb) — 是否将图像转换为 RGB。
  • do_resize (bool, 可选, 默认为 self.do_resize) — 是否调整图像大小。
  • size (dict[str, int], 可选, 默认为 self.size) — 调整大小后的图像尺寸。最长边会调整以保持输入宽高比。
  • resample (int, 可选, 默认为 self.resample) — 如果调整图像大小，使用的重采样滤波器。这可以是 PILImageResampling 枚举之一。仅当 do_resize 设置为 True 时有效。
  • do_image_splitting (bool, 可选, 默认为 self.do_image_splitting) — 是否将图像分割成与原始图像连接的子图像。它们被分割成补丁，使得每个补丁的大小为 max_image_size["height"] x max_image_size["width"]。
  • max_image_size (Dict, 可选, 默认为 self.max_image_size) — 图像的最大分辨率。如果图像大于此尺寸，图像将被分割成补丁。
  • do_rescale (bool, 可选, 默认为 self.do_rescale) — 是否重新缩放图像。
  • rescale_factor (float, 可选, 默认为 self.rescale_factor) — 如果 do_rescale 设置为 True，用于缩放图像的缩放因子。
  • do_normalize (bool, 可选, 默认为 self.do_normalize) — 是否对图像进行归一化。
  • image_mean (float 或 list[float], 可选, 默认为 self.image_mean) — 用于归一化的图像均值。仅在 do_normalize 设置为 True 时生效。
  • image_std (float 或 list[float], 可选, 默认为 self.image_std) — 用于归一化的图像标准差。仅在 do_normalize 设置为 True 时生效。
  • do_pad (bool, 可选, 默认为 self.do_pad) — 是否将图像填充到批次中最大的高度和宽度。
  • return_tensors (str 或 TensorType, 可选) — 要返回的张量类型。可以是以下之一：
    • 未设置：返回一个 np.ndarray 列表。
    • TensorType.TENSORFLOW 或 'tf'：返回一个 tf.Tensor 类型的批次。
    • TensorType.PYTORCH 或 'pt'：返回一个 torch.Tensor 类型的批次。
    • TensorType.NUMPY 或 'np'：返回一个 np.ndarray 类型的批次。
    • TensorType.JAX 或 'jax'：返回一个 jax.numpy.ndarray 类型的批次。
  • return_row_col_info (bool, 可选, 默认为 False) — 是否返回分割后图像的行数和列数。这用于 Idefics3Processor 根据行数和列数生成提示字符串。
  • data_format (ChannelDimension 或 str, 可选, 默认为 ChannelDimension.FIRST) — 输出图像的通道维度格式。可以是以下之一：
    • "channels_first" 或 ChannelDimension.FIRST：图像格式为 (num_channels, height, width)。
    • "channels_last" 或 ChannelDimension.LAST：图像格式为 (height, width, num_channels)。
    • 未设置：使用输入图像的通道维度格式。
  • input_data_format (ChannelDimension 或 str, 可选) — 输入图像的通道维度格式。如果未设置，则从输入图像中推断通道维度格式。可以是以下之一：
    • "channels_first" 或 ChannelDimension.FIRST：图像格式为 (num_channels, height, width)。
    • "channels_last" 或 ChannelDimension.LAST：图像格式为 (height, width, num_channels)。
    • "none" 或 ChannelDimension.NONE：图像格式为 (height, width)。

预处理一批图像。

Idefics3ImageProcessorFast

class transformers.Idefics3ImageProcessorFast

< >

( **kwargs: typing_extensions.Unpack[transformers.image_processing_utils_fast.DefaultFastImageProcessorKwargs] )

构建一个快速的 Idefics3 图像处理器。

预处理

< >

( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']] **kwargs: typing_extensions.Unpack[transformers.models.idefics3.image_processing_idefics3_fast.Idefics3FastImageProcessorKwargs] ) → <class 'transformers.image_processing_base.BatchFeature'>

参数

  • images (Union[PIL.Image.Image, numpy.ndarray, torch.Tensor, list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']]) — 待预处理的图像。需要单个或一批像素值在 0 到 255 范围内的图像。如果传入像素值在 0 到 1 之间的图像，请设置 do_rescale=False。
  • do_resize (bool, 可选) — 是否调整图像大小。
  • size (dict[str, int], 可选) — 描述模型的最大输入尺寸。
  • default_to_square (bool, 可选) — 如果 size 是一个整数，在调整大小时是否默认为方形图像。
  • resample (Union[PILImageResampling, F.InterpolationMode, NoneType]) — 如果调整图像大小，要使用的重采样过滤器。这可以是 PILImageResampling 枚举之一。仅在 do_resize 设置为 True 时生效。
  • do_center_crop (bool, 可选) — 是否对图像进行中心裁剪。
  • crop_size (dict[str, int], 可选) — 应用 center_crop 后输出图像的大小。
  • do_rescale (bool, 可选) — 是否对图像进行缩放。
  • rescale_factor (Union[int, float, NoneType]) — 如果 do_rescale 设置为 True，用于缩放图像的缩放因子。
  • do_normalize (bool, 可选) — 是否对图像进行归一化。
  • image_mean (Union[float, list[float], NoneType]) — 用于归一化的图像均值。仅在 do_normalize 设置为 True 时生效。
  • image_std (Union[float, list[float], NoneType]) — 用于归一化的图像标准差。仅在 do_normalize 设置为 True 时生效。
  • do_convert_rgb (bool, 可选) — 是否将图像转换为 RGB。
  • return_tensors (Union[str, ~utils.generic.TensorType, NoneType]) — 如果设置为 `pt`，则返回堆叠的张量，否则返回张量列表。
  • data_format (~image_utils.ChannelDimension, 可选) — 仅支持 ChannelDimension.FIRST。为与慢速处理器兼容而添加。
  • input_data_format (Union[str, ~image_utils.ChannelDimension, NoneType]) — 输入图像的通道维度格式。如果未设置，则从输入图像中推断通道维度格式。可以是以下之一：
    • "channels_first" 或 ChannelDimension.FIRST：图像格式为 (num_channels, height, width)。
    • "channels_last" 或 ChannelDimension.LAST：图像格式为 (height, width, num_channels)。
    • "none" 或 ChannelDimension.NONE：图像格式为 (height, width)。
  • device (torch.device, 可选) — 处理图像的设备。如果未设置，则从输入图像中推断设备。
  • disable_grouping (bool, 可选) — 是否禁用按大小对图像进行分组，以便单独处理而不是批量处理。如果为 None，则在图像位于 CPU 上时将设置为 True，否则设置为 False。此选择基于经验观察，详情请见：https://github.com/huggingface/transformers/pull/38157
  • do_pad (bool, 可选) — 是否填充图像。如果为 True，将把批次中图像的补丁维度填充到批次中最大的补丁数。将使用零在底部和右侧进行填充。
  • do_image_splitting (bool, 可选, 默认为 True) — 是否将图像分割成与原始图像拼接的子图像。它们被分割成补丁，使得每个补丁的大小为 max_image_size["height"] x max_image_size["width"]。
  • max_image_size (Dict, 可选, 默认为 {"longest_edge" -- 364}): 模型接受的图像补丁的最大分辨率。这是一个包含键“longest_edge”的字典。
  • return_row_col_info (bool, 可选, 默认为 False) — 是否返回图像的行和列信息。

返回

<class 'transformers.image_processing_base.BatchFeature'>

  • data (dict) — 由 call 方法返回的列表/数组/张量字典（“pixel_values”等）。
  • tensor_type (Union[None, str, TensorType], 可选) — 您可以在此处提供一个`tensor_type`，以便在初始化时将整数列表转换为PyTorch/TensorFlow/Numpy张量。

Idefics3Processor

class transformers.Idefics3Processor

< >

( image_processor tokenizer = None image_seq_len: int = 169 chat_template: typing.Optional[str] = None **kwargs )

参数

  • image_processor (Idefics3ImageProcessor) — Idefics3ImageProcessor 的一个实例。图像处理器是必需的输入。
  • tokenizer (PreTrainedTokenizerBase, 可选) — PreTrainedTokenizerBase 的一个实例。这应与模型的文本模型相对应。分词器是必需的输入。
  • image_seq_len (int, 可选, 默认为 169) — 图像序列的长度，即输入中每个图像的 标记数。此参数用于根据输入提示和图像标记构建字符串，并应与模型使用的值匹配。其计算公式为：image_seq_len = int(((image_size // patch_size) ** 2) / (scale_factor**2))
  • chat_template (str, 可选) — 一个 Jinja 模板，用于将聊天中的消息列表转换为可分词的字符串。

构建一个 Idefics3 处理器，它将 LLama 分词器和 Idefics3 图像处理器包装成一个单一的处理器。

Idefics3Processor 提供了 Idefics3ImageProcessor 和 Idefics3TokenizerFast 的所有功能。有关更多信息，请参阅 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'], list[typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']]], list[list[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, ForwardRef('PreTokenizedInput'), list[str], list['PreTokenizedInput']] = None audio = None videos = None image_seq_len: typing.Optional[int] = None **kwargs: typing_extensions.Unpack[transformers.models.idefics3.processing_idefics3.Idefics3ProcessorKwargs] )

参数

  • images (PIL.Image.Image, np.ndarray, torch.Tensor, list[PIL.Image.Image], list[np.ndarray], list[torch.Tensor], 可选) — 要准备的图像或图像批次。每个图像可以是 PIL 图像、NumPy 数组或 PyTorch 张量。如果是 list[ImageInput] 类型，则假定这是用于单个提示，即批次大小为 1。
  • text (Union[TextInput, PreTokenizedInput, list[TextInput], list[PreTokenizedInput]], 可选) — 要编码的序列或序列批次。每个序列可以是一个字符串或一个字符串列表（预分词的字符串）。如果序列以字符串列表（预分词）的形式提供，您必须设置 `is_split_into_words=True`（以消除与序列批次的歧义）。每当遇到图像标记 `<image>` 时，它会被扩展为 `<fake_token_around_image>` + `<row_x_col_y>` + `<image>` * `image_seq_len` * `<fake_token_around_image>`。
  • image_seq_len (int, 可选) — 图像序列的长度。如果未提供，则使用 self.image_seq_len 的默认值。image_seq_len 应等于 int(((image_size // patch_size) ** 2) / (scale_factor**2))
  • return_tensors (Union[str, TensorType], 可选) — 如果设置，将返回特定框架的张量。有关更多信息，请参阅 PreTrainedTokenizerFast.call()。

处理输入提示并返回BatchEncoding。

示例

>>> import requests
>>> from transformers import Idefics3Processor
>>> from transformers.image_utils import load_image

>>> processor = Idefics3Processor.from_pretrained("HuggingFaceM4/Idefics3-8B-Llama3")
>>> processor.image_processor.do_image_splitting = False  # Force as False to simplify the example

>>> url1 = "https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg"
>>> url2 = "https://cdn.britannica.com/59/94459-050-DBA42467/Skyline-Chicago.jpg"

>>> image1, image2 = load_image(url1), load_image(url2)
>>> images = [[image1], [image2]]

>>> text = [
...     "<image>In this image, we see",
...     "bla bla bla<image>",
... ]
>>> outputs = processor(images=images, text=text, return_tensors="pt", padding=True)
>>> input_ids = outputs.input_ids
>>> input_tokens = processor.tokenizer.batch_decode(input_ids)
>>> print(input_tokens)
['<|begin_of_text|><fake_token_around_image><global-img>((<image>)*169)<fake_token_around_image> In this image, we see', '<|reserved_special_token_0|><|reserved_special_token_0|><|reserved_special_token_0|><|begin_of_text|>bla bla bla<fake_token_around_image><global-img>((<image>)*169)<fake_token_around_image>']
< > 在 GitHub 上更新

←Idefics2 InstructBLIP→