IDEFICS
概述
IDEFICS 模型在 OBELICS: 开放Web规模的图文交错文档过滤数据集 中被提出，作者是 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 数据集，这是一个开放的 Web 规模的图文交错文档过滤数据集，包含从 Common Crawl 中提取的 1.41 亿个网页、3.53 亿张相关图像和 1150 亿个文本 tokens。我们描述了数据集的创建过程，提出了全面的过滤规则，并对数据集的内容进行了分析。为了展示 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) — 模型的额外词汇表大小，通常用于特殊的 “” token。 额外的词汇表 tokens 始终是可训练的，而常规词汇表 tokens 可以被冻结或不冻结。
- vocab_size (
int，可选，默认为 32000) — Idefics 模型的词汇表大小。 定义了调用 ~IdeficsModel 时传递的inputs_ids可以表示的不同 tokens 的数量 - 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) — embeddings、编码器和 pooler 中所有全连接层的 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) — 用于初始化 Gated Cross Attention 中 alphas 的 truncated_normal_initializer 的标准差。 - alpha_type (
str，可选，默认为"float") — 门控 alphas 应该是向量还是单个浮点数。 - rms_norm_eps (
float，可选，默认为 1e-6) — rms 归一化层使用的 epsilon 值。 - use_cache (
bool，可选，默认为True) — 模型是否应返回最后的 key/values attentions（并非所有模型都使用）。 仅当config.is_decoder=True时相关。 - pad_token_id (
int，可选，默认为 0) — Padding token id。 - bos_token_id (
int，可选，默认为 1) — 开始流 token id。 - eos_token_id (
int，可选，默认为 2) — 结束流 token id。 - tie_word_embeddings(
bool, 可选，默认为False) — 是否绑定权重 embeddings - cross_layer_interval (
int，可选，默认为 1) — 交叉注意力（从文本到图像）层的间隔。 - qk_layer_norms (
bool，可选，默认为False) — 是否在 q 和 k 之后添加 layer norm - 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, optional, defaults to[]) — 当freeze_vision_layers为True时，冻结视觉层的例外情况 - use_resampler (
bool, optional, defaults toFalse) — 是否使用 Resampler - vision_config (
IdeficsVisionConfig, optional) — 自定义视觉配置或字典 - perceiver_config (
IdeficsPerceiverConfig, optional) — 自定义 Perceiver 配置或字典
这是用于存储 IdeficsModel 配置的配置类。它用于根据指定的参数实例化 Idefics 模型，定义模型架构。使用默认值实例化配置将产生与 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.configIdeficsModel
class transformers.IdeficsModel
< source >( config: IdeficsConfig )
参数
- config (IdeficsConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。 config — IdeficsConfig
裸 LLaMA 模型，输出原始隐藏状态，顶部没有任何特定的 head。此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档，了解与常规用法和行为相关的所有事项。
Transformer 解码器，由 config.num_hidden_layers 层组成。每一层都是 IdeficsDecoderLayer
前向传播
< source >( input_ids: LongTensor = None attention_mask: Optional = None position_ids: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None pixel_values: Optional = None image_encoder_embeddings: Optional = None perceiver_embeddings: Optional = None image_attention_mask: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None interpolate_pos_encoding: Optional = False return_dict: Optional = None cache_position: Optional = None )
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供填充，默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length), optional) — 掩码，用于避免在填充标记索引上执行注意力机制。掩码值在[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), optional) — 位置嵌入中每个输入序列标记的位置索引。在范围[0, config.n_positions - 1]中选择。 什么是位置 ID？ - past_key_values (
tuple(tuple(torch.FloatTensor)), optional, 当传递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), optional) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。 如果您希望比模型的内部嵌入查找矩阵更好地控制如何将input_ids索引转换为关联向量，这将非常有用。 - use_cache (
bool, optional) — 如果设置为True，则返回past_key_values键值状态，并且可以用于加速解码（请参阅past_key_values）。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通元组。 - cache_position (
torch.LongTensor，形状为(sequence_length), optional) — 索引，描述输入序列标记在序列中的位置。与position_ids相反，此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。
IdeficsModel 前向传播方法，覆盖了 __call__ 特殊方法。
尽管前向传播的配方需要在该函数内定义，但之后应调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
IdeficsForVisionText2Text
前向传播
< source >( input_ids: LongTensor = None attention_mask: Optional = None position_ids: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None pixel_values: Optional = None image_encoder_embeddings: Optional = None perceiver_embeddings: Optional = None image_attention_mask: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None interpolate_pos_encoding: Optional = False return_dict: Optional = None cache_position: Optional = None ) → transformers.models.idefics.modeling_idefics.IdeficsCausalLMOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。如果您提供填充，默认情况下将被忽略。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length), 可选) — 用于避免在填充 token 索引上执行 attention 的掩码。掩码值在[0, 1]中选择：- 1 表示 token 未被掩盖，
- 0 表示 token 被掩盖。
索引可以使用 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), 可选) — 位置嵌入中每个输入序列 token 的位置索引。在范围[0, config.n_positions - 1]中选择。 什么是位置 IDs？ - 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, 可选) — 是否返回所有 attention 层的 attention 张量。 有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。 - cache_position (
torch.LongTensor，形状为(sequence_length), 可选) — 索引，描述输入序列 tokens 在序列中的位置。 与position_ids相反，此张量不受填充的影响。 它用于在正确的位置更新缓存并推断完整的序列长度。Args — labels (
torch.LongTensor，形状为(batch_size, sequence_length), 可选): 用于计算掩码语言建模损失的标签。 索引应为[0, ..., config.vocab_size]或 -100（请参阅input_idsdocstring）。 索引设置为-100的 tokens 将被忽略（掩盖），损失仅针对标签在[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时返回) — 语言建模损失（用于下一个 token 预测）。 -
logits (
torch.FloatTensor，形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模 head 的预测分数（SoftMax 之前每个词汇表 token 的分数）。 -
past_key_values (
tuple(tuple(torch.FloatTensor)), 可选, 当传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的tuple(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时返回) —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 之后的注意力权重，用于计算自注意力 head 中的加权平均值。
-
image_hidden_states (
tuple(torch.FloatTensor), 可选) —torch.FloatTensor元组（图像嵌入的输出之一，(batch_size, num_images, sequence_length, hidden_size)。视觉编码器以及可选的 perceiver 生成的 image_hidden_states
IdeficsForVisionText2Text forward 方法，覆盖了 __call__ 特殊方法。
尽管前向传播的配方需要在该函数内定义，但之后应调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> 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
调用
< 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
调用
< 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 的索引。默认情况下，如果您提供填充，填充将被忽略。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的tf.Tensor，可选) — 用于避免在填充 token 索引上执行 attention 的 Mask。在[0, 1]中选择的 Mask 值：- 1 表示 未被 Mask 的 token，
- 0 表示 被 Mask 的 token。
索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
如果使用
past_key_values，则可以选择仅输入最后的decoder_input_ids（请参阅past_key_values）。如果您想更改填充行为，您应该阅读
modeling_opt._prepare_decoder_attention_mask并根据您的需要进行修改。 有关默认策略的更多信息，请参见 论文 中的图 1。- 1 表示 head 未被 Mask，
- 0 表示 head 被 Mask。
- position_ids (形状为
(batch_size, sequence_length)的tf.Tensor，可选) — 位置 embeddings 中每个输入序列 token 的位置索引。在范围[0, config.n_positions - 1]中选择。 什么是位置 IDs？ - past_key_values (
tuple(tuple(tf.Tensor))，可选，当传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的tuple(tuple(tf.Tensor))元组，其中每个元组具有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的 tensors 和 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的额外 tensors。包含预先计算的隐藏状态（自注意力模块和交叉注意力模块中的键和值），这些状态可以用于加速顺序解码（请参阅
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，可选) — 是否返回所有 attention 层的 attentions tensors。 有关更多详细信息，请参阅返回的 tensors 下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回的 tensors 下的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），损失仅针对标签在[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时返回) — 语言建模损失（用于下一个 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时返回) — 长度为config.n_layers的tuple(tuple(tf.Tensor))元组，其中每个元组具有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的 tensors)包含预先计算的隐藏状态（自注意力模块中的键和值），这些状态可以用于（参见
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 之后的注意力权重，用于计算自注意力 head 中的加权平均值。
-
image_hidden_states (
tuple(tf.Tensor)，可选) —tf.Tensor的元组（图像嵌入的输出一个，(batch_size, num_images, sequence_length, hidden_size)。视觉编码器以及可选的 perceiver 生成的 image_hidden_states
TFIdeficsForVisionText2Text 前向方法，覆盖了 __call__ 特殊方法。
尽管前向传播的配方需要在该函数内定义，但之后应调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>> 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: Union = None image_std: Union = None image_num_channels: Optional = 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: Union image_num_channels: Optional = 3 image_size: Optional = None image_mean: Union = None image_std: Union = None transform: Callable = None return_tensors: Union = <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, optional, defaults toNone) — 可以传入一个接受单个图像的自定义转换函数以进行训练。例如，torchvision.Compose可以用于组合多个转换。如果为None- 则假定为推理模式 - 然后将推理特定的预设转换应用于图像
预处理一批图像。
IdeficsProcessor
class transformers.IdeficsProcessor
< 源码 >( image_processor tokenizer = None image_size = 224 add_end_of_utterance_token = None **kwargs )
参数
- image_processor (
IdeficsImageProcessor) — IdeficsImageProcessor 的一个实例。图像处理器是必需的输入。 - tokenizer (
LlamaTokenizerFast) — LlamaTokenizerFast 的一个实例。分词器是必需的输入。 - image_size (
int, optional, defaults to 224) — 图像尺寸（假设为正方形图像）
构建一个 IDEFICS 处理器，它将 LLama 分词器和 IDEFICS 图像处理器包装到一个单独的处理器中。
IdeficsProcessor 提供了 IdeficsImageProcessor 和 LlamaTokenizerFast 的所有功能。 有关更多信息，请参阅 call() 和 decode() 的文档字符串。
__call__
< 源码 >( prompts: Union padding: Union = 'longest' truncation: Union = None max_length: Optional = None transform: Callable = None add_eos_token = False add_end_of_utterance_token = None debug = False return_tensors = 'pt' ) → 一个包含条目的字典
参数
- prompts (
Union[List[TextInput], [List[List[TextInput]]]]) — 单个提示或批量提示列表 - 请参阅参数文档部分结束后紧跟的详细描述。 - padding (
bool,str或 PaddingStrategy, optional, defaults to"longest") — 选择一种策略来填充返回的序列（根据模型的填充侧和填充索引）：True或'longest'(默认)：填充到批次中最长的序列（如果仅提供单个序列，则不填充）。'max_length'：填充到参数max_length指定的最大长度，如果未提供该参数，则填充到模型可接受的最大输入长度。False或'do_not_pad'：不填充。如果输入序列的长度不同，这将引发错误。 注意：与大多数处理器默认设置 padding=False不同，IdeficsProcessor默认设置padding="longest"。 请参阅 https://github.com/huggingface/transformers/pull/29449#pullrequestreview-1925576061 了解原因。
- max_length (
int, optional) — 返回列表的最大长度，以及可选的填充长度（见上文）。 - truncation (
bool, optional) — 激活截断以将输入序列裁剪为不超过max_length的长度。 - transform (
Callable, optional) — 可以传入一个接受单个图像的自定义转换函数以进行训练。例如，torchvision.Compose可以用于组合多个函数。如果为None，则会将一组推理特定的预设转换应用于图像 - add_eos_token (
bool, optional, defaults toFalse) — 如果为 True，则在最终提示的末尾添加eos_token - add_end_of_utterance_token (
bool, optional) — 是否在每个提示的文本输入后自动添加<end_of_utterance>（除非后跟图像）。 如果为None，则将改为检查分词器，如果在additional_special_tokens中找到此标记，则该值将为True。 - debug (
bool, optional, defaults toFalse) —True值将通过转储有用的信息来帮助调试提示生成 - return_tensors (
str或TensorType, optional, defaults toTensorType.PYTORCH) — 要返回的张量类型。 可以是以下之一：TensorType.PYTORCH或'pt'：返回torch.Tensor类型的批次。
返回值
一个包含条目的字典
可以直接传递给 model.generate 的 input_ids、attention_mask、pixel_values、image_attention_mask
此方法接受由文本和图像组成的批量或非批量提示，并将它们转换为模型训练时使用的提示，并准备好图像像素值以供模型处理。
详细说明
prompts 中的每个条目可以是按原样传递的文本，也可以是要处理的图像。
图像可以是图像对象 (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(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(prompts, transform=image_transform, return_tensors="pt")为了帮助调试提示生成，请启用 debug=True，它将显示正在发生的事情。