IDEFICS

概述

IDEFICS 模型在 OBELICS: An Open Web-Scale Filtered Dataset of Interleaved Image-Text Documents 中被提出，作者是 Hugo Laurençon, Lucile Saulnier, Léo Tronchon, Stas Bekman, Amanpreet Singh, Anton Lozhkov, Thomas Wang, Siddharth Karamcheti, Alexander M. Rush, Douwe Kiela, Matthieu Cord, Victor Sanh

论文摘要如下：

在自然文档（交错排列图像和文本）上训练的大型多模态模型，在各种需要对一个或多个图像进行推理以生成文本的多模态基准测试中，性能优于在图像-文本对上训练的模型。然而，用于训练这些模型的数据集尚未发布，并且收集过程尚未完全明确。我们介绍了 OBELICS 数据集，这是一个开放的网络规模过滤数据集，包含 1.41 亿个从 Common Crawl 提取的网页、3.53 亿张关联图像和 1150 亿个文本标记。我们描述了数据集的创建过程，提出了全面的过滤规则，并对数据集的内容进行了分析。为了展示 OBELISC 的可行性，我们在该数据集上训练了一个 800 亿参数的视觉和语言模型，并在各种多模态基准测试中获得了具有竞争力的性能。我们发布了用于重现数据集的代码以及数据集本身。

此模型由 HuggingFaceM4 贡献。原始代码可以在此处找到。（待办事项：尚无公开链接）。

Transformers 中的 IDEFICS 建模代码用于微调和推理预训练的 IDEFICS 模型。

要从头开始训练新的 IDEFICS 模型，请使用 m4 代码库（一旦公开，将提供链接）

IdeficsConfig

class transformers.IdeficsConfig

< source >

( vocab_size = 32000 additional_vocab_size = 0 hidden_size = 4096 intermediate_size = 11008 num_hidden_layers = 32 num_attention_heads = 32 dropout = 0.0 hidden_act = 'silu' initializer_range = 0.02 alpha_initializer = 'zeros' alphas_initializer_range = 0.0 alpha_type = 'float' rms_norm_eps = 1e-06 use_cache = True pad_token_id = 0 bos_token_id = 1 eos_token_id = 2 tie_word_embeddings = False cross_layer_interval = 1 qk_layer_norms = False freeze_text_layers = True freeze_text_module_exceptions = [] freeze_lm_head = False freeze_vision_layers = True freeze_vision_module_exceptions = [] use_resampler = False vision_config = None perceiver_config = None **kwargs )

参数

additional_vocab_size (int, 可选, 默认为 0) — 模型的额外词汇量大小，通常用于特殊的“”标记。额外的词汇标记始终是可训练的，而常规词汇标记可以冻结或不冻结。
vocab_size (int, 可选, 默认为 32000) — Idefics 模型的词汇量大小。定义了在调用 ~IdeficsModel 时传递的 inputs_ids 可以表示的不同标记的数量。
hidden_size (int, 可选, 默认为 4096) — 隐藏层表示的维度。
intermediate_size (int, 可选, 默认为 11008) — MLP 表示的维度。
num_hidden_layers (int, 可选, 默认为 32) — Transformer 编码器中隐藏层的数量。
num_attention_heads (int, 可选, 默认为 32) — Transformer 编码器中每个注意力层的注意力头数。
dropout (float, 可选, 默认为 0.0) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。
hidden_act (str 或 function, 可选, 默认为 "silu") — 解码器中的非线性激活函数（函数或字符串）。
initializer_range (float, 可选, 默认为 0.02) — truncated_normal_initializer 的标准差，用于初始化所有权重矩阵。
alpha_initializer (str, 可选, 默认为 "zeros") — alphas 的初始化类型。
alphas_initializer_range (float, 可选, 默认为 0.0) — 用于初始化门控交叉注意力中 alphas 的 truncated_normal_initializer 的标准差。
alpha_type (str, 可选, 默认为 "float") — 门控 alphas 应该是向量还是单个浮点数。
rms_norm_eps (float, 可选, 默认为 1e-6) — rms 归一化层使用的 epsilon 值。
use_cache (bool, 可选, 默认为 True) — 模型是否应返回最后一次的键/值注意力（并非所有模型都使用）。仅当 config.is_decoder=True 时相关。
pad_token_id (int, 可选, 默认为 0) — 填充 token id。
bos_token_id (int, 可选, 默认为 1) — 流开始 token id。
eos_token_id (int, 可选, 默认为 2) — 流结束 token id。
tie_word_embeddings(bool, 可选, 默认为 False) — 是否绑定权重 embedding
cross_layer_interval (int, 可选, 默认为 1) — 跨层注意力（从文本到图像）层的间隔。
qk_layer_norms (bool, 可选, 默认为 False) — 是否在 q 和 k 之后添加层归一化
freeze_text_layers (bool, 可选, 默认为 True) — 是否冻结文本层
freeze_text_module_exceptions (bool, 可选, 默认为 []) — 当 freeze_text_layers 为 True 时，冻结文本层的例外情况
freeze_lm_head (bool, 可选, 默认为 False) — 是否冻结 lm head
freeze_vision_layers (bool, 可选, 默认为 True) — 是否冻结视觉层
freeze_vision_module_exceptions (bool, 可选, 默认为 []) — 当 freeze_vision_layers 为 True 时，冻结视觉层的例外情况
use_resampler (bool, 可选, 默认为 False) — 是否使用 Resampler
vision_config (IdeficsVisionConfig, 可选) — 自定义视觉配置或字典
perceiver_config (IdeficsPerceiverConfig, 可选) — 自定义 perceiver 配置或字典

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

例如：HuggingFaceM4/idefics-9b

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

示例

>>> from transformers import IdeficsModel, IdeficsConfig

>>> # Initializing a Idefics idefics-9b style configuration
>>> configuration = IdeficsConfig()

>>> # Initializing a model from the idefics-9b style configuration
>>> model = IdeficsModel(configuration)

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

IdeficsModel

class transformers.IdeficsModel

< source >

( config: IdeficsConfig )

参数

config (IdeficsConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
config — IdeficsConfig

裸 LLaMA 模型，输出原始隐藏状态，顶部没有任何特定的 head。此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如，下载或保存、调整输入 embedding 大小、剪枝 head 等）。

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

由 config.num_hidden_layers 层组成的 Transformer 解码器。每一层都是 IdeficsDecoderLayer

forward

< source >

( input_ids: LongTensor = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[typing.List[torch.FloatTensor]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None pixel_values: typing.Optional[torch.FloatTensor] = None image_encoder_embeddings: typing.Optional[torch.FloatTensor] = None perceiver_embeddings: typing.Optional[torch.FloatTensor] = None image_attention_mask: 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: typing.Optional[bool] = False return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None )

参数

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

索引可以使用 AutoTokenizer 获得。请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 了解详细信息。

什么是输入 IDs？
attention_mask (torch.Tensor，形状为 (batch_size, sequence_length), 可选) — 掩码，以避免对 padding token 索引执行注意力机制。掩码值在 [0, 1] 中选择：
- 1 表示 token 未被掩盖，
- 0 表示 token 被掩盖。
什么是注意力掩码？

索引可以使用 AutoTokenizer 获得。请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 了解详细信息。

如果使用 past_key_values，则可以选择仅输入最后一个 decoder_input_ids（请参阅 past_key_values）。

如果您想更改 padding 行为，您应该阅读 modeling_opt._prepare_decoder_attention_mask 并根据您的需要进行修改。有关默认策略的更多信息，请参阅论文中的图 1。
- 1 表示 head 未被掩盖，
- 0 表示 head 被掩盖。
position_ids (torch.LongTensor, 形状为 (batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。范围为 [0, config.n_positions - 1]。什么是位置 ID？
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) 的张量和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

包含预先计算的隐藏状态（自注意力模块和交叉注意力模块中的键和值），可以用于加速顺序解码（参见 past_key_values 输入）。

如果使用 past_key_values，用户可以选择仅输入最后的 decoder_input_ids（那些没有将其过去的键值状态提供给此模型的）形状为 (batch_size, 1)，而不是所有形状为 (batch_size, sequence_length) 的 decoder_input_ids。
inputs_embeds (torch.FloatTensor, 形状为 (batch_size, sequence_length, hidden_size)，可选) — （可选）您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联的向量，这将非常有用。
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 相反，此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整序列长度。

IdeficsModel 的 forward 方法，覆盖了 __call__ 特殊方法。

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

IdeficsForVisionText2Text

class transformers.IdeficsForVisionText2Text

< source >

( config vision_model = None )

forward

< source >

( input_ids: LongTensor = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[typing.List[torch.FloatTensor]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None pixel_values: typing.Optional[torch.FloatTensor] = None image_encoder_embeddings: typing.Optional[torch.FloatTensor] = None perceiver_embeddings: typing.Optional[torch.FloatTensor] = None image_attention_mask: 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 interpolate_pos_encoding: typing.Optional[bool] = False return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None ) → transformers.models.idefics.modeling_idefics.IdeficsCausalLMOutputWithPast 或 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 表示被掩盖的标记。
什么是注意力掩码？

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

如果使用 past_key_values，则可以选择仅输入最后的 decoder_input_ids（参见 past_key_values）。

如果您想更改填充行为，则应阅读 modeling_opt._prepare_decoder_attention_mask 并根据您的需要进行修改。有关默认策略的更多信息，请参见论文中的图 1。
- 1 表示 head 未被掩盖，
- 0 表示 head 被掩盖。
position_ids (torch.LongTensor, 形状为 (batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。范围为 [0, config.n_positions - 1]。什么是位置 ID？
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) 的张量和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

包含预先计算的隐藏状态（自注意力模块和交叉注意力模块中的键和值），可以用于加速顺序解码（参见 past_key_values 输入）。

如果使用 past_key_values，用户可以选择仅输入最后的 decoder_input_ids（那些没有将其过去的键值状态提供给此模型的）形状为 (batch_size, 1)，而不是所有形状为 (batch_size, sequence_length) 的 decoder_input_ids。
inputs_embeds (torch.FloatTensor, 形状为 (batch_size, sequence_length, hidden_size)，可选) — （可选）您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联的向量，这将非常有用。
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)，可选) — 索引，描述输入序列 tokens 在序列中的位置。与 position_ids 相反，此张量不受 padding 的影响。它用于在正确的位置更新缓存，并推断完整的序列长度。
labels (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 用于计算 masked language modeling loss 的标签。索引应为 [0, ..., config.vocab_size] 或 -100（请参阅 input_ids 文档字符串）。索引设置为 -100 的 tokens 将被忽略（masked），loss 仅针对标签在 [0, ..., config.vocab_size] 中的 tokens 计算。

transformers.models.idefics.modeling_idefics.IdeficsCausalLMOutputWithPast 或 tuple(torch.FloatTensor)

一个 transformers.models.idefics.modeling_idefics.IdeficsCausalLMOutputWithPast 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (IdeficsConfig) 和输入。

loss (torch.FloatTensor，形状为 (1,)，可选，当提供 labels 时返回) — 语言建模 loss（用于下一个 token 预测）。
logits (torch.FloatTensor，形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前每个词汇 token 的分数）。
past_key_values (tuple(tuple(torch.FloatTensor))，可选，当传递了 use_cache=True 或当 config.use_cache=True 时返回) — tuple(torch.FloatTensor) 的元组，长度为 config.n_layers，每个元组包含 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 (tuple(torch.FloatTensor)，可选) — torch.FloatTensor 的元组（图像嵌入的输出之一，(batch_size, num_images, sequence_length, hidden_size)。

视觉编码器以及可选的 perceiver 生成的模型 image_hidden_states

IdeficsForVisionText2Text forward 方法，覆盖了 __call__ 特殊方法。

示例

>>> from transformers import AutoProcessor, IdeficsForVisionText2Text

>>> model = IdeficsForVisionText2Text.from_pretrained("HuggingFaceM4/idefics-9b")
>>> processor = AutoProcessor.from_pretrained("HuggingFaceM4/idefics-9b")

>>> dogs_image_url_1 = "https://huggingface.co/datasets/hf-internal-testing/fixtures_nlvr2/raw/main/image1.jpeg"
>>> dogs_image_url_2 = "https://huggingface.co/datasets/hf-internal-testing/fixtures_nlvr2/raw/main/image2.jpeg"

>>> prompts = [
...     [
...         "User:",
...         dogs_image_url_1,
...         "Describe this image.\nAssistant: An image of two dogs.\n",
...         "User:",
...         dogs_image_url_2,
...         "Describe this image.\nAssistant:",
...     ]
... ]
>>> inputs = processor(prompts, return_tensors="pt")
>>> generate_ids = model.generate(**inputs, max_new_tokens=6)
>>> processor.batch_decode(generate_ids, skip_special_tokens=True)

TFIdeficsModel

class transformers.TFIdeficsModel

< source >

( config: IdeficsConfig *inputs **kwargs )

call

< source >

( input_ids: TFModelInputType | None = None attention_mask: Optional[tf.Tensor] = None position_ids: Optional[tf.Tensor] = None past_key_values: Optional[List[tf.Tensor]] = None inputs_embeds: Optional[tf.Tensor] = None pixel_values: Optional[tf.Tensor] = None image_encoder_embeddings: Optional[tf.Tensor] = None perceiver_embeddings: Optional[tf.Tensor] = None image_attention_mask: Optional[tf.Tensor] = None use_cache: Optional[bool] = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None interpolate_pos_encoding: Optional[bool] = False return_dict: Optional[bool] = None training: Optional[bool] = None )

TFIdeficsForVisionText2Text

class transformers.TFIdeficsForVisionText2Text

< source >

( config vision_model = None **kwargs )

call

< source >

( input_ids: TFModelInputType | None = None attention_mask: Optional[tf.Tensor] = None position_ids: Optional[tf.Tensor] = None past_key_values: Optional[List[tf.Tensor]] = None inputs_embeds: Optional[tf.Tensor] = None pixel_values: Optional[tf.Tensor] = None image_encoder_embeddings: Optional[tf.Tensor] = None perceiver_embeddings: Optional[tf.Tensor] = None image_attention_mask: Optional[tf.Tensor] = None labels: Optional[tf.Tensor] = None use_cache: Optional[bool] = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None interpolate_pos_encoding: Optional[bool] = False return_dict: Optional[bool] = None training = False ) → transformers.models.idefics.modeling_tf_idefics.TFIdeficsCausalLMOutputWithPast 或 tuple(tf.Tensor)

参数

input_ids (形状为 (batch_size, sequence_length) 的 tf.Tensor) — 词汇表中输入序列 tokens 的索引。如果您提供 padding，默认情况下 padding 将被忽略。

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

什么是输入 IDs？
attention_mask (形状为 (batch_size, sequence_length) 的 tf.Tensor，可选) — Mask，用于避免对 padding token 索引执行注意力机制。 Mask 值在 [0, 1] 中选择：
- 1 表示 tokens 未被 masked，
- 0 表示 tokens 被 masked。
什么是注意力 masks？

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

如果使用 past_key_values，则可以选择仅输入最后的 decoder_input_ids（参见 past_key_values）。

如果您想更改 padding 行为，则应阅读 modeling_opt._prepare_decoder_attention_mask 并根据您的需要进行修改。有关默认策略的更多信息，请参见论文中的图 1。
- 1 表示 head 未被 masked，
- 0 表示 head 被 masked。
position_ids (形状为 (batch_size, sequence_length) 的 tf.Tensor，可选) — 每个输入序列 tokens 在位置嵌入中的位置索引。在范围 [0, config.n_positions - 1] 中选择。什么是位置 IDs？
past_key_values (tuple(tuple(tf.Tensor))，可选，当传递了 use_cache=True 或当 config.use_cache=True 时返回) — tuple(tf.Tensor) 的元组，长度为 config.n_layers，每个元组包含 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)，而不是所有形状为 (batch_size, sequence_length) 的 decoder_input_ids。
inputs_embeds (形状为 (batch_size, sequence_length, hidden_size) 的 tf.Tensor，可选) — （可选）您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望更好地控制如何将 input_ids 索引转换为关联向量，而不是模型的内部嵌入查找矩阵，这将非常有用。
use_cache (bool，可选) — 如果设置为 True，则返回 past_key_values 键值状态，并且可以用于加速解码（请参阅 past_key_values）。
output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的 attentions。
output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的 hidden_states。
return_dict (bool，可选) — 是否返回 ModelOutput 而不是普通元组。
labels (形状为 (batch_size, sequence_length) 的 tf.Tensor，可选) — 用于计算 masked language modeling loss 的标签。索引应为 [0, ..., config.vocab_size] 或 -100（请参阅 input_ids 文档字符串）。索引设置为 -100 的 tokens 将被忽略（masked），loss 仅针对标签在 [0, ..., config.vocab_size] 中的 tokens 计算。

transformers.models.idefics.modeling_tf_idefics.TFIdeficsCausalLMOutputWithPast 或 tuple(tf.Tensor)

一个 transformers.models.idefics.modeling_tf_idefics.TFIdeficsCausalLMOutputWithPast 或 tf.Tensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (IdeficsConfig) 和输入。

loss (形状为 (1,) 的 tf.Tensor，可选，当提供 labels 时返回) — 语言建模 loss（用于下一个 token 预测）。
logits (形状为 (batch_size, sequence_length, config.vocab_size) 的 tf.Tensor) — 语言建模头的预测分数（SoftMax 之前每个词汇 token 的分数）。
past_key_values (tuple(tuple(tf.Tensor))，可选，当传递了 use_cache=True 或当 config.use_cache=True 时返回) — tuple(tf.Tensor) 的元组，长度为 config.n_layers，每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量）

包含预先计算的隐藏状态（自注意力模块中的键和值），可以用于（参见 past_key_values 输入）加速顺序解码。
hidden_states (tuple(tf.Tensor)，可选，当传递了 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — tf.Tensor 的元组（如果模型具有嵌入层，则为嵌入输出之一，+ 每层输出一个）形状为 (batch_size, sequence_length, hidden_size)。

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

注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
image_hidden_states (tuple(tf.Tensor)，可选) — tf.Tensor 的元组（图像嵌入的输出之一，(batch_size, num_images, sequence_length, hidden_size)。

视觉编码器以及可选的 perceiver 生成的模型 image_hidden_states

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

示例

>> from transformers import AutoTokenizer, TFIdeficsForVisionText2Text

>> model = TFIdeficsForVisionText2Text.from_pretrained("HuggingFaceM4/idefics-9b")
>> tokenizer = AutoTokenizer.from_pretrained("HuggingFaceM4/idefics-9b")

>> prompt = "Hey, are you consciours? Can you talk to me?"
>> inputs = tokenizer(prompt, return_tensors="tf")

>> # Generate
>> generate_ids = model.generate(inputs.input_ids, max_length=30)
>> tokenizer.batch_decode(generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
"Hey, are you consciours? Can you talk to me?\nI'm not consciours, but I can talk to you."

IdeficsImageProcessor

class transformers.IdeficsImageProcessor

< source >

( image_size: int = 224 image_mean: typing.Union[float, typing.List[float], NoneType] = None image_std: typing.Union[float, typing.List[float], NoneType] = None image_num_channels: typing.Optional[int] = 3 **kwargs )

参数

image_size (int, 可选, 默认为 224) — 调整图像大小为 image size
image_mean (float 或 List[float], 可选, 默认为 IDEFICS_STANDARD_MEAN) — 如果要标准化图像，则使用的均值。这是一个浮点数或浮点数列表，其长度为图像中的通道数。可以被 preprocess 方法中的 image_mean 参数覆盖。可以被 preprocess 方法中的 image_mean 参数覆盖。
image_std (float 或 List[float], 可选, 默认为 IDEFICS_STANDARD_STD) — 如果要标准化图像，则使用的标准差。这是一个浮点数或浮点数列表，其长度为图像中的通道数。可以被 preprocess 方法中的 image_std 参数覆盖。可以被 preprocess 方法中的 image_std 参数覆盖。
image_num_channels (int, 可选, 默认为 3) — 图像通道数。

构建 Idefics 图像处理器。

preprocess

< source >

( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']] image_num_channels: typing.Optional[int] = 3 image_size: typing.Optional[typing.Dict[str, int]] = None image_mean: typing.Union[float, typing.List[float], NoneType] = None image_std: typing.Union[float, typing.List[float], NoneType] = None transform: typing.Callable = None return_tensors: typing.Union[str, transformers.utils.generic.TensorType, NoneType] = <TensorType.PYTORCH: 'pt'> **kwargs )

参数

images (ImageInput) — 要预处理的图像列表。
image_size (int, 可选, 默认为 self.image_size) — 调整图像大小为 image size
image_num_channels (int, 可选, 默认为 self.image_num_channels) — 图像通道数。
image_mean (float 或 List[float], 可选, 默认为 IDEFICS_STANDARD_MEAN) — 如果要标准化图像，则使用的均值。这是一个浮点数或浮点数列表，其长度为图像中的通道数。可以被 preprocess 方法中的 image_mean 参数覆盖。可以被 preprocess 方法中的 image_mean 参数覆盖。
image_std (float 或 List[float], 可选, 默认为 IDEFICS_STANDARD_STD) — 如果要标准化图像，则使用的标准差。这是一个浮点数或浮点数列表，其长度为图像中的通道数。可以被 preprocess 方法中的 image_std 参数覆盖。可以被 preprocess 方法中的 image_std 参数覆盖。
transform (Callable, 可选, 默认为 None) — 一个自定义的转换函数，它接受单个图像，可用于训练。例如，torchvision.Compose 可用于组合多个转换。如果为 None - 则假定为推理模式 - 然后将一组预设的特定于推理的转换应用于图像

预处理一批图像。

IdeficsProcessor

class transformers.IdeficsProcessor

< source >

( image_processor tokenizer = None image_size = 224 add_end_of_utterance_token = None **kwargs )

参数

image_processor (IdeficsImageProcessor) — IdeficsImageProcessor 的一个实例。图像处理器是必需的输入。
tokenizer (LlamaTokenizerFast) — LlamaTokenizerFast 的一个实例。tokenizer 是必需的输入。
image_size (int, 可选, 默认为 224) — 图像大小（假设为正方形图像）
add_end_of_utterance_token (str, 可选) — 表示话语结束的 token 的字符串表示形式

构建一个 IDEFICS 处理器，它将 LLama tokenizer 和 IDEFICS 图像处理器包装到一个处理器中。

IdeficsProcessor 提供了 IdeficsImageProcessor 和 LlamaTokenizerFast 的所有功能。有关更多信息，请参阅 call() 和 decode() 的文档字符串。

call

< source >

( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor'], typing.List[typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']]], str, typing.List[str], typing.List[typing.List[str]]] = None text: typing.Union[str, typing.List[str], typing.List[typing.List[str]], typing.List[typing.List[typing.List[str]]]] = None audio = None videos = None **kwargs: typing_extensions.Unpack[transformers.models.idefics.processing_idefics.IdeficsProcessorKwargs] ) → 一个包含条目的字典

参数

images (Union[ImageInput, List[ImageInput], str, List[str], List[List[str]]]) — 当文本仅包含文本提示时，可以传入单个图像或批量的图像列表，以便使用图像-文本到文本的行为。
text (Union[List[TextInput], [List[List[TextInput]]]]) — 可以是单个提示或批量提示列表 - 详见参数文档部分末尾的详细描述。
return_tensors (str 或 TensorType, 可选, 默认为 TensorType.PYTORCH) — 返回张量的类型。可以是以下之一：
- TensorType.PYTORCH 或 'pt'：返回 torch.Tensor 类型的批次。

一个包含以下条目的字典

input_ids, attention_mask, pixel_values, image_attention_mask，可以直接传递给 model.generate

此方法接受由文本和图像组成的批量或非批量提示，并将它们转换为模型训练时使用的提示，并准备好供模型处理的图像像素值。

详细解释

text 中的每个条目可以是按原样传递的文本，也可以是要处理的图像。

图像可以是图像对象 (PIL.Image) 或可以从中检索图像的 URL。

当处理器遇到图像时，它会将 <fake_token_around_image><image><fake_token_around_image> 条目注入到提示中。

示例

checkpoint = "HuggingFaceM4/idefics-9b"
processor = AutoProcessor.from_pretrained(checkpoint)
url = "https://hips.hearstapps.com/hmg-prod/images/cute-photos-of-cats-in-grass-1593184777.jpg"
img = processor.image_processor.fetch_images([url])[0]

prompts = [
    "User:",
    img,
    "Describe this image.
t: An image of two kittens in grass.

    "User:",
    "https://hips.hearstapps.com/hmg-prod/images/dog-puns-1581708208.jpg",
    "Describe this image.
t:",
]

inputs = processor(text=prompts, return_tensors="pt")
generated_ids = model.generate(**inputs, max_length=100)
generated_text = processor.batch_decode(generated_ids, skip_special_tokens=True)[0]

在此示例中，prompts 将被转换为

<s>User:<fake_token_around_image><image><fake_token_around_image>Describe this image.
Assistant: An image of two kittens in grass.
User:<fake_token_around_image><image><fake_token_around_image>Describe this image.
Assistant:'

并且两个图像将使用 IdeficsImageProcessor.call() 方法进行处理，并放置在返回值的 pixel_values 字典条目中。

此示例还举例说明了图像可以作为对象或文本 URL 传递。可以看出，第一个图像作为对象传递，第二个图像作为 URL 传递。

要进行训练，请执行

image_transform = transforms.Compose(
    [
        transforms.RandomResizedCrop(
            (w, h), scale=(0.9, 1.0), interpolation=transforms.InterpolationMode.BICUBIC
        ),
        transforms.ToTensor(),
        transforms.Normalize(mean=self.image_mean, std=self.image_std),
    ]
)
inputs = processor(text=prompts, transform=image_transform, return_tensors="pt")

为了帮助调试提示生成，启用 debug=True 将显示正在发生的事情。

< > 在 GitHub 上更新