Transformers 文档
InstructBlipVideo
并获得增强的文档体验
开始使用
InstructBlipVideo
概述
InstructBLIPVideo 是 Wenliang Dai、Junnan Li、Dongxu Li、Anthony Meng Huat Tiong、Junqi Zhao、Weisheng Wang、Boyang Li、Pascale Fung 和 Steven Hoi 在 InstructBLIP: Towards General-purpose Vision-Language Models with Instruction Tuning 中提出的模型的扩展。InstructBLIPVideo 使用与 InstructBLIP 相同的架构,并与 InstructBLIP 使用相同的检查点。唯一的区别是处理视频的能力。
论文摘要如下:
在预训练和指令微调流程的推动下,能够解决各种语言领域任务的通用语言模型应运而生。然而,由于额外的视觉输入引入了更大的任务差异,构建通用视觉语言模型仍然具有挑战性。尽管视觉语言预训练已得到广泛研究,但视觉语言指令微调的研究相对较少。在本文中,我们基于预训练的 BLIP-2 模型,对视觉语言指令微调进行了系统而全面的研究。我们收集了 26 个公开可用的数据集,将它们转换为指令微调格式,并将它们分为两个集群,用于内置指令微调和外置零样本评估。此外,我们引入了指令感知视觉特征提取,这是一种关键方法,使模型能够提取针对给定指令定制的信息丰富的特征。由此产生的 InstructBLIP 模型在所有 13 个外置数据集上均实现了最先进的零样本性能,大大优于 BLIP-2 和更大的 Flamingo。当在各个下游任务上进行微调时(例如,在 ScienceQA IMG 上达到 90.7% 的准确率),我们的模型也取得了最先进的性能。此外,我们定性地展示了 InstructBLIP 相对于并发多模态模型的优势。

此模型由 RaushanTurganbay 贡献。原始代码可以在这里找到。
使用技巧
- 该模型通过对每个视频采样 4 帧进行训练,因此建议采样 4 帧
[!NOTE] v4.46 版本之后的 BLIP 模型会引发关于添加
processor.num_query_tokens = {{num_query_tokens}}
和扩展模型嵌入层以添加特殊的<image>
令牌的警告。强烈建议如果您拥有模型检查点,则将属性添加到处理器,或者如果检查点不是您拥有的,则打开 PR。添加这些属性意味着 BLIP 将添加每个图像所需的查询令牌数,并使用与查询令牌一样多的<image>
占位符扩展文本。通常每个图像大约需要 500 个令牌,因此请确保文本未被截断,否则在合并嵌入时会发生故障。属性可以从模型配置中获取,如model.config.num_query_tokens
,模型嵌入扩展可以按照此链接进行操作。
InstructBlipVideoConfig
class transformers.InstructBlipVideoConfig
< 源代码 >( vision_config = None qformer_config = None text_config = None num_query_tokens = 32 video_token_index = None **kwargs )
参数
- vision_config (
dict
, 可选) — 用于初始化 InstructBlipVideoVisionConfig 的配置选项字典。 - qformer_config (
dict
, 可选) — 用于初始化 InstructBlipVideoQFormerConfig 的配置选项字典。 - text_config (
dict
, 可选) — 用于初始化任何 PretrainedConfig 的配置选项字典。 - num_query_tokens (
int
, 可选, 默认为 32) — 通过 Transformer 传递的查询令牌数量。 - video_token_index (
int
, 可选) — 特殊视频令牌的令牌索引。 - kwargs (可选) — 关键字参数的字典。
InstructBlipVideoConfig 是用于存储 InstructBlipVideoForConditionalGeneration 配置的配置类。它用于根据指定的参数实例化 Instructblipvideo 模型,定义视觉模型、Q-Former 模型和语言模型配置。使用默认值实例化配置将产生与 Instructblipvideo Salesforce/instruct-blip-flan-t5 架构类似的配置。
配置对象继承自 PretrainedConfig,可用于控制模型输出。有关更多信息,请阅读 PretrainedConfig 的文档。
示例
>>> from transformers import (
... InstructBlipVideoVisionConfig,
... InstructBlipVideoQFormerConfig,
... OPTConfig,
... InstructBlipVideoConfig,
... InstructBlipVideoForConditionalGeneration,
... )
>>> # Initializing a InstructBlipVideoConfig with Salesforce/instruct-blip-flan-t5 style configuration
>>> configuration = InstructBlipVideoConfig()
>>> # Initializing a InstructBlipVideoForConditionalGeneration (with random weights) from the Salesforce/instruct-blip-flan-t5 style configuration
>>> model = InstructBlipVideoForConditionalGeneration(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config
>>> # We can also initialize a InstructBlipVideoConfig from a InstructBlipVideoVisionConfig, InstructBlipVideoQFormerConfig and any PretrainedConfig
>>> # Initializing Instructblipvideo vision, Instructblipvideo Q-Former and language model configurations
>>> vision_config = InstructBlipVideoVisionConfig()
>>> qformer_config = InstructBlipVideoQFormerConfig()
>>> text_config = OPTConfig()
>>> config = InstructBlipVideoConfig.from_text_vision_configs(vision_config, qformer_config, text_config)
from_vision_qformer_text_configs
< source >( vision_config: InstructBlipVideoVisionConfig qformer_config: InstructBlipVideoQFormerConfig text_config: PretrainedConfig **kwargs ) → InstructBlipVideoConfig
从 InstructBlipVideo 视觉模型、Q-Former 模型和语言模型配置实例化 InstructBlipVideoConfig(或派生类)。
InstructBlipVideoVisionConfig
class transformers.InstructBlipVideoVisionConfig
< source >( hidden_size = 1408 intermediate_size = 6144 num_hidden_layers = 39 num_attention_heads = 16 image_size = 224 patch_size = 14 hidden_act = 'gelu' layer_norm_eps = 1e-06 attention_dropout = 0.0 initializer_range = 1e-10 qkv_bias = True **kwargs )
参数
- hidden_size (
int
, 可选,默认为 1408) — 编码器层和池化器层的维度。 - intermediate_size (
int
, 可选,默认为 6144) — Transformer 编码器中“中间”层(即,前馈层)的维度。 - num_hidden_layers (
int
, 可选,默认为 39) — Transformer 编码器中隐藏层的数量。 - num_attention_heads (
int
, 可选,默认为 16) — Transformer 编码器中每个注意力层的注意力头数。 - image_size (
int
, 可选,默认为 224) — 每张图片的大小(分辨率)。 - patch_size (
int
, 可选,默认为 14) — 每个图像块的大小(分辨率)。 - hidden_act (
str
或function
, 可选,默认为"gelu"
) — 编码器和池化器中的非线性激活函数(函数或字符串)。如果为字符串,则支持"gelu"
,"relu"
,"selu"
和"gelu_new"
"gelu"
。至 1e-5): 层归一化层使用的 epsilon。 - layer_norm_eps (
float
, 可选,默认为 1e-06) — 层归一化层使用的 epsilon。 - attention_dropout (
float
, 可选,默认为 0.0) — 注意力概率的 dropout 比率。 - initializer_range (
float
, 可选,默认为 1e-10) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - qkv_bias (
bool
, 可选,默认为True
) — 是否在自注意力层中向 queries 和 values 添加偏置。
这是用于存储 InstructBlipVideoVisionModel 配置的配置类。它用于根据指定的参数实例化 InstructBlipVideo 视觉编码器,定义模型架构。实例化默认配置将产生与 InstructBlipVideo Salesforce/instruct-blip-flan-t5 架构类似的配置。
配置对象继承自 PretrainedConfig,可用于控制模型输出。有关更多信息,请阅读 PretrainedConfig 的文档。
示例
>>> from transformers import InstructBlipVideoVisionConfig, InstructBlipVideoVisionModel
>>> # Initializing a InstructBlipVideoVisionConfig with Salesforce/instruct-blip-flan-t5 style configuration
>>> configuration = InstructBlipVideoVisionConfig()
>>> # Initializing a InstructBlipVideoVisionModel (with random weights) from the Salesforce/instruct-blip-flan-t5 style configuration
>>> model = InstructBlipVideoVisionModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config
InstructBlipVideoQFormerConfig
class transformers.InstructBlipVideoQFormerConfig
< source >( vocab_size = 30522 hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 intermediate_size = 3072 hidden_act = 'gelu' hidden_dropout_prob = 0.1 attention_probs_dropout_prob = 0.1 max_position_embeddings = 512 initializer_range = 0.02 layer_norm_eps = 1e-12 pad_token_id = 0 position_embedding_type = 'absolute' cross_attention_frequency = 2 encoder_hidden_size = 1408 **kwargs )
参数
- vocab_size (
int
, 可选,默认为 30522) — Q-Former 模型的词汇表大小。定义了调用模型时传递的inputs_ids
可以表示的不同 tokens 的数量。 - hidden_size (
int
, 可选,默认为 768) — 编码器层和池化器层的维度。 - num_hidden_layers (
int
, 可选,默认为 12) — Transformer 编码器中隐藏层的数量。 - num_attention_heads (
int
, 可选,默认为 12) — Transformer 编码器中每个注意力层的注意力头数。 - intermediate_size (
int
, 可选,默认为 3072) — Transformer 编码器中“中间”层(通常称为前馈层)的维度。 - hidden_act (
str
或Callable
, 可选, 默认为"gelu"
) — 编码器和池化器中的非线性激活函数(函数或字符串)。如果为字符串,则支持"gelu"
、"relu"
、"silu"
和"gelu_new"
。 - hidden_dropout_prob (
float
, 可选, 默认为 0.1) — 嵌入层、编码器和池化器中所有全连接层的 dropout 概率。 - attention_probs_dropout_prob (
float
, 可选, 默认为 0.1) — 注意力概率的 dropout 比率。 - max_position_embeddings (
int
, 可选, 默认为 512) — 此模型可能使用的最大序列长度。通常设置为较大的值以防万一(例如,512 或 1024 或 2048)。 - initializer_range (
float
, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float
, 可选, 默认为 1e-12) — 层归一化层使用的 epsilon 值。 - pad_token_id (
int
, 可选, 默认为 0) — 用于 padding 序列的 Token id。 - position_embedding_type (
str
, 可选, 默认为"absolute"
) — 位置嵌入的类型。选择"absolute"
,"relative_key"
,"relative_key_query"
中的一个。对于位置嵌入,使用"absolute"
。有关"relative_key"
的更多信息,请参阅 Self-Attention with Relative Position Representations (Shaw et al.)。有关"relative_key_query"
的更多信息,请参阅 Improve Transformer Models with Better Relative Position Embeddings (Huang et al.) 中的 *方法 4*。 - cross_attention_frequency (
int
, 可选, 默认为 2) — 向 Transformer 层添加交叉注意力的频率。 - encoder_hidden_size (
int
, 可选, 默认为 1408) — 用于交叉注意力的隐藏状态的隐藏大小。
这是用于存储 InstructBlipVideoQFormerModel 配置的配置类。它用于根据指定的参数实例化 InstructBlipVideo 查询 Transformer (Q-Former) 模型,定义模型架构。使用默认值实例化配置将产生与 InstructBlipVideo Salesforce/instruct-blip-flan-t5 架构类似的配置。配置对象继承自 PretrainedConfig,可用于控制模型输出。有关更多信息,请阅读 PretrainedConfig 中的文档。
请注意,InstructBlipVideoQFormerModel 与 BertLMHeadModel 非常相似,只是增加了交错的交叉注意力。
示例
>>> from transformers import InstructBlipVideoQFormerConfig, InstructBlipVideoQFormerModel
>>> # Initializing a InstructBlipVideo Salesforce/instruct-blip-flan-t5 style configuration
>>> configuration = InstructBlipVideoQFormerConfig()
>>> # Initializing a model (with random weights) from the Salesforce/instruct-blip-flan-t5 style configuration
>>> model = InstructBlipVideoQFormerModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config
InstructBlipVideoProcessor
class transformers.InstructBlipVideoProcessor
< source >( image_processor tokenizer qformer_tokenizer num_query_tokens = None **kwargs )
参数
- image_processor (
InstructBlipVideoImageProcessor
) — InstructBlipVideoImageProcessor 的实例。图像处理器是必需的输入。 - tokenizer (
AutoTokenizer
) — [‘PreTrainedTokenizer’] 的实例。tokenizer 是必需的输入。 - qformer_tokenizer (
AutoTokenizer
) — [‘PreTrainedTokenizer’] 的实例。Q-Former tokenizer 是必需的输入。 - num_query_tokens (
int
, 可选) — Qformer 用作查询的 token 数量,应与模型配置中的数量相同。
构建一个 InstructBLIPVideo 处理器,它将 InstructBLIP 图像处理器和一个 LLaMa/T5 tokenizer 包装到单个处理器中。
InstructBlipVideoProcessor 提供了 InstructBlipVideoImageProcessor 和 AutoTokenizer 的所有功能。有关更多信息,请参阅 __call__()
和 decode() 的 docstring。
此方法将其所有参数转发到 PreTrainedTokenizer 的 batch_decode()。有关更多信息,请参阅此方法的 docstring。
此方法将其所有参数转发到 PreTrainedTokenizer 的 decode()。有关更多信息,请参阅此方法的 docstring。
InstructBlipVideoImageProcessor
class transformers.InstructBlipVideoImageProcessor
< source >( do_resize: bool = True size: typing.Dict[str, int] = None resample: Resampling = <Resampling.BICUBIC: 3> do_rescale: bool = True rescale_factor: typing.Union[int, float] = 0.00392156862745098 do_normalize: bool = True image_mean: typing.Union[float, typing.List[float], NoneType] = None image_std: typing.Union[float, typing.List[float], NoneType] = None do_convert_rgb: bool = True **kwargs )
参数
- do_resize (
bool
, 可选, 默认为True
) — 是否将图像的(高度,宽度)尺寸调整为指定的size
。可以被preprocess
方法中的do_resize
参数覆盖。 - size (
dict
, 可选, 默认为{"height" -- 384, "width": 384}
): 调整大小后输出图像的大小。可以被preprocess
方法中的size
参数覆盖。 - resample (
PILImageResampling
, 可选, 默认为Resampling.BICUBIC
) — 如果调整图像大小,则使用的重采样滤波器。仅当do_resize
设置为True
时才有效。可以被preprocess
方法中的resample
参数覆盖。 - do_rescale (
bool
, 可选, 默认为True
) — 是否按指定的比例因子rescale_factor
重新缩放图像。可以被preprocess
方法中的do_rescale
参数覆盖。 - rescale_factor (
int
或float
, 可选, 默认为1/255
) — 如果要重新缩放图像,则使用的缩放因子。仅当do_rescale
设置为True
时才有效。可以被preprocess
方法中的rescale_factor
参数覆盖。 - do_normalize (
bool
, 可选, 默认为True
) — 是否对图像进行归一化。可以被preprocess
方法中的do_normalize
参数覆盖。可以被preprocess
方法中的do_normalize
参数覆盖。 - image_mean (
float
或List[float]
, 可选, 默认为IMAGENET_STANDARD_MEAN
) — 如果要对图像进行归一化,则使用的均值。这是一个浮点数或浮点数列表,其长度是图像中通道的数量。可以被preprocess
方法中的image_mean
参数覆盖。可以被preprocess
方法中的image_mean
参数覆盖。 - image_std (
float
或List[float]
, 可选, 默认为IMAGENET_STANDARD_STD
) — 如果要对图像进行归一化,则使用的标准差。这是一个浮点数或浮点数列表,其长度是图像中通道的数量。可以被preprocess
方法中的image_std
参数覆盖。可以被preprocess
方法中的image_std
参数覆盖。 - do_convert_rgb (
bool
, 可选, 默认为True
) — 是否将图像转换为 RGB 格式。
构建 InstructBLIPVideo 图像处理器。
preprocess
< source >( images: typing.Union[list['PIL.Image.Image'], ForwardRef('np.ndarray'), ForwardRef('torch.Tensor'), list['np.ndarray'], list['torch.Tensor'], list[list['PIL.Image.Image']], list[list['np.ndarrray']], list[list['torch.Tensor']]] = None do_resize: typing.Optional[bool] = None size: typing.Optional[typing.Dict[str, int]] = None resample: Resampling = None do_rescale: typing.Optional[bool] = None rescale_factor: typing.Optional[float] = None do_normalize: typing.Optional[bool] = None image_mean: typing.Union[float, typing.List[float], NoneType] = None image_std: typing.Union[float, typing.List[float], NoneType] = None return_tensors: typing.Union[str, transformers.utils.generic.TensorType, NoneType] = None do_convert_rgb: bool = None data_format: ChannelDimension = <ChannelDimension.FIRST: 'channels_first'> input_data_format: typing.Union[str, transformers.image_utils.ChannelDimension, NoneType] = None )
参数
- videos (
VideoInput
) — 要预处理的视频帧。期望单个或批量的视频作为像素值范围从 0 到 255 的帧列表传入。如果传入的视频像素值在 0 到 1 之间,请设置do_rescale=False
。 - do_resize (
bool
, 可选, 默认为self.do_resize
) — 是否调整视频大小。 - size (
Dict[str, int]
, 可选, 默认为self.size
) — 控制resize
后视频的大小。图像的最短边将被调整为size["shortest_edge"]
,同时保持宽高比。如果此调整大小后的图像的最长边 >int(size["shortest_edge"] * (1333 / 800))
,则再次调整图像大小,使最长边等于int(size["shortest_edge"] * (1333 / 800))
。 - resample (
PILImageResampling
, 可选, 默认为self.resample
) — 如果调整视频大小,则使用的重采样过滤器。仅当do_resize
设置为True
时才有效。 - do_rescale (
bool
, 可选, 默认为self.do_rescale
) — 是否将视频值重新缩放到 [0 - 1] 之间。 - rescale_factor (
float
, 可选, 默认为self.rescale_factor
) — 如果do_rescale
设置为True
,则用于重新缩放视频的缩放因子。 - do_normalize (
bool
, 可选, 默认为self.do_normalize
) — 是否对视频进行归一化处理。 - image_mean (
float
或List[float]
, 可选, 默认为self.image_mean
) — 如果do_normalize
设置为True
,则用于归一化视频的图像均值。 - image_std (
float
或List[float]
, 可选, 默认为self.image_std
) — 如果do_normalize
设置为True
,则用于归一化视频的图像标准差。 - do_convert_rgb (
bool
, 可选, 默认为self.do_convert_rgb
) — 是否将图像转换为 RGB 格式。 - return_tensors (
str
或TensorType
, 可选) — 要返回的张量类型。可以是以下之一:- Unset: 返回
np.ndarray
列表。 TensorType.TENSORFLOW
或'tf'
: 返回tf.Tensor
类型的批次。TensorType.PYTORCH
或'pt'
: 返回torch.Tensor
类型的批次。TensorType.NUMPY
或'np'
: 返回np.ndarray
类型的批次。TensorType.JAX
或'jax'
: 返回jax.numpy.ndarray
类型的批次。
- Unset: 返回
- data_format (
ChannelDimension
或str
, 可选, 默认为ChannelDimension.FIRST
) — 输出图像的通道维度格式。可以是以下之一:"channels_first"
或ChannelDimension.FIRST
: 格式为 (num_channels, height, width) 的图像。"channels_last"
或ChannelDimension.LAST
: 格式为 (height, width, num_channels) 的图像。- Unset: 使用输入图像的通道维度格式。
- input_data_format (
ChannelDimension
或str
, 可选) — 输入图像的通道维度格式。如果未设置,则通道维度格式从输入图像中推断。可以是以下之一:"channels_first"
或ChannelDimension.FIRST
: 格式为 (num_channels, height, width) 的图像。"channels_last"
或ChannelDimension.LAST
: 格式为 (height, width, num_channels) 的图像。"none"
或ChannelDimension.NONE
: 格式为 (height, width) 的图像。
预处理视频或图像/视频批次。
InstructBlipVideoVisionModel
class transformers.InstructBlipVideoVisionModel
< source >( config: InstructBlipVideoVisionConfig )
forward
< source >( pixel_values: typing.Optional[torch.FloatTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None interpolate_pos_encoding: bool = False ) → transformers.modeling_outputs.BaseModelOutputWithPooling or tuple(torch.FloatTensor)
参数
- pixel_values (
torch.FloatTensor
,形状为(batch_size, num_channels, height, width)
) — 像素值。像素值可以使用 InstructBlipVideoProcessor 获得。有关详细信息,请参阅InstructBlipVideoProcessor.__call__()
。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息,请参见返回张量下的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息,请参见返回张量下的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 而不是纯粹的元组。 - interpolate_pos_encoding (
bool
, 可选, 默认为False
) — 是否插值预训练的位置编码。
返回:
transformers.modeling_outputs.BaseModelOutputWithPooling 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPooling 或一个 torch.FloatTensor
的元组 (如果传递了 return_dict=False
或者当 config.return_dict=False
时),包含各种元素,具体取决于配置 (<class 'transformers.models.instructblipvideo.configuration_instructblipvideo.InstructBlipVideoVisionConfig'>
) 和输入。
-
last_hidden_state (形状为
(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
) — 模型最后一层的输出处的隐藏状态序列。 -
pooler_output (形状为
(batch_size, hidden_size)
的torch.FloatTensor
) — 序列的第一个 token (分类 token) 的最后一层隐藏状态,经过用于辅助预训练任务的层进一步处理后得到。例如,对于 BERT 系列模型,这返回经过线性层和 tanh 激活函数处理后的分类 token。线性层权重从预训练期间的下一句预测(分类)目标中训练而来。 -
hidden_states (
tuple(torch.FloatTensor)
, 可选, 当传递output_hidden_states=True
或当config.output_hidden_states=True
时返回) —torch.FloatTensor
的元组(如果模型有 embedding 层,则为 embedding 的输出加上每一层的输出),形状为(batch_size, sequence_length, hidden_size)
。模型在每一层输出处的隐藏状态,加上可选的初始 embedding 输出。
-
attentions (
tuple(torch.FloatTensor)
, 可选, 当传递output_attentions=True
或当config.output_attentions=True
时返回) —torch.FloatTensor
的元组(每一层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。注意力 softmax 之后的注意力权重,用于计算自注意力头中的加权平均值。
InstructBlipVideoVisionModel 的 forward 方法,覆盖了 __call__
特殊方法。
尽管 forward 传递的配方需要在该函数内定义,但应该在之后调用 Module
实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者会默默地忽略它们。
InstructBlipVideoQFormerModel
class transformers.InstructBlipVideoQFormerModel
< source >( config: InstructBlipVideoQFormerConfig )
InstructBlipVideo 中使用的查询 Transformer (Q-Former)。从 BLIP-2 略微修改而来,因为它也接受指令作为输入。
forward
< source >( input_ids: LongTensor attention_mask: typing.Optional[torch.FloatTensor] = None position_ids: typing.Optional[torch.LongTensor] = None query_embeds: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.FloatTensor] = None encoder_hidden_states: typing.Optional[torch.FloatTensor] = None encoder_attention_mask: typing.Optional[torch.FloatTensor] = None past_key_values: typing.Optional[typing.Tuple[typing.Tuple[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 )
encoder_hidden_states (形状为 (batch_size, sequence_length, hidden_size)
的 torch.FloatTensor
, 可选): 编码器最后一层的输出处的隐藏状态序列。如果模型配置为解码器,则在交叉注意力中使用。 encoder_attention_mask (形状为 (batch_size, sequence_length)
的 torch.FloatTensor
, 可选): 用于避免对编码器输入的 padding token 索引执行注意力的掩码。如果模型配置为解码器,则在交叉注意力中使用此掩码。掩码值在 [0, 1]
中选择
- 1 代表 未被掩盖 的 token,
- 0 代表 被掩盖 的 token。 past_key_values (长度为
config.n_layers
的tuple(tuple(torch.FloatTensor))
,其中每个元组有 4 个张量,形状为(batch_size, num_heads, sequence_length - 1, embed_size_per_head)
): 包含注意力块的预计算的 key 和 value 隐藏状态。可用于加速解码。如果使用past_key_values
,则用户可以选择仅输入最后decoder_input_ids
(那些没有将其过去的 key value 状态提供给此模型的),形状为(batch_size, 1)
,而不是所有形状为(batch_size, sequence_length)
的decoder_input_ids
。 use_cache (bool
, 可选): 如果设置为True
,则返回past_key_values
键值状态,并可用于加速解码(请参阅past_key_values
)。
InstructBlipVideoForConditionalGeneration
class transformers.InstructBlipVideoForConditionalGeneration
< source >( config: InstructBlipVideoConfig )
参数
- config (InstructBlipVideoConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重,仅加载配置。查看 from_pretrained() 方法来加载模型权重。
InstructBlipVideo 模型,用于生成给定图像和可选文本提示的文本。该模型由视觉编码器、查询 Transformer (Q-Former) 和语言模型组成。
可以选择性地将 input_ids
传递给模型,它充当文本提示,使语言模型继续提示。否则,语言模型将从 [BOS] (序列开始) token 开始生成文本。
此模型继承自 PreTrainedModel。查看超类文档,了解库为其所有模型实现的通用方法(例如下载或保存、调整输入 embeddings 大小、剪枝 head 等)。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch Module,并参考 PyTorch 文档,了解所有与通用用法和行为相关的事项。
forward
< source >( pixel_values: FloatTensor qformer_input_ids: FloatTensor qformer_attention_mask: typing.Optional[torch.LongTensor] = None input_ids: typing.Optional[torch.FloatTensor] = None attention_mask: typing.Optional[torch.LongTensor] = None decoder_input_ids: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None labels: typing.Optional[torch.LongTensor] = None return_dict: typing.Optional[bool] = None interpolate_pos_encoding: bool = False use_cache: typing.Optional[bool] = None ) → transformers.models.instructblipvideo.modeling_instructblipvideo.InstructBlipVideoForConditionalGenerationModelOutput
或 tuple(torch.FloatTensor)
参数
- pixel_values (形状为
(batch_size, num_channels, height, width)
的torch.FloatTensor
) — 像素值。像素值可以使用 InstructBlipVideoProcessor 获得。 有关详细信息,请参见InstructBlipVideoProcessor.__call__()
。 - qformer_input_ids (形状为
(batch_size, sequence_length)
的torch.LongTensor
, 可选) — Q-Former 词汇表中输入序列 token 的索引。可以选择性地提供输入 token 作为文本提示,Q-Former 模型将对其进行编码。索引可以使用 InstructBlipVideoProcessor 获得。 有关详细信息,请参见
InstructBlipVideoProcessor.__call__()
。 - qformer_attention_mask (形状为
(batch_size, sequence_length)
的torch.Tensor
, 可选) — 用于避免对 padding token 索引执行注意力的掩码。掩码值在[0, 1]
中选择:- 1 代表 未被掩盖 的 token,
- 0 代表 被掩盖 的 token。
- input_ids (形状为
(batch_size, sequence_length)
的torch.LongTensor
, 可选) — 语言模型词汇表中输入序列 token 的索引。可以选择性地提供输入 token 作为文本提示,语言模型可以继续提示。索引可以使用 InstructBlipVideoProcessor 获得。 有关详细信息,请参见
InstructBlipVideoProcessor.__call__()
。 - attention_mask (形状为
(batch_size, sequence_length)
的torch.Tensor
, 可选) — 用于避免对 padding token 索引执行注意力的掩码。掩码值在[0, 1]
中选择:- 1 代表 未被掩盖 的 token,
- 0 代表 被掩盖 的 token。
- decoder_input_ids (形状为
(batch_size, target_sequence_length)
的torch.LongTensor
, 可选) — 解码器输入序列 token 在语言模型词汇表中的索引。仅在使用编码器-解码器语言模型(如 T5)时相关。索引可以使用 AutoTokenizer 获得。 有关详细信息,请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。 什么是解码器输入 IDs?
- decoder_attention_mask (形状为
(batch_size, target_sequence_length)
的torch.BoolTensor
, 可选) — 默认行为:生成一个 tensor,该 tensor 忽略decoder_input_ids
中的 pad token。默认情况下,也将使用因果掩码。仅在使用编码器-解码器语言模型(如 T5)时相关。
- output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息,请参见返回张量下的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息,请参见返回张量下的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 而不是纯粹的元组。 - interpolate_pos_encoding (
bool
, optional, defaults toFalse
) — 是否对预训练的位置编码进行插值。 - use_cache (
bool
, optional) — 如果设置为True
,则返回past_key_values
键值状态,并可用于加速解码(请参阅past_key_values
)。 - labels (
torch.LongTensor
of shape(batch_size,)
, optional) — 用于计算语言建模损失的标签。索引应在[-100, 0, ..., config.vocab_size - 1]
中。所有设置为-100
的标签都将被忽略(掩码),损失仅针对[0, ..., config.vocab_size]
中的标签计算。
返回:
transformers.models.instructblipvideo.modeling_instructblipvideo.InstructBlipVideoForConditionalGenerationModelOutput
或 tuple(torch.FloatTensor)
一个 transformers.models.instructblipvideo.modeling_instructblipvideo.InstructBlipVideoForConditionalGenerationModelOutput
或 torch.FloatTensor
的元组(如果传递了 return_dict=False
或者当 config.return_dict=False
时),其中包含各种元素,具体取决于配置 (<class 'transformers.models.instructblipvideo.configuration_instructblipvideo.InstructBlipVideoVisionConfig'>
) 和输入。
- loss (
torch.FloatTensor
, optional, 当提供labels
时返回, 形状为(1,)
的torch.FloatTensor
) — 来自语言模型的语言建模损失。 - logits (形状为
(batch_size, sequence_length, config.vocab_size)
的torch.FloatTensor
) — 语言模型的语言建模头的预测分数。 - vision_outputs (
BaseModelOutputWithPooling
) — 视觉编码器的输出。 - qformer_outputs (
BaseModelOutputWithPoolingAndCrossAttentions
) — Q-Former(查询 Transformer)的输出。 - language_model_outputs (
CausalLMOutputWithPast
或Seq2SeqLMOutput
) — 语言模型的输出。
InstructBlipVideoForConditionalGeneration 的 forward 方法,覆盖了 __call__
特殊方法。
尽管 forward 传递的配方需要在该函数内定义,但应该在之后调用 Module
实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者会默默地忽略它们。
示例
>>> from transformers import InstructBlipVideoProcessor, InstructBlipVideoForConditionalGeneration
>>> import torch
>>> from huggingface_hub import hf_hub_download
>>> import av
>>> import numpy as np
>>> def read_video_pyav(container, indices):
... '''
... Decode the video with PyAV decoder.
... Args:
... container (`av.container.input.InputContainer`): PyAV container.
... indices (`List[int]`): List of frame indices to decode.
... Returns:
... result (np.ndarray): np array of decoded frames of shape (num_frames, height, width, 3).
... '''
... frames = []
... container.seek(0)
... start_index = indices[0]
... end_index = indices[-1]
... for i, frame in enumerate(container.decode(video=0)):
... if i > end_index:
... break
... if i >= start_index and i in indices:
... frames.append(frame)
... return np.stack([x.to_ndarray(format="rgb24") for x in frames])
>>> model = InstructBlipVideoForConditionalGeneration.from_pretrained("Salesforce/instructblip-vicuna-7b", device_map="auto")
>>> processor = InstructBlipVideoProcessor.from_pretrained("Salesforce/instructblip-vicuna-7b")
>>> file_path = hf_hub_download(
... repo_id="nielsr/video-demo", filename="eating_spaghetti.mp4", repo_type="dataset"
... )
>>> container = av.open(file_path)
>>> # sample uniformly 4 frames from the videWhy is this video funny?o
>>> total_frames = container.streams.video[0].frames
>>> indices = np.arange(0, total_frames, total_frames / 4).astype(int)
>>> clip = read_video_pyav(container, indices)
>>> prompt = "What is happening in the video?"
>>> inputs = processor(text=prompt, images=clip, return_tensors="pt").to(model.device)
>>> outputs = model.generate(
... **inputs,
... do_sample=False,
... num_beams=5,
... max_length=256,
... repetition_penalty=1.5,
... length_penalty=1.0,
... )
>>> generated_text = processor.batch_decode(outputs, skip_special_tokens=True)[0].strip()
>>> print(generated_text)
"A person is eating a bowl of pasta, and they are using a fork to eat it. The person is sitting at a table, and the plate of pasta is on the table in front"
generate
< source >( pixel_values: FloatTensor qformer_input_ids: typing.Optional[torch.LongTensor] = None qformer_attention_mask: typing.Optional[torch.LongTensor] = None input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.LongTensor] = None interpolate_pos_encoding: bool = False **generate_kwargs ) → captions (list)
参数
- pixel_values (
torch.FloatTensor
of shape (batch_size, num_channels, height, width) or — (batch_size, num_frames, num_channels, height, width)): 要处理的输入图像或视频。 - qformer_input_ids (
torch.LongTensor
of shape (batch_size, sequence_length), optional) — 用作提示并馈送到 Q-Former 模块的序列。 - qformer_attention_mask (
torch.LongTensor
of shape (batch_size, sequence_length), optional) — 掩码,用于避免对填充标记索引执行注意力机制。 - input_ids (
torch.LongTensor
of shape (batch_size, sequence_length), optional) — 用作生成提示的序列。 - attention_mask (
torch.LongTensor
of shape (batch_size, sequence_length), optional) — 掩码,用于避免对填充标记索引执行注意力机制。 - interpolate_pos_encoding (
bool
, optional, defaults toFalse
) — 是否对图像嵌入的位置编码进行插值。
返回:
captions (list)
长度为 batch_size * num_captions 的字符串列表。
覆盖 generate
函数,以便能够将模型用作条件生成器。