IDEFICS
概述
IDFICS模型由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规模筛选数据集中提出
论文简介如下：
在自然文档上训练的、图像和文本交织的大型多模态模型，在各种需要推理一个或多个图像生成文本的多模态基准测试中，胜过仅以图像-文本对进行训练的模型。然而，用于训练这些模型的 dataset 尚未发布，且数据收集过程也未完全具体说明。我们引入了 OBELICS dataset，这是一个开放的 web 级别筛选后的浸润式图像-文本文档 dataset，包含从 Common Crawl 中抽取的1.41亿个网页、3.53亿个相关图像以及1150亿个文本标记。我们描述了数据集的创建过程，展示了全面的筛选规则，并分析了数据集的内容。为了展示 OBELICS 的可用性，我们在数据集上训练了一个80亿参数的视觉和语言模型，并在多个多模态基准测试中获得了具有竞争力的性能。我们发布了复现数据集所需的代码和数据集本身。
此模型由 HuggingFaceM4 提供。原始代码可以在 这里 找到。（注意：尚未有公开链接）。
IDEFICS 的建模代码在 Transformers 中用于微调和推理预训练的 IDEFICS 模型。
要从头训练一个新的 IDEFICS 模型，请使用 m4 代码库（一且公开将提供链接）。
IdeficsConfig
类 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) — embeddings、编码器和pooler中所有全连接层的dropout概率。 - hidden_act (
str或function, 可选, 默认为"silu") — 解码器中使用的非线性激活函数（函数或字符串）。 - initializer_range （
float，可选，默认为 0.02）—— 用于初始化所有权重矩阵的截断正态初始化器的标准差。 - alpha_initializer （
str，可选，默认为"zeros"）—— alphas 的初始化类型。 - alphas_initializer_range （
float，可选，默认为 0.0）—— 在门控交叉注意力中初始化 alphas 的截断正态初始化器的标准差。 - 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) — 填充标记的 ID。 - bos_token_id (
int, 可选，默认为 1) — 流开始标记的 ID。 - eos_token_id (
int, 可选, 默认为2) — 流结束令牌 ID。 - tie_word_embeddings(
bool, 可选, 默认为False) — 是否要绑定词嵌入权重 - 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头 - freeze_vision_layers （
bool，可选，默认为True） — 是否冻结视觉层 - 当
freeze_vision_layers为True时，冻结视觉层的例外情况 - 是否使用Resampler
- 自定义视觉配置或字典
- 自定义感知器配置或字典
这是用于存储IdeficsModel配置的配置类。用于根据指定的参数实例化一个Idefics模型，定义模型架构。使用默认值创建配置将产生与Idefics-9B类似的配置。
例如：[HuggingFaceM4/idefics-9b](https://huggingface.co/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.configIdeficsModel
class transformers.IdeficsModel
< source >( config: IdeficsConfig )
参数
- config (IdeficsConfig) — 包含模型所有参数的模型配置类。用配置文件初始化时不会加载与模型关联的权重，只有配置。查看from_pretrained() 方法来加载模型权重。config — IdeficsConfig
该LLaMA模型以输出原始隐藏状态而无需任何特定头部的形式出现。这个模型继承自PreTrainedModel。请查看超类文档，了解库为所有模型实现的一般方法（例如下载或保存、调整输入嵌入层大小、剪枝头部等）。
此外，该模型还是PyTorch torch.nn.Module的子类。将其用作常规PyTorch模块，并参阅PyTorch文档了解所有有关通用使用和行为的问题。
Transformer解码器由config.num_hidden_layers个层组成。每一层都是IdeficsDecoderLayer。
forward
< source >)
参数
- input_ids （
torch.LongTensor形状为(batch_size, sequence_length)） — 输入序列标记的词汇中的索引。如果提供了填充，默认会忽略它。 - attention_mask (
torch.Tensorof shape(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 表示头没有掩码，
- 0 表示头有掩码。
- position_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[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，用户可以选择只输入形状为(batch_size, 1)的最后decoder_input_ids（那些没有将其过去键值状态提供给此模型的）而不是所有形状为(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 而不是一个纯元组。
IdeficsModel 的前进方法，覆盖了 __call__ 特殊方法。
尽管需要在函数内部定义前向传播的配方，但应该调用 Module 实例之后，而不是这个，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
IdeficsForVisionText2Text
forward
< 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 ) → 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.Tensorof shape(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表示头部未掩码，
- 0表示头部掩码。
- position_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 每个输入序列标记在位置嵌入中的位置索引。选择在范围[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，用户可以选择只输入形状为(batch_size, 1)的最后decoder_input_ids（那些未将过去键值状态提供给此模型的）而不是所有形状为(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 而不是一个平凡的元组。
返回
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时返回）— 语言建模损失（用于下一个标记的预测）。 -
logits（
torch.FloatTensor形状为(batch_size, sequence_length, config.vocab_size)）— 语言建模头的预测分数（SoftMax之前的每个词汇的分数）。 -
past_key_values（
tuple(tuple(torch.FloatTensor))，可选，当传递use_cache=True或当config.use_cache=True时返回）— 长度为config.n_layers的tuple(torch.FloatTensor)的元组，每个元组包含两个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量包含预计算的隐藏状态（self-attention 块中的密钥和值），可以用于（见
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 之后的注意力权重，用于在 self-attention 头中计算加权平均。
-
image_hidden_states（
tuple(torch.FloatTensor)，可选）—torch.FloatTensor的元组（对于图像嵌入输出的一个，形状为(batch_size, num_images, sequence_length, hidden_size)）。由视觉编码器生成的模型 image_hidden_states，以及选项中通过感知器生成的。
重写了IdeficsForVisionText2Text 前向方法的方法。
尽管需要在函数内部定义前向传播的配方，但应该调用 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
调用
< 来源 >( 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 or tuple(tf.Tensor)
参数
- input_ids (
tf.Tensorof shape(batch_size, sequence_length)) — 输入序列令牌在词汇表中的索引。如果提供，默认情况下将忽略填充。索引可以通过使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
tf.Tensor形状为(batch_size, sequence_length)，可选）—避免在填充token索引上执行注意力的掩码。掩码值在[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 (
tf.Tensor形状为(batch_size, sequence_length)，可选）—每个输入序列token在位置嵌入中的位置索引。选择范围在[0, config.n_positions - 1]内。什么是位置ID？ - past_key_values (
tuple(tuple(tf.Tensor)), 可选，当传入use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的tuple(tf.Tensor)的元组，每个元组包含形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的 2 个张量以及形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的 2 个额外张量。包含预计算的隐藏状态（自我关注块和交叉关注块中的键和值），可用于（见
past_key_values输入）以加快顺序解码速度。如果使用
past_key_values，则用户可选择只输入最后一个decoder_input_ids（那些没有为模型提供过去键值状态的）形状为(batch_size, 1)，而不是所有形状为(batch_size, sequence_length)的decoder_input_ids。 - inputs_embeds (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示而不是input_ids。当您想要在内部嵌入查找矩阵之外对将input_ids索引转换为相关向量有更多控制时，这很有用。 - use_cache （
bool，可选）— 如果设置为True，则返回past_key_values的 key value states，可以用于加速解码（参见past_key_values）。 - output_attentions （
bool，可选）— 是否返回所有注意力层的注意力张量。更多详细信息，请参阅返回张量中的attentions。 - output_hidden_states（
bool，可选）— 是否返回所有层的隐藏状态。更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回ModelOutput 而不是简单的元组。
返回
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 (
tf.Tensor形状为(1,)，可选，如果有提供labels） — 语言建模损失（用于下一个标记预测）。 -
logits (
tf.Tensor形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头部的预测分数（SoftMax之前的每个词汇单元的分数）。 -
past_key_values (
tuple(tuple(tf.Tensor))，可选，如果传递了use_cache=True或当config.use_cache=True时返回） — 长度为config.n_layers的tuple(tf.Tensor)的元组，其中每个元组包含形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的2个张量。包含预计算的隐藏状态（self-attention 块中的密钥和值），可以用于（见
past_key_values输入）以加快序列解码。 -
hidden_states (
tuple(tf.Tensor)，可选，如果传递了output_hidden_states=True或当config.output_hidden_states=True时返回） — 形状为(batch_size, sequence_length, hidden_size)的tf.Tensor的元组（对于带有嵌入层的模型，如果有的话，每个层的输出为一个）。每个层的模型输出隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(tf.Tensor)，可选，如果传递了output_attentions=True或当config.output_attentions=True时返回） — 形状为(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor的元组（每个层一个）。注意力 softmax 之后的注意力权重，用于在 self-attention 头中计算加权平均。
-
image_hidden_states (
tuple(tf.Tensor)，可选) — 形状为(batch_size, num_images, sequence_length, hidden_size)的tf.Tensor的元组（图像嵌入层的输出）。由视觉编码器生成的模型 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
类 transformers.IdeficsImageProcessor
< 源 >( image_size: int = 224 image_mean: Union = None image_std: Union = None image_num_channels: Optional = 3 **kwargs )
参数
- image_size (
int, 可选, 默认值 224) — 调整到图像大小 - 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
< 来源 >( images: 联合 image_num_channels: 可选 = 3 image_size: 可选 = 无 image_mean: 联合 = 无 image_std: 联合 = 无 transform: 可调用 = 无 return_tensors: 联合 = <TensorType.PYTORCH: 'pt'> **kwargs )
参数
- images (
ImageInput) — 预处理图像的列表。 - image_size (
int, optional, defaults toself.image_size) — 调整为图像大小 - image_num_channels (
int, optional, defaults toself.image_num_channels) — 图像通道数。 - image_mean (
float或List[float], optional, defaults toIDEFICS_STANDARD_MEAN) — 如果对图像进行归一化时使用的平均值。这是一个浮点数或浮点数列表，长度与图像通道数量相同。可由preprocess方法中的image_mean参数覆盖。 - image_std （
float或List[float]，可选，默认为IDEFICS_STANDARD_STD）—— 校准图像时使用的标准差。这是一个与图像通道数长度相同的浮点数或浮点数列表。可以由preprocess方法中的image_std参数覆盖。 - transform （
Callable，可选，默认为None）—— 可传入用于训练的接受单个图像的自定义变换函数。例如，可以使用torchvision.Compose来组合多个变换。如果设置为None，则假定是推理模式，并将应用预设的推理特定变换。
校准一批图像。
IdeficsProcessor
类 transformers.IdeficsProcessor
< source >( image_processor tokenizer = None image_size = 224 add_end_of_utterance_token = None **kwargs )
参数
- image_processor (<code>IdeficsImageProcessor</code>) — <code>IdeficsImageProcessor</code>. 图像处理器是必需的输入。
- tokenizer (<code>LlamaTokenizerFast</code>) — <code>LlamaTokenizerFast</code>. 分词器是必需的输入。
- image_size (
int, 可选, 默认值为224) — 图像尺寸（假设为方形图像）
构造一个IDEFICS处理器，它将LLama分词器和IDEFICS图像处理器包装成一个单处理器。
IDEFICSProcessor提供了IDEFICSImageProcessor和LlamaTokenizerFast的所有功能。请参阅call()和decode()的文档字符串以获取更多信息。
__call__
< source >( prompts: 联合类型 padding: 联合类型 = 'longest' truncation: 联合类型 = None max_length: 可选类型 = None transform: 可调用类型 = None add_eos_token = False add_end_of_utterance_token = None debug = False return_tensors = 'pt' ) → 一个包含条目的字典
参数
- prompts (
Union[List[TextInput], [List[List[TextInput]]]]) — 可以是一个单个提示或按批次的提示列表 - 详见 arguments.doc 部分。 - transform (
Callable, 可选) — 为训练可以传递一个接受单个图像的自定义转换函数。例如，可以使用torchvision.Compose来组合多个函数。如果为None，将应用预设置的特定于推理的转换集到图像上。 - add_eos_token (
bool, 可选, 默认为False) — 如果为 `True`，则在最终提示语后添加eos_token。 - add_end_of_utterance_token (
bool, 可选) — 是否自动在每个提示文本输入后添加 ``（除非其后有图像）。如果为 None，则将检查分词器，如果此标记在additional_special_tokens中找到，则值将为True。 - debug (
bool, 可选，默认为False) —True值将帮助通过输出有用信息来调试提示生成 - return_tensors (
str或TensorType, 可选，默认为TensorType.PYTORCH) — 返回张量的类型。可以是以下之一：TensorType.PYTORCH或'pt'：返回一个类型为torch.Tensor的批次。
返回
包含条目的字典
input_ids, attention_mask, pixel_values, image_attention_mask 这可以通过传递给 model.generate
此方法接受批量或非批量由文本和图像组成的提示，并将它们转换为模型训练时所用的提示，并为模型处理准备图像像素值。
详细说明
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，它将显示正在发生的事情。