Transformers 文档
PaliGemma
并获取增强的文档体验
开始使用
PaliGemma
概述
PaliGemma 模型由 Google 在 PaliGemma – Google 的尖端开放视觉语言模型 中提出。它是由 SigLIP 视觉编码器和 Gemma 语言解码器组成的 3B 视觉-语言模型，两者通过多模态线性投影连接。它将图像切割成固定数量的 VIT token，并将其添加到可选的提示之前。一个特点是该模型在所有图像 token 加上输入文本 token 上使用全块注意力。它有 3 种分辨率：224x224、448x448 和 896x896，带有 3 个基础模型、55 个针对不同任务微调的版本以及 2 个混合模型。
PaliGemma 架构。取自博客文章。此模型由 Molbap 贡献。
使用技巧
- 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")使用示例
该模型可以接受单张或多张图像。根据论文，检查点 PaliGemma 可以迁移到将多张图像作为输入的任务。NLVR2 就是这样一个任务，它会询问一个关于两张图像的问题，并且需要查看两张图像才能给出正确的答案。这是一个关于单张和多张图像推理的示例代码。
单张图像推理
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)[inputs.input_ids.shape[1]: ])多张图像推理
model_id = "google/paligemma-3b-ft-nlvr2-448" # checkpoint tuned for multiple images
model = PaliGemmaForConditionalGeneration.from_pretrained(model_id)
processor = PaliGemmaProcessor.from_pretrained(model_id)
prompt = "answer en Which of the two pictures shows a snowman, first or second?"
stop_sign_image = Image.open(
requests.get("https://www.ilankelman.org/stopsigns/australia.jpg", stream=True).raw
)
snow_image = Image.open(
requests.get(
"https://huggingface.co/microsoft/kosmos-2-patch14-224/resolve/main/snowman.jpg", stream=True
).raw
)
inputs = processor(images=[[snow_image, stop_sign_image]], text=prompt, return_tensors="pt")
output = model.generate(**inputs, max_new_tokens=20)
print(processor.decode(output[0], skip_special_tokens=True)[inputs.input_ids.shape[1]: ])
资源
以下是 Hugging Face 官方和社区（标有 🌎）资源的列表，可帮助您开始使用 PaliGemma。如果您有兴趣提交资源以包含在此处，请随时打开 Pull Request，我们将对其进行审核！理想情况下，资源应展示一些新内容，而不是重复现有资源。
- 一篇介绍 PaliGemma 所有功能的博客文章可以在这里找到。
- 关于如何使用 Trainer API 对 PaliGemma 进行 VQA 微调以及推理的演示 notebook 可以在这里找到。
- 关于如何在自定义数据集（收据图像 -> JSON）上微调 PaliGemma 以及推理的演示 notebook 可以在这里找到。 🌎
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传入的不同 token 的数量。 - 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 (GemmaTokenizerFast, 可选) — 分词器是必需的输入。
- chat_template (
str, 可选) — Jinja 模板，将用于将聊天中的消息列表转换为可标记化的字符串。
构建一个 PaliGemma 处理器，它将 PaliGemma 图像处理器和 PaliGemma 分词器包装到一个处理器中。
PaliGemmaProcessor 提供 SiglipImageProcessor 和 GemmaTokenizerFast 的所有功能。 有关更多信息，请参阅 __call__() 和 decode()。
此方法将其所有参数转发到 GemmaTokenizerFast 的 batch_decode()。 有关更多信息，请参阅此方法的文档字符串。
PaliGemmaForConditionalGeneration
class transformers.PaliGemmaForConditionalGeneration
< 源代码 >( config: PaliGemmaConfig )
参数
- config (PaliGemmaConfig 或
PaliGemmaVisionConfig) — 包含模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重，仅加载配置。 查看 from_pretrained() 方法以加载模型权重。
PALIGEMMA 模型，由视觉骨干网络和语言模型组成。 此模型继承自 PreTrainedModel。 查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
此模型也是 PyTorch torch.nn.Module 子类。 将其用作常规 PyTorch 模块，并参阅 PyTorch 文档，了解与常规用法和行为相关的所有事项。
forward
< 源代码 >( input_ids: LongTensor = None pixel_values: FloatTensor = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Union[typing.List[torch.FloatTensor], transformers.cache_utils.Cache, NoneType] = None token_type_ids: typing.Optional[torch.LongTensor] = None cache_position: typing.Optional[torch.LongTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = 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 return_dict: typing.Optional[bool] = None logits_to_keep: typing.Union[int, torch.Tensor] = 0 **lm_kwargs ) → transformers.models.paligemma.modeling_paligemma.PaliGemmaCausalLMOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 token 的索引。 如果您提供 padding，默认情况下将被忽略。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- pixel_values (
torch.FloatTensor，形状为(batch_size, num_channels, image_size, image_size))— 与输入图像对应的张量。 像素值可以使用 [AutoImageProcessor](/docs/transformers/v4.50.0/en/model_doc/auto#transformers.AutoImageProcessor) 获得。 有关详细信息，请参阅 [SiglipImageProcessor.__call__()](/docs/transformers/v4.50.0/en/model_doc/vilt#transformers.ViltFeatureExtractor.__call__) ([]PaliGemmaProcessor] 使用 SiglipImageProcessor 处理图像)。 - attention_mask (
torch.Tensor，形状为(batch_size, sequence_length), 可选) — Mask，用于避免在 padding token 索引上执行 attention。 Mask 值在[0, 1]中选择：- 1 表示 token 未被 mask，
- 0 表示 token 已被 mask。
索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
如果使用
past_key_values，则可以选择仅输入最后的decoder_input_ids（请参阅past_key_values）。如果您想更改 padding 行为，您应该阅读
modeling_opt._prepare_decoder_attention_mask并根据您的需要进行修改。 有关默认策略的更多信息，请参阅 论文 中的图 1。- 1 表示 head 未被 mask，
- 0 表示 head 已被 mask。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列 token 的位置索引。 在范围[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))，每个 tuple 有 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)而不是所有形状为(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 而不是纯元组。 - 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]中的标记计算。 - logits_to_keep (
int或torch.Tensor，可选) — 如果是int，则计算最后logits_to_keep个标记的 logits。 如果是0，则计算所有input_ids的 logits（特殊情况）。 生成只需要最后一个标记 logits，并且仅针对该标记计算它们可以节省内存，这对于长序列或大词汇量来说变得非常重要。 如果是torch.Tensor，则必须是与序列长度维度中要保留的索引对应的 1D 张量。 这在使用打包张量格式（批次和序列长度的单维度）时很有用。
返回
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时返回) — 语言建模损失（用于下一个标记预测）。 -
logits (
torch.FloatTensor，形状为(batch_size, sequence_length, config.text_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 之后的注意力权重，用于计算自注意力头中的加权平均值。
-
image_hidden_states (
torch.FloatTensor, 可选) — 大小为(batch_size, num_images, sequence_length, hidden_size)的torch.FloatTensor。视觉编码器在投影最后一个隐藏状态后生成的模型的 image_hidden_states。
PaliGemmaForConditionalGeneration forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward 传递的配方需要在该函数中定义，但应该在之后调用 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"