Transformers 文档

Fuyu

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

Fuyu

PyTorch

概述

Fuyu 模型由 ADEPT 创建,作者为 Rohan Bavishi、Erich Elsen、Curtis Hawthorne、Maxwell Nye、Augustus Odena、Arushi Somani、Sağnak Taşırlar。

作者们推出了 Fuyu-8B,这是一个基于经典 Transformer 架构的仅解码器多模态模型,带有查询和键归一化。模型增加了一个线性编码器,用于从图像输入创建多模态嵌入。

通过将图像词元(token)视为文本词元,并使用特殊的图像换行符,模型可以知道图像行的结束位置。图像位置嵌入被移除。这避免了针对不同图像分辨率需要不同训练阶段的问题。Fuyu-8B 拥有 80 亿参数,并采用 CC-BY-NC 许可证,其能够处理文本和图像、拥有 16K 的惊人上下文大小以及整体性能出色,因此备受瞩目。

Fuyu 模型使用 bfloat16进行训练,但原始推理使用 float16。Hub 上上传的检查点使用 torch_dtype = 'float16'AutoModel API 将用其把检查点从 torch.float32 转换为 torch.float16

在线权重的 `dtype` 基本上是无关紧要的,除非你在使用 `model = AutoModelForCausalLM.from_pretrained("path", torch_dtype = "auto")` 初始化模型时使用了 `torch_dtype="auto"`。原因是模型会首先被下载(使用在线检查点的 `dtype`),然后它会被转换为 `torch` 的默认 `dtype`(变为 `torch.float32`)。用户应该指定他们想要的 `torch_dtype`,如果他们不指定,则默认为 `torch.float32`。

不建议在 `float16` 模式下微调模型,已知这会产生 `nan`,因此模型应在 `bfloat16` 模式下进行微调。

技巧

  • 要转换模型,你需要使用 `git clone https://github.com/persimmon-ai-labs/adept-inference` 克隆原始仓库,然后获取检查点
git clone https://github.com/persimmon-ai-labs/adept-inference
wget path/to/fuyu-8b-model-weights.tar
tar -xvf fuyu-8b-model-weights.tar
python src/transformers/models/fuyu/convert_fuyu_weights_to_hf.py  --input_dir /path/to/downloaded/fuyu/weights/ --output_dir /output/path \
    --pt_model_path /path/to/fuyu_8b_release/iter_0001251/mp_rank_00/model_optim_rng.pt
    --ada_lib_path /path/to/adept-inference

对于聊天模型

wget https://axtkn4xl5cip.objectstorage.us-phoenix-1.oci.customer-oci.com/n/axtkn4xl5cip/b/adept-public-data/o/8b_chat_model_release.tar
tar -xvf 8b_base_model_release.tar

然后,模型可以通过以下方式加载

from transformers import FuyuConfig, FuyuForCausalLM
model_config = FuyuConfig()
model = FuyuForCausalLM(model_config).from_pretrained('/output/path')

输入需要通过一个特定的处理器进行处理,以获得正确的格式。处理器需要一个图像处理器和一个分词器。因此,输入可以通过以下方式加载

from PIL import Image
from transformers import AutoTokenizer
from transformers.models.fuyu.processing_fuyu import FuyuProcessor
from transformers.models.fuyu.image_processing_fuyu import FuyuImageProcessor


tokenizer = AutoTokenizer.from_pretrained('adept-hf-collab/fuyu-8b')
image_processor = FuyuImageProcessor()


processor = FuyuProcessor(image_processor=image_processor, tokenizer=tokenizer)
text_prompt = "Generate a coco-style caption.\\n"

bus_image_url = "https://huggingface.co/datasets/hf-internal-testing/fixtures-captioning/resolve/main/bus.png"
bus_image_pil = Image.open(io.BytesIO(requests.get(bus_image_url).content))
inputs_to_model = processor(images=bus_image_pil, text=text_prompt)

该模型由 Molbap 贡献。原始代码可以在这里找到。

  • Fuyu 使用基于 `sentencepiece` 的分词器,模型为 `Unigram`。它支持字节回退,这仅在 `tokenizers==0.14.0` 的快速分词器中可用。由于 `LlamaTokenizer` 是 sentencepiece 的标准包装器,因此被使用。

  • 作者建议使用以下提示进行图像描述:`f"生成一个 coco 风格的描述。\\n"`

FuyuConfig

class transformers.FuyuConfig

< >

( vocab_size = 262144 hidden_size = 4096 intermediate_size = 16384 num_hidden_layers = 36 num_attention_heads = 64 hidden_act = 'relu2' max_position_embeddings = 16384 image_size = 300 patch_size = 30 num_channels = 3 initializer_range = 0.02 layer_norm_eps = 1e-05 use_cache = True tie_word_embeddings = False rope_theta = 25000.0 rope_scaling = None qk_layernorm = True hidden_dropout = 0.0 attention_dropout = 0.0 partial_rotary_factor = 0.5 pad_token_id = None bos_token_id = 1 eos_token_id = 2 image_token_id = 71011 text_config = None **kwargs )

参数

  • vocab_size (int, 可选, 默认为 262144) — Fuyu 模型的词汇表大小。定义了在调用 FuyuForCausalLM 时传入的 `inputs_ids` 可以表示的不同词元的数量。
  • hidden_size (int, 可选, 默认为 4096) — 隐藏表示的维度。
  • intermediate_size (int, 可选, 默认为 16384) — MLP 表示的维度。
  • num_hidden_layers (int, 可选, 默认为 36) — Transformer 编码器中的隐藏层数量。
  • num_attention_heads (int, 可选, 默认为 64) — Transformer 编码器中每个注意力层的注意力头数量。
  • hidden_act (strfunction, 可选, 默认为 "relu2") — 解码器中的非线性激活函数(函数或字符串)。
  • max_position_embeddings (int, 可选, 默认为 16384) — 该模型可能使用的最大序列长度。
  • image_size (int, 可选, 默认为 300) — 输入图像的大小。
  • patch_size (int, 可选, 默认为 30) — 输入视觉 Transformer 编码的补丁大小。
  • num_channels (int, 可选, 默认为 3) — 输入图像的通道数。
  • initializer_range (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的截断正态分布初始化器的标准差。
  • layer_norm_eps (float, 可选, 默认为 1e-05) — RMS 归一化层使用的 epsilon 值。
  • use_cache (bool, 可选, 默认为 `True`) — 模型是否应返回最后一个键/值注意力(并非所有模型都使用)。仅在 `config.is_decoder=True` 时相关。是否绑定权重嵌入
  • tie_word_embeddings (bool, 可选, 默认为 `False`) — 是否绑定输入和输出嵌入。
  • rope_theta (float, 可选, 默认为 25000.0) — RoPE 嵌入的基周期。
  • rope_scaling (Dict, 可选) — 包含 RoPE 嵌入缩放配置的字典。目前支持两种缩放策略:线性和动态。它们的缩放因子必须是大于 1 的浮点数。预期格式为 `{"type": 策略名称, "factor": 缩放因子}`。使用此标志时,不要将 `max_position_embeddings` 更新为预期的新最大值。有关这些缩放策略行为的更多信息,请参阅以下帖子:https://www.reddit.com/r/LocalFuyu/comments/14mrgpr/dynamically_scaled_rope_further_increases/。这是一个实验性功能,可能会在未来版本中发生破坏性 API 更改。
  • qk_layernorm (bool, 可选, 默认为 `True`) — 是否在投影隐藏状态后对查询(Queries)和键(Keys)进行归一化
  • hidden_dropout (float, 可选, 默认为 0.0) — 在将 MLP 应用于隐藏状态后的 dropout 比率。
  • attention_dropout (float, 可选, 默认为 0.0) — 计算注意力分数后的 dropout 比率。
  • partial_rotary_factor (float, 可选, 默认为 0.5) — 将具有旋转嵌入的查询和键的百分比。
  • pad_token_id (int, 可选) — 填充 词元的 ID。
  • bos_token_id (int, 可选, 默认为 1) — 序列开始 词元的 ID。
  • eos_token_id (Union[int, list[int]], 可选, 默认为 2) — 序列结束 词元的 ID。可选地,可以使用一个列表来设置多个 序列结束 词元。
  • image_token_id (int, 可选, 默认为 71011) — 图像占位符词元的 ID。
  • text_config (dict, 可选) — 用于初始化 `language```Aut` 的配置选项字典。

这是用于存储 FuyuForCausalLM 配置的配置类。它用于根据指定的参数实例化一个 Fuyu 模型,定义模型架构。使用默认值实例化一个配置将产生与 adept/fuyu-8b 类似的配置。

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

>>> from transformers import FuyuConfig

>>> # Initializing a Fuyu fuyu-7b style configuration
>>> configuration = FuyuConfig()

FuyuModel

class transformers.FuyuModel

< >

( config: FuyuConfig )

参数

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

Fuyu 模型由视觉主干和语言模型组成,不带语言模型头。

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

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

forward

< >

( input_ids: LongTensor = None image_patches: Tensor = None image_patches_indices: Tensor = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[list[torch.FloatTensor]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None **kwargs ) transformers.modeling_outputs.CausalLMOutputWithPasttuple(torch.FloatTensor)

参数

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

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

    什么是输入 ID?

  • image_patches (torch.FloatTensor,形状为 (batch_size, num_total_patches, patch_size_ x patch_size x num_channels), 可选) — 用作连续嵌入的图像块。图像块被展平,然后投影到模型的隐藏大小。
  • image_patches_indices (torch.LongTensor,形状为 (batch_size, sequence_length), 可选) — input_ids 张量中图像块的索引张量。
  • attention_mask (torch.Tensor,形状为 (batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值选自 [0, 1]

    • 1 表示标记未被掩码
    • 0 表示标记被掩码

    什么是注意力掩码?

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

    什么是位置 ID?

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

    允许两种格式:

    • Cache 实例,请参阅我们的 kv 缓存指南
    • 长度为 config.n_layerstuple(torch.FloatTensor) 元组,每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量。这也称为旧版缓存格式。

    模型将输出与输入相同的缓存格式。如果未传递 past_key_values,将返回旧版缓存格式。

    如果使用 past_key_values,用户可以选择只输入最后一个形状为 (batch_size, 1)input_ids(那些没有为其提供过去键值状态的标记),而不是所有形状为 (batch_size, sequence_length)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.modeling_outputs.CausalLMOutputWithPasttuple(torch.FloatTensor)

一个 transformers.modeling_outputs.CausalLMOutputWithPast 或一个 `torch.FloatTensor` 元组(如果传递了 `return_dict=False` 或当 `config.return_dict=False` 时),根据配置(FuyuConfig)和输入,包含各种元素。

  • loss (torch.FloatTensor 形状为 (1,)可选,当提供 labels 时返回) — 语言建模损失(用于下一个 token 预测)。

  • logits (形状为 (batch_size, sequence_length, config.vocab_size)torch.FloatTensor) — 语言建模头部的预测分数(SoftMax 之前的每个词汇标记的分数)。

  • past_key_values (Cache, 可选, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 这是一个 Cache 实例。有关更多详细信息,请参阅我们的 kv 缓存指南

    包含预计算的隐藏状态(自注意力块中的键和值),可用于(参见 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 后的注意力权重,用于计算自注意力头中的加权平均值。

FuyuModel 的前向方法,覆盖了 `__call__` 特殊方法。

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

gather_continuous_embeddings

< >

( word_embeddings: Tensor continuous_embeddings: list image_patch_input_indices: Tensor )

参数

  • word_embeddings (torch.FloatTensor,形状为 (batch_size, sequence_length, hidden_size)) — 词嵌入张量。
  • continuous_embeddings (torch.FloatTensor,形状为 (batch_size, num_patches, hidden_size)) — 连续嵌入张量。列表的长度是批次大小。每个条目的形状为 [num_image_embeddings, hidden],并且 num_image_embeddings 需要与该批次元素的 image_patch_input_indices 中的非负索引数匹配。
  • image_patch_input_indices (torch.LongTensor,形状为 (batch_size, sequence_length)) — input_ids 张量中图像块的索引张量。

此函数将 continuous_embeddings 放置到 image_patch_input_indices 指示的位置的 word_embeddings 中。不同的批次元素可以有不同数量的连续嵌入。

get_image_features

< >

( pixel_values: FloatTensor **kwargs )

参数

  • pixel_values (torch.FloatTensor,形状为 (batch_size, num_channels, image_size, image_size)) — 对应于输入图像的张量。

将图像编码为可以转发到语言模型的连续嵌入。

FuyuForCausalLM

class transformers.FuyuForCausalLM

< >

( config: FuyuConfig )

参数

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

Fuyu 模型,顶部带有一个语言建模头,用于在图像块和文本上进行条件因果语言建模。

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

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

forward

< >

( input_ids: LongTensor = None image_patches: Tensor = None image_patches_indices: Tensor = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[list[torch.FloatTensor]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None use_cache: typing.Optional[bool] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None logits_to_keep: typing.Optional[int] = 0 **kwargs ) transformers.modeling_outputs.CausalLMOutputWithPasttuple(torch.FloatTensor)

参数

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

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

    什么是输入 ID?

  • image_patches (torch.FloatTensor,形状为 (batch_size, num_total_patches, patch_size_ x patch_size x num_channels), 可选) — 用作连续嵌入的图像块。图像块被展平,然后投影到模型的隐藏大小。
  • image_patches_indices (torch.LongTensor,形状为 (batch_size, sequence_length), 可选) — input_ids 张量中图像块的索引张量。
  • attention_mask (torch.Tensor,形状为 (batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值选自 [0, 1]

    • 1 表示标记未被掩码
    • 0 表示标记被掩码

    什么是注意力掩码?

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

    什么是位置 ID?

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

    允许两种格式:

    • Cache 实例,请参阅我们的 kv 缓存指南
    • 长度为 config.n_layerstuple(torch.FloatTensor) 元组,每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量。这也称为旧版缓存格式。

    模型将输出与输入相同的缓存格式。如果未传递 past_key_values,将返回旧版缓存格式。

    如果使用 past_key_values,用户可以选择只输入最后一个形状为 (batch_size, 1)input_ids(那些没有为其提供过去键值状态的标记),而不是所有形状为 (batch_size, sequence_length)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)。
  • labels (torch.LongTensor,形状为 (batch_size, sequence_length), 可选) — 用于计算掩码语言建模损失的标签。索引应在 [0, ..., config.text_config.vocab_size] 或 -100 之间(请参阅 input_ids 文档)。索引设置为 -100 的标记将被忽略(掩码),损失仅针对标签在 [0, ..., config.text_config.vocab_size] 中的标记计算。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的 hidden_states
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。
  • logits_to_keep (int, 可选, 默认为 0) — 如果是 int,则计算最后 logits_to_keep 个标记的 logits。如果为 0,则计算所有 input_ids 的 logits(特殊情况)。生成时只需要最后一个标记的 logits,仅为该标记计算它们可以节省内存,这对于长序列或大词汇量来说非常重要。如果是 torch.Tensor,则必须是一维的,对应于序列长度维度中要保留的索引。这在使用打包张量格式(批次和序列长度使用单一维度)时非常有用。

返回

transformers.modeling_outputs.CausalLMOutputWithPasttuple(torch.FloatTensor)

一个 transformers.modeling_outputs.CausalLMOutputWithPast 或一个 `torch.FloatTensor` 元组(如果传递了 `return_dict=False` 或当 `config.return_dict=False` 时),根据配置(FuyuConfig)和输入,包含各种元素。

  • loss (torch.FloatTensor 形状为 (1,)可选,当提供 labels 时返回) — 语言建模损失(用于下一个 token 预测)。

  • logits (形状为 (batch_size, sequence_length, config.vocab_size)torch.FloatTensor) — 语言建模头部的预测分数(SoftMax 之前的每个词汇标记的分数)。

  • past_key_values (Cache, 可选, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 这是一个 Cache 实例。有关更多详细信息,请参阅我们的 kv 缓存指南

    包含预计算的隐藏状态(自注意力块中的键和值),可用于(参见 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 后的注意力权重,用于计算自注意力头中的加权平均值。

FuyuForCausalLM 的前向方法,覆盖了 `__call__` 特殊方法。

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

示例

>>> from transformers import FuyuProcessor, FuyuForCausalLM
>>> from PIL import Image
>>> import requests

>>> processor = FuyuProcessor.from_pretrained("adept/fuyu-8b")
>>> model = FuyuForCausalLM.from_pretrained("adept/fuyu-8b")

>>> url = "https://huggingface.co/datasets/hf-internal-testing/fixtures-captioning/resolve/main/bus.png"
>>> image = Image.open(requests.get(url, stream=True).raw)
>>> prompt = "Generate a coco-style caption.\n"

>>> inputs = processor(images=image, text=prompt, return_tensors="pt")
>>> outputs = model(**inputs)

>>> generated_ids = model.generate(**inputs, max_new_tokens=7)
>>> generation_text = processor.batch_decode(generated_ids[:, -7:], skip_special_tokens=True)
>>> print(generation_text[0])
A blue bus parked on the side of a road.

FuyuImageProcessor

class transformers.FuyuImageProcessor

< >

( do_resize: bool = True size: typing.Optional[dict[str, int]] = None resample: Resampling = <Resampling.BILINEAR: 2> do_pad: bool = True padding_value: float = 1.0 padding_mode: str = 'constant' do_normalize: bool = True image_mean: typing.Union[float, list[float]] = 0.5 image_std: typing.Union[float, list[float]] = 0.5 do_rescale: bool = True rescale_factor: float = 0.00392156862745098 patch_size: typing.Optional[dict[str, int]] = None **kwargs )

参数

  • do_resize (bool, 可选, 默认为 True) — 是否将图像大小调整为 size
  • size (dict[str, int], 可选, 默认为 {"height" -- 1080, "width": 1920}): 格式为 {"height": int, "width": int} 的字典,用于指定输出图像的大小。
  • resample (PILImageResampling, 可选, 默认为 Resampling.BILINEAR) — 调整图像大小时使用的 PILImageResampling 滤波器,例如 PILImageResampling.BILINEAR
  • do_pad (bool, 可选, 默认为 True) — 是否将图像填充到 size
  • padding_value (float, 可选, 默认为 1.0) — 用于填充图像的值。
  • padding_mode (str, 可选, 默认为 "constant") — 填充图像时使用的填充模式。
  • do_normalize (bool, optional, defaults to True) — 是否对图像进行归一化。
  • image_mean (float, optional, defaults to 0.5) — 归一化图像时使用的均值。
  • image_std (float, optional, defaults to 0.5) — 归一化图像时使用的标准差。
  • do_rescale (bool, optional, defaults to True) — 是否对图像进行缩放。
  • rescale_factor (float, optional, defaults to 1 / 255) — 缩放图像时使用的因子。
  • patch_size (dict[str, int], optional, defaults to {"height" -- 30, "width": 30}): 格式为 {"height": int, "width": int} 的字典,用于指定图像块的大小。

此类应处理 FuyuForCausalLM 主模型之前的图像处理部分。具体来说,它应处理:

  • 处理图像:以一批图像作为输入。如果图像大小可变,它会根据所需的图像块尺寸调整它们的大小。图像输出的 img_h 和 img_w 始终为 (1080, 1920)。

    然后,它使用 patchify_image 函数将这些图像分块。

  • 创建图像输入 ID:为每个图像块分配一个占位符 ID,以标识这些图像块在词元序列中的位置。对于可变大小的图像,每行图像块都以一个换行符 ID 结尾。

  • 图像块索引:对于每个图像块,代码会维护一个索引,指示这些图像块应插入到词元流中的位置。

__call__

< >

( images **kwargs )

预处理单张或批量图像。

FuyuProcessor

class transformers.FuyuProcessor

< >

( image_processor tokenizer **kwargs )

参数

构建一个 Fuyu 处理器,它将 Fuyu 图像处理器和 Llama 分词器包装成一个单一的处理器。

FuyuProcessor 提供了 FuyuImageProcessorLlamaTokenizerFast 的所有功能。更多信息请参阅 call()decode() 方法。

__call__

< >

( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']] = None text: typing.Union[str, list[str], NoneType] = None audio = None videos = None **kwargs: typing_extensions.Unpack[transformers.models.fuyu.processing_fuyu.FuyuProcessorKwargs] ) FuyuBatchEncoding

参数

  • images (PIL.Image.Image, list[PIL.Image.Image]) — 要准备的图像或一批图像。每个图像可以是 PIL 图像、NumPy 数组或 PyTorch 张量。支持通道优先(channels-first)和通道置后(channels-last)格式。
  • text (str, list[str]) — 要编码的序列或一批序列。每个序列可以是一个字符串或一个字符串列表(预分词的字符串)。如果序列以字符串列表的形式提供(预分词),则必须设置 is_split_into_words=True(以消除与一批序列的歧义)。

返回

FuyuBatchEncoding

一个具有以下字段的 `FuyuBatchEncoding`:

  • input_ids — 要馈送给模型的词元 ID 张量。当 `text` 不为 `None` 时返回。
  • image_patches — 图像块张量的列表。当 `images` 不为 `None` 时返回。
  • image_patches_indices — 模型需要插入图像块嵌入位置的索引张量。
  • attention_mask — 当 `return_attention_mask=True` 时,指定模型应关注哪些词元的索引列表。

为模型准备一个或多个序列和图像的主要方法。如果 `text` 不为 `None`,此方法会将 `text` 和 `kwargs` 参数转发给 LlamaTokenizerFast 的 call() 方法以编码文本。如果 `images` 不为 `None`,此方法会为准备图像将 `images` 和 `kwargs` 参数转发给 FuyuImageProcessor 的 call() 方法。请参阅上述两个方法的文档字符串以获取更多信息。

< > 在 GitHub 上更新