PaliGemma
概述
PaliGemma 模型由 Google 在 PaliGemma – Google’s Cutting-Edge Open Vision Language Model 中提出。它是一个 30 亿参数的视觉语言模型，由 SigLIP 视觉编码器和 Gemma 语言解码器组成，并通过多模态线性投影连接。它将图像切割成固定数量的 VIT token，并将这些 token 附加到可选的提示中。模型的一个特点是它对所有图像 token 和输入文本 token 使用全块注意力。它有 3 种分辨率，分别为 224x224、448x448 和 896x896，3 种基础模型，55 个针对不同任务的微调版本，以及 2 个混合模型。
PaliGemma 架构。取自 博客文章该模型由 Molbap 贡献。
使用技巧
使用 PaliGemma 进行推理可以按照以下步骤操作
from transformers import AutoProcessor, PaliGemmaForConditionalGeneration
model_id = "google/paligemma-3b-mix-224"
model = PaliGemmaForConditionalGeneration.from_pretrained(model_id)
processor = AutoProcessor.from_pretrained(model_id)
prompt = "What is on the flower?"
image_file = "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/bee.jpg?download=true"
raw_image = Image.open(requests.get(image_file, stream=True).raw)
inputs = processor(raw_image, prompt, return_tensors="pt")
output = model.generate(**inputs, max_new_tokens=20)
print(processor.decode(output[0], skip_special_tokens=True)[len(prompt):])- PaliGemma 不适用于对话式使用，并且在微调到特定用例时效果最佳。PaliGemma 可以微调的一些下游任务包括图像字幕、视觉问答（VQA）、目标检测、指代表达式分割和文档理解。
- 可以使用
PaliGemmaProcessor为模型准备图像、文本和可选标签。在微调 PaliGemma 模型时，可以将suffix参数传递给处理器，该处理器会为模型创建labels。
prompt = "What is on the flower?"
answer = "a bee"
inputs = processor(images=raw_image, text=prompt, suffix=answer, return_tensors="pt")资源
以下是一些官方 Hugging Face 和社区（🌎 表示）资源，可帮助您开始使用 PaliGemma。如果您想提交资源以供在此处包含，请随时打开拉取请求，我们将进行审查！资源最好能展示一些新东西，而不是重复现有资源。
- 一篇介绍 PaliGemma 所有功能的博客文章可以在这里找到 here.
- 使用 Trainer API 对 PaliGemma 进行 VQA 微调以及推理的演示笔记本可以在这里找到 here.
- 使用自定义数据集（收据图像 -> JSON）对 PaliGemma 进行微调以及推理的演示笔记本可以在这里找到 here. 🌎
PaliGemmaConfig
class transformers.PaliGemmaConfig
< source >( vision_config = None text_config = None ignore_index = -100 image_token_index = 256000 vocab_size = 257152 projection_dim = 2048 hidden_size = 2048 **kwargs )
参数
- vision_config (
PaliGemmaVisionConfig, 可选) — 自定义视觉配置或字典 - text_config (
Union[AutoConfig, dict], 可选) — 文本主干的配置对象。可以是LlamaConfig或MistralConfig中的任何一个。 - ignore_index (
int, 可选, 默认值为 -100) — 损失函数的忽略索引。 - image_token_index (
int, 可选, 默认值为 256000) — 用于编码图像提示的图像 token 索引。 - vocab_size (
int, 可选, 默认为 257152) — PaliGemma 模型的词汇量大小。定义了在调用 ~PaliGemmaForConditionalGeneration 时可以由inputs_ids表示的不同标记数量。 - projection_dim (
int, 可选, 默认为 2048) — 多模态投影空间的维度。 - hidden_size (
int, 可选, 默认为 2048) — 语言模型隐藏层的维度。
这是用于存储 PaliGemmaForConditionalGeneration 配置的配置类。它用于根据指定的参数实例化 PaliGemma 模型，定义模型架构。使用默认值实例化配置将产生与 PaliGemma-2B 类似的配置。
配置对象继承自 PretrainedConfig 并且可以用来控制模型输出。阅读 PretrainedConfig 的文档以了解更多信息。
例子
>>> from transformers import PaliGemmaForConditionalGeneration, PaliGemmaConfig, SiglipVisionConfig, GemmaConfig
>>> # Initializing a Siglip-like vision config
>>> vision_config = SiglipVisionConfig()
>>> # Initializing a PaliGemma config
>>> text_config = GemmaConfig()
>>> # Initializing a PaliGemma paligemma-3b-224 style configuration
>>> configuration = PaliGemmaConfig(vision_config, text_config)
>>> # Initializing a model from the paligemma-3b-224 style configuration
>>> model = PaliGemmaForConditionalGeneration(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configPaliGemmaProcessor
class transformers.PaliGemmaProcessor
< 源代码 >( image_processor = None tokenizer = None chat_template = None **kwargs )
参数
- image_processor (SiglipImageProcessor, 可选) — 图片处理器是必需的输入。
- tokenizer (LlamaTokenizerFast, 可选) — 分词器是必需的输入。
- chat_template (
str, 可选) — 将聊天中的消息列表转换为可分词字符串的 Jinja 模板。
构建 PaliGemma 处理器，它将 PaliGemma 图片处理器和 PaliGemma 分词器包装成一个单一的处理器。
PaliGemmaProcessor 提供了 SiglipImageProcessor 和 LlamaTokenizerFast 的所有功能。有关更多信息，请参阅 __call__() 和 decode()。
此方法将其所有参数转发给 GemmaTokenizerFast 的 batch_decode()。有关更多信息，请参阅此方法的文档字符串。
此方法将其所有参数转发给 GemmaTokenizerFast 的 decode()。有关更多信息，请参阅此方法的文档字符串。
PaliGemmaForConditionalGeneration
class transformers.PaliGemmaForConditionalGeneration
< source >( config: PaliGemmaConfig )
参数
- config (PaliGemmaConfig or
PaliGemmaVisionConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
PALIGEMMA 模型，包含视觉骨干网络和语言模型。此模型继承自 PreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以获取有关一般用法和行为的所有事项。
forward
< source >( input_ids: LongTensor = None pixel_values: FloatTensor = None attention_mask: Optional = None position_ids: Optional = None past_key_values: Union = None token_type_ids: Optional = None cache_position: Optional = None inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None num_logits_to_keep: int = 0 ) → transformers.models.paligemma.modeling_paligemma.PaliGemmaCausalLMOutputWithPast or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供填充，默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- pixel_values (
torch.FloatTensorof shape(batch_size, num_channels, image_size, image_size)) -- 与输入图像对应的张量。可以使用 [AutoImageProcessor](/docs/transformers/v4.45.2/en/model_doc/auto#transformers.AutoImageProcessor) 获取像素值。有关详细信息，请参阅 [SiglipImageProcessor.__call__()](/docs/transformers/v4.45.2/en/model_doc/videomae#transformers.VideoMAEFeatureExtractor.__call__) ([]`PaliGemmaProcessor`] 使用 SiglipImageProcessor 处理图像)。 - attention_mask (
torch.Tensor形状为(batch_size, sequence_length)，可选) — 用于避免对填充令牌索引进行注意力的掩码。 掩码值选择在[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.LongTensor形状为(batch_size, sequence_length)，可选) — 输入序列令牌在位置嵌入中的位置索引。 选择范围为[0, config.n_positions - 1]。 什么是位置 ID？ - 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)的张量，以及 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的附加张量。包含预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可以用来（参见
past_key_values输入）加速顺序解码。如果使用
past_key_values，用户可以选择仅输入最后一个decoder_input_ids（那些没有向此模型提供其过去键值状态的令牌）形状为(batch_size, 1)，而不是所有decoder_input_ids形状为(batch_size, sequence_length)。 - 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 而不是简单元组。 - cache_position (
torch.LongTensor形状为(sequence_length)，可选) — 表示输入序列令牌在序列中的位置的索引。 与position_ids相反，此张量不受填充的影响。 它用于在正确的位置更新缓存并推断完整的序列长度。参数 — labels (
torch.LongTensor形状为(batch_size, sequence_length)，可选)：用于计算掩码语言建模损失的标签。 索引应为[0, ..., config.text_config.vocab_size]或 -100（参见input_ids文档字符串）。 索引设置为-100的令牌将被忽略（掩码），损失仅针对标签在[0, ..., config.text_config.vocab_size]中的令牌计算。num_logits_to_keep (
int，可选)：为最后num_logits_to_keep个令牌计算 logits。 如果为0，则为所有input_ids计算 logits（特殊情况）。 仅生成需要最后一个令牌 logits，并且仅为该令牌计算它们可以节省内存，对于长序列或大型词汇量来说，这会变得非常显著。
返回
transformers.models.paligemma.modeling_paligemma.PaliGemmaCausalLMOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.models.paligemma.modeling_paligemma.PaliGemmaCausalLMOutputWithPast 或 torch.FloatTensor 的元组（如果传递 return_dict=False 或 config.return_dict=False），包含根据配置 (PaliGemmaConfig) 和输入的不同元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，在提供labels时返回) — 语言建模损失（用于下一个 token 预测）。 -
logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.text_config.vocab_size)) — 语言建模头的预测分数（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 后的注意力权重，用于计算自注意力头中的加权平均值。
-
image_hidden_states (
torch.FloatTensor，可选) — 大小为(batch_size, num_images, sequence_length, hidden_size)的torch.FloatTensor。由视觉编码器在投影最后一个隐藏状态后产生的模型的image_hidden_states。
PaliGemmaForConditionalGeneration 前向方法覆盖了 __call__ 特殊方法。
虽然前向传递的配方需要在此函数中定义，但应该在之后调用 Module 实例，而不是这个，因为前者负责运行预处理和后处理步骤，而后者则会静默地忽略它们。
例子
>>> from PIL import Image
>>> import requests
>>> from transformers import AutoProcessor, PaliGemmaForConditionalGeneration
>>> model = PaliGemmaForConditionalGeneration.from_pretrained("google/PaliGemma-test-224px-hf")
>>> processor = AutoProcessor.from_pretrained("google/PaliGemma-test-224px-hf")
>>> prompt = "answer en Where is the cow standing?"
>>> url = "https://huggingface.co/gv-hf/PaliGemma-test-224px-hf/resolve/main/cow_beach_1.png"
>>> image = Image.open(requests.get(url, stream=True).raw)
>>> inputs = processor(images=image, text=prompt, return_tensors="pt")
>>> # Generate
>>> generate_ids = model.generate(**inputs, max_length=30)
>>> processor.batch_decode(generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
"answer en Where is the cow standing?\nbeach"