Transformers 文档

IDEFICS

IDEFICS

概述

IDEFICS模型由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: An Open Web-Scale Filtered Dataset of Interleaved Image-Text Documents中提出。

论文的摘要如下:

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

该模型由HuggingFaceM4贡献。原始代码可以在这里找到。(待办:目前还没有公开链接)。

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

要从头开始训练一个新的IDEFICS模型,请使用m4代码库(一旦公开,将提供一个链接)

IdeficsConfig

transformers.IdeficsConfig

< >

( 词汇表大小 = 32000 额外词汇表大小 = 0 隐藏层大小 = 4096 中间层大小 = 11008 隐藏层数量 = 32 注意力头数量 = 32 丢弃率 = 0.0 隐藏层激活函数 = 'silu' 初始化范围 = 0.02 alpha初始化器 = 'zeros' alphas初始化器范围 = 0.0 alpha类型 = 'float' RMS归一化epsilon = 1e-06 使用缓存 = True 填充标记ID = 0 开始标记ID = 1 结束标记ID = 2 绑定词嵌入 = False 跨层间隔 = 1 QK层归一化 = False 冻结文本层 = True 冻结文本模块例外 = [] 冻结语言模型头 = False 冻结视觉层 = True 冻结视觉模块例外 = [] 使用重采样器 = False 视觉配置 = None 感知器配置 = None **kwargs )

参数

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

这是用于存储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

transformers.IdeficsModel

< >

( config: IdeficsConfig )

参数

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

裸LLaMA模型输出原始隐藏状态,没有任何特定的头部。 该模型继承自PreTrainedModel。请查看超类文档以了解库为其所有模型实现的通用方法(如下载或保存、调整输入嵌入大小、修剪头部等)。

该模型也是一个PyTorch torch.nn.Module 子类。 将其作为常规的PyTorch模块使用,并参考PyTorch文档以获取与一般使用和行为相关的所有信息。

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

前进

< >

( 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 of shape (batch_size, sequence_length)) — Indices of input sequence tokens in the vocabulary. Padding will be ignored by default should you provide it.

    可以使用AutoTokenizer获取索引。详情请参见PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入ID?

  • attention_mask (torch.Tensor of shape (batch_size, sequence_length), optional) — Mask to avoid performing attention on padding token indices. Mask values selected in [0, 1]:
    • 1 for tokens that are not masked,
    • 0 for tokens that are masked.

    什么是注意力掩码?

    可以使用AutoTokenizer获取索引。详情请参见PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    如果使用了past_key_values,则可以选择性地仅输入最后一个decoder_input_ids(参见past_key_values)。

    如果你想改变填充行为,你应该阅读modeling_opt._prepare_decoder_attention_mask 并根据你的需求进行修改。有关默认策略的更多信息,请参见论文中的图1。

    • 1 indicates the head is not masked,
    • 0 indicates the head is masked.
  • position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 每个输入序列标记在位置嵌入中的位置索引。选择范围在 [0, config.n_positions - 1] 内。What are position IDs?
  • past_key_values (tuple(tuple(torch.FloatTensor)), optional, returned when use_cache=True is passed or when config.use_cache=True) — Tuple of tuple(torch.FloatTensor) of length config.n_layers, with each tuple having 2 tensors of shape (batch_size, num_heads, sequence_length, embed_size_per_head)) and 2 additional tensors of shape (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 of shape (batch_size, sequence_length, hidden_size), optional) — 可选地,您可以选择直接传递嵌入表示,而不是传递input_ids。如果您希望对如何将input_ids索引转换为相关向量有更多控制,而不是使用模型的内部嵌入查找矩阵,这将非常有用。
  • use_cache (bool, 可选) — 如果设置为 Truepast_key_values 键值状态将被返回,并可用于加速解码(参见 past_key_values)。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量中的attentions
  • output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • return_dict (bool, 可选) — 是否返回一个ModelOutput而不是一个普通的元组。
  • cache_position (torch.LongTensor of shape (sequence_length), optional) — 表示输入序列标记在序列中的位置的索引。与position_ids相反, 这个张量不受填充的影响。它用于在正确的位置更新缓存并推断 完整的序列长度。

IdeficsModel 的 forward 方法,重写了 __call__ 特殊方法。

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

IdeficsForVisionText2Text

transformers.IdeficsForVisionText2Text

< >

( config vision_model = 无 )

前进

< >

( 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.IdeficsCausalLMOutputWithPasttuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (batch_size, sequence_length)) — Indices of input sequence tokens in the vocabulary. Padding will be ignored by default should you provide it.

    可以使用AutoTokenizer获取索引。详情请参见PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入ID?

  • attention_mask (torch.Tensor of shape (batch_size, sequence_length), optional) — Mask to avoid performing attention on padding token indices. Mask values selected in [0, 1]:
    • 1 for tokens that are not masked,
    • 0 for tokens that are masked.

    什么是注意力掩码?

    可以使用AutoTokenizer获取索引。详情请参见PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    如果使用了past_key_values,则可以选择性地仅输入最后一个decoder_input_ids(参见past_key_values)。

    如果你想改变填充行为,你应该阅读modeling_opt._prepare_decoder_attention_mask 并根据你的需求进行修改。有关默认策略的更多信息,请参见论文中的图1。

    • 1 indicates the head is not masked,
    • 0 indicates the head is masked.
  • position_ids (torch.LongTensor of shape (batch_size, sequence_length), 可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围在 [0, config.n_positions - 1] 内。什么是位置 ID?
  • past_key_values (tuple(tuple(torch.FloatTensor)), optional, returned when use_cache=True is passed or when config.use_cache=True) — Tuple of tuple(torch.FloatTensor) of length config.n_layers, with each tuple having 2 tensors of shape (batch_size, num_heads, sequence_length, embed_size_per_head)) and 2 additional tensors of shape (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 of shape (batch_size, sequence_length, hidden_size), optional) — 可选地,您可以选择直接传递嵌入表示,而不是传递input_ids。如果您希望对如何将input_ids索引转换为相关向量有更多控制,而不是使用模型的内部嵌入查找矩阵,这将非常有用。
  • use_cache (bool, 可选) — 如果设置为 Truepast_key_values 键值状态将被返回,并可用于加速解码(参见 past_key_values)。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量下的attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • return_dict (bool, 可选) — 是否返回一个ModelOutput而不是一个普通的元组。
  • cache_position (torch.LongTensor of shape (sequence_length), optional) — 表示输入序列标记在序列中的位置的索引。与position_ids不同, 这个张量不受填充的影响。它用于在正确的位置更新缓存并推断 完整的序列长度。
  • Args — labels (torch.LongTensor of shape (batch_size, sequence_length), optional): 用于计算掩码语言建模损失的标签。索引应在 [0, ..., config.vocab_size] 或 -100 之间(参见 input_ids 文档字符串)。索引设置为 -100 的标记将被忽略 (掩码),损失仅针对标签在 [0, ..., config.vocab_size] 之间的标记计算。

返回

transformers.models.idefics.modeling_idefics.IdeficsCausalLMOutputWithPasttuple(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_layerstuple(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)可选) — 形状为 (batch_size, num_images, sequence_length, hidden_size)torch.FloatTensor 元组(一个用于图像嵌入的输出)。

    由视觉编码器生成的模型的 image_hidden_states,以及可选的感知器生成的。

IdeficsForVisionText2Text 的前向方法,重写了 __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

transformers.TFIdeficsModel

< >

( config: IdeficsConfig *inputs **kwargs )

调用

< >

( 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

transformers.TFIdeficsForVisionText2Text

< >

( config vision_model = None **kwargs )

调用

< >

( 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.TFIdeficsCausalLMOutputWithPasttuple(tf.Tensor)

参数

  • input_ids (tf.Tensor of shape (batch_size, sequence_length)) — Indices of input sequence tokens in the vocabulary. Padding will be ignored by default should you provide it.

    可以使用AutoTokenizer获取索引。详情请参见PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入ID?

  • attention_mask (tf.Tensor of shape (batch_size, sequence_length), optional) — Mask to avoid performing attention on padding token indices. Mask values selected in [0, 1]:
    • 1 for tokens that are not masked,
    • 0 for tokens that are masked.

    什么是注意力掩码?

    可以使用AutoTokenizer获取索引。详情请参见PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    如果使用了past_key_values,则可以选择性地仅输入最后一个decoder_input_ids(参见past_key_values)。

    如果你想改变填充行为,你应该阅读modeling_opt._prepare_decoder_attention_mask 并根据你的需求进行修改。有关默认策略的更多信息,请参见论文中的图1。

    • 1 indicates the head is not masked,
    • 0 indicates the head is masked.
  • position_ids (tf.Tensor 形状为 (batch_size, sequence_length), 可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为 [0, config.n_positions - 1]什么是位置ID?
  • past_key_values (tuple(tuple(tf.Tensor)), optional, returned when use_cache=True is passed or when config.use_cache=True) — Tuple of tuple(tf.Tensor) of length config.n_layers, with each tuple having 2 tensors of shape (batch_size, num_heads, sequence_length, embed_size_per_head)) and 2 additional tensors of shape (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 (tf.Tensor 形状为 (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, optional) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
  • Args — labels (tf.Tensor of shape (batch_size, sequence_length), optional): 用于计算掩码语言建模损失的标签。索引应在 [0, ..., config.vocab_size] 或 -100 之间(参见 input_ids 文档字符串)。索引设置为 -100 的标记将被忽略 (掩码),损失仅针对标签在 [0, ..., config.vocab_size] 之间的标记计算。

返回

transformers.models.idefics.modeling_tf_idefics.TFIdeficsCausalLMOutputWithPasttuple(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_layerstuple(tf.Tensor) 元组,每个元组包含 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)

    由视觉编码器生成的模型的 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: 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, optional, 默认为 224) — 调整到图像大小
  • image_mean (floatList[float], 可选, 默认为 IDEFICS_STANDARD_MEAN) — 如果对图像进行归一化,则使用的均值。这是一个浮点数或与图像通道数长度相同的浮点数列表。可以在 preprocess 方法中通过 image_mean 参数覆盖。可以在 preprocess 方法中通过 image_mean 参数覆盖。
  • image_std (floatList[float], 可选, 默认为 IDEFICS_STANDARD_STD) — 如果对图像进行归一化,则使用的标准差。这是一个浮点数或与图像通道数长度相同的浮点数列表。可以在 preprocess 方法中通过 image_std 参数进行覆盖。 可以在 preprocess 方法中通过 image_std 参数进行覆盖。
  • image_num_channels (int, optional, defaults to 3) — 图像通道数.

构建一个Idefics图像处理器。

预处理

< >

( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), typing.List[ForwardRef('PIL.Image.Image')], typing.List[numpy.ndarray], typing.List[ForwardRef('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] = **kwargs )

参数

  • 图片 (ImageInput) — 要预处理的图片列表。
  • image_size (int, optional, defaults to self.image_size) — 调整到图像大小
  • image_num_channels (int, optional, defaults to self.image_num_channels) — 图像通道数.
  • image_mean (floatList[float], 可选, 默认为 IDEFICS_STANDARD_MEAN) — 如果对图像进行归一化,则使用的均值。这是一个浮点数或与图像通道数长度相同的浮点数列表。可以在 preprocess 方法中的 image_mean 参数中覆盖。可以在 preprocess 方法中的 image_mean 参数中覆盖。
  • image_std (floatList[float], 可选, 默认为 IDEFICS_STANDARD_STD) — 如果对图像进行归一化,则使用的标准差。这是一个浮点数或与图像通道数长度相同的浮点数列表。可以在 preprocess 方法中通过 image_std 参数覆盖。可以在 preprocess 方法中通过 image_std 参数覆盖。
  • transform (Callable, 可选, 默认为 None) — 可以传递一个接受单个图像的自定义转换函数用于训练。例如, torchvision.Compose 可以用于组合多个转换。如果为 None - 则假定为推理模式 - 然后将应用一组预设的推理专用转换到图像上

预处理一批图像。

IdeficsProcessor

transformers.IdeficsProcessor

< >

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

参数

  • image_processor (IdeficsImageProcessor) — 一个 IdeficsImageProcessor 的实例。图像处理器是一个必需的输入。
  • tokenizer (LlamaTokenizerFast) — 一个 LlamaTokenizerFast 的实例。tokenizer 是一个必需的输入。
  • image_size (int, optional, 默认为 224) — 图像大小(假设为正方形图像)

构建一个IDEFICS处理器,它将LLama分词器和IDEFICS图像处理器封装到一个单一的处理器中。

IdeficsProcessor 提供了 IdeficsImageProcessorLlamaTokenizerFast 的所有功能。更多信息请参见 call()decode() 的文档字符串。

__call__

< >

( images = 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[PIL.Image, str, List[PIL.Image], List[str]]) — 可以传递单个图像或批量图像列表 - 当文本仅包含文本提示时,可以使用图像到文本的行为。
  • 文本 (Union[List[TextInput], [List[List[TextInput]]]]) — 可以是一个单独的提示或一批提示列表 - 请参阅参数文档部分结束后的详细描述。
  • return_tensors (strTensorType, 可选, 默认为 TensorType.PYTORCH) — 返回的张量类型。可以是以下之一:
    • TensorType.PYTORCH'pt': 返回类型为 torch.Tensor 的批次。

返回

一个包含条目的字典

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

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

详细解释:

text 中的每个条目要么是要原样传递的文本,要么是要处理的图像。

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

当处理器遇到图像时,它会将注入到提示中。

示例:

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,这将显示正在发生的情况。

< > Update on GitHub