Fuyu
概述
Fuyu模型由ADEPT创建,作者包括Rohan Bavishi、Erich Elsen、Curtis Hawthorne、Maxwell Nye、Augustus Odena、Arushi Somani和Sağnak Taşırlar。
作者介绍了Fuyu-8B,这是一个基于经典transformers架构的解码器多模态模型,具有查询和键归一化功能。添加了一个线性编码器,用于从图像输入创建多模态嵌入。
通过将图像标记像文本标记一样处理,并使用特殊的图像换行符,模型知道图像行何时结束。图像位置嵌入被移除。这避免了为不同图像分辨率进行不同训练阶段的需要。Fuyu-8B拥有80亿个参数,并在CC-BY-NC许可下发布,以其处理文本和图像的能力、令人印象深刻的16K上下文大小以及整体性能而著称。
Fuyu
模型是使用 bfloat16
进行训练的,但原始推理使用的是 float16
。在 hub 上上传的检查点使用 torch_dtype = 'float16'
,这将由 AutoModel
API 用于将检查点从 torch.float32
转换为 torch.float16
。
在线权重的dtype
大多无关紧要,除非你在使用torch_dtype="auto"
初始化模型时使用model = AutoModelForCausalLM.from_pretrained("path", 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)
Fuyu 使用基于
sentencepiece
的分词器,采用Unigram
模型。它支持字节回退功能,该功能仅在tokenizers==0.14.0
中可用于快速分词器。 使用LlamaTokenizer
是因为它是 sentencepiece 的标准封装器。作者建议使用以下提示进行图像描述:
f"Generate a coco-style caption.\\n"
FuyuConfig
类 transformers.FuyuConfig
< source >( 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 text_config = None **kwargs )
参数
- vocab_size (
int
, 可选, 默认为 262144) — Fuyu 模型的词汇量大小。定义了调用 FuyuForCausalLM 时传递的inputs_ids
可以表示的不同标记的数量 - hidden_size (
int
, optional, defaults to 4096) — 隐藏表示的维度。 - intermediate_size (
int
, optional, 默认为 16384) — MLP 表示的维度。 - num_hidden_layers (
int
, optional, 默认为 36) — Transformer 编码器中的隐藏层数量。 - num_attention_heads (
int
, optional, 默认为 64) — Transformer 编码器中每个注意力层的注意力头数量。 - hidden_act (
str
或function
, 可选, 默认为"relu2"
) — 解码器中的非线性激活函数(函数或字符串)。 - max_position_embeddings (
int
, optional, 默认为 16384) — 此模型可能使用的最大序列长度。 - image_size (
int
, optional, defaults to 300) — 输入图像的大小。 - patch_size (
int
, optional, 默认为 30) — 输入视觉变换器编码的补丁大小。 - num_channels (
int
, optional, defaults to 3) — 输入图像的通道数。 - initializer_range (
float
, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。 - layer_norm_eps (
float
, optional, defaults to 1e-05) — 用于rms归一化层的epsilon值。 - use_cache (
bool
, 可选, 默认为True
) — 模型是否应返回最后的键/值注意力(并非所有模型都使用)。仅在config.is_decoder=True
时相关。是否绑定权重嵌入 - tie_word_embeddings (
bool
, 可选, 默认为False
) — 是否绑定输入和输出的嵌入。 - rope_theta (
float
, optional, 默认为 25000.0) — RoPE 嵌入的基础周期。 - rope_scaling (
Dict
, optional) — Dictionary containing the scaling configuration for the RoPE embeddings. Currently supports two scaling strategies: linear and dynamic. Their scaling factor must be a float greater than 1. The expected format is{"type": strategy name, "factor": scaling factor}
. When using this flag, don’t updatemax_position_embeddings
to the expected new maximum. See the following thread for more information on how these scaling strategies behave: https://www.reddit.com/r/LocalFuyu/comments/14mrgpr/dynamically_scaled_rope_further_increases/. This is an experimental feature, subject to breaking API changes in future versions. - qk_layernorm (
bool
, optional, defaults toTrue
) — 是否在投影隐藏状态后对查询和键进行归一化 - hidden_dropout (
float
, optional, defaults to 0.0) — 在将MLP应用于隐藏状态后的丢弃比率。 - attention_dropout (
float
, optional, defaults to 0.0) — 计算注意力分数后的丢弃比率。 - partial_rotary_factor (
float
, optional, defaults to 0.5) — 查询和键中将具有旋转嵌入的百分比。 - pad_token_id (
int
, optional) — padding 标记的 ID。 - bos_token_id (
int
, optional, 默认为 1) — beginning-of-sequence 标记的 id. - eos_token_id (
Union[int, List[int]]
, optional, 默认为 2) — 结束序列标记的ID。可选地,使用列表来设置多个结束序列标记。 - text_config (
dict
, 可选) — 用于初始化language```Aut
的配置选项字典。
这是用于存储FuyuForCausalLM配置的配置类。它用于根据指定的参数实例化一个Fuyu模型,定义模型架构。使用默认值实例化配置将产生类似于adept/fuyu-8b的配置。
配置对象继承自PretrainedConfig,可用于控制模型输出。阅读PretrainedConfig的文档以获取更多信息。
FuyuForCausalLM
类 transformers.FuyuForCausalLM
< source >( config: FuyuConfig )
参数
- config (FuyuConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,仅加载配置。查看 from_pretrained() 方法以加载模型权重。
Fuyu 模型,顶部带有语言建模头,用于基于图像块和文本的条件因果语言模型。 该模型继承自 PreTrainedModel。请查看超类文档以了解库为其所有模型实现的通用方法(如下载或保存、调整输入嵌入大小、修剪头等)。
该模型也是一个PyTorch torch.nn.Module 子类。 将其作为常规的PyTorch模块使用,并参考PyTorch文档以获取与一般使用和行为相关的所有信息。
前进
< source >( 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[typing.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 ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(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()。
- 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.
- image_patches (
torch.FloatTensor
of shape(batch_size, num_total_patches, patch_size_ x patch_size x num_channels)
, optional) — 用作连续嵌入的图像补丁。补丁被展平后投影到模型的隐藏大小。 - image_patches_indices (
torch.LongTensor
of shape(batch_size, num_total_patches + number_of_newline_tokens + number_of_text_tokens, patch_size_ x patch_size x num_channels )
, optional) — 指示图像补丁在input_embeds中插入位置的索引。 - position_ids (
torch.LongTensor
of shape(batch_size, sequence_length)
, optional) — Indices of positions of each input sequence tokens in the position embeddings. Selected in the range[0, config.n_positions - 1]
. - past_key_values (
tuple(tuple(torch.FloatTensor))
, optional, returned whenuse_cache=True
is passed or whenconfig.use_cache=True
) — Tuple oftuple(torch.FloatTensor)
of lengthconfig.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
形状为(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 而不是一个普通的元组。 - labels (
torch.LongTensor
of shape(batch_size, sequence_length)
, optional) — 用于计算掩码语言建模损失的标签。索引应在[0, ..., config.text_config.vocab_size]
或 -100 之间(参见input_ids
文档字符串)。索引设置为-100
的标记将被忽略 (掩码),损失仅针对标签在[0, ..., config.text_config.vocab_size]
范围内的标记计算。
返回
transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithPast 或一个由
torch.FloatTensor
组成的元组(如果传递了 return_dict=False
或当 config.return_dict=False
时),包含各种
元素,具体取决于配置(FuyuConfig)和输入。
-
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)
元组,每个元组包含 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 后的注意力权重,用于计算自注意力头中的加权平均值。
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
类 transformers.FuyuImageProcessor
< source >( do_resize: bool = True size: typing.Optional[typing.Dict[str, int]] = None resample: Resampling =
参数
- do_resize (
bool
, optional, defaults toTrue
) — 是否将图像调整为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
, optional, 默认为 1.0) — 用于填充图像的值。 - padding_mode (
str
, optional, defaults to"constant"
) — 填充图像时使用的填充模式。 - do_normalize (
bool
, optional, defaults toTrue
) — 是否对图像进行归一化。 - image_mean (
float
, optional, defaults to 0.5) — 在归一化图像时使用的均值。 - image_std (
float
, optional, 默认为 0.5) — 用于标准化图像的标准差。 - do_rescale (
bool
, optional, defaults toTrue
) — 是否对图像进行重新缩放. - rescale_factor (
float
, 可选, 默认为1 / 255
) — 用于重新缩放图像的因子。 - patch_size (
Dict[str, int]
, 可选, 默认为{"height" -- 30, "width": 30}
): 格式为{"height": int, "width": int}
的字典,指定补丁的大小。
这个类应该在主FuyuForCausalLM之前处理图像处理部分。特别是,它应该处理:
处理图像: 将一批图像作为输入。如果图像大小可变,则根据所需的补丁尺寸调整它们的大小。图像输出始终为img_h, img_w,尺寸为(1080, 1920)
然后,它使用 patchify_image 函数修补这些图像。
创建图像输入ID: 对于每个补丁,都会分配一个占位符ID,以标识这些补丁在令牌序列中的位置。对于 可变大小的图像,每行补丁都以换行ID结束。
图像补丁索引: 对于每个图像补丁,代码维护一个索引,指示这些补丁应插入到令牌流中的位置。
预处理一张图像或一批图像。
FuyuProcessor
类 transformers.FuyuProcessor
< source >( image_processor tokenizer **kwargs )
参数
- image_processor (FuyuImageProcessor) — 图像处理器是一个必需的输入。
- tokenizer (LlamaTokenizerFast) — tokenizer 是一个必需的输入。
构建一个Fuyu处理器,它将Fuyu图像处理器和Llama分词器封装到一个单一的处理器中。
FuyuProcessor 提供了 FuyuImageProcessor 和 LlamaTokenizerFast 的所有功能。更多信息请参见
call() 和 decode()
。
__call__
< source >( 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')]] = None text: typing.Union[str, typing.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张量。支持通道优先和通道最后的格式。 - 文本 (
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()。请参考上述两个方法的文档字符串以获取更多信息。