Transformers 文档
TVLT
并获得增强的文档体验
开始使用
TVLT
此模型仅处于维护模式,我们不接受任何更改其代码的新 PR。如果您在运行此模型时遇到任何问题,请重新安装支持此模型的最后一个版本:v4.40.2。您可以通过运行以下命令进行操作:pip install -U transformers==4.40.2
。
概述
TVLT 模型由 Zineng Tang、Jaemin Cho、Yixin Nie 和 Mohit Bansal(前三位作者贡献相同)在TVLT: Textless Vision-Language Transformer 中提出。Textless Vision-Language Transformer (TVLT) 是一种模型,它使用原始视觉和音频输入进行视觉和语言表示学习,不使用文本专用模块,如分词或自动语音识别(ASR)。它可以执行各种视听和视觉语言任务,如检索、问答等。
论文摘要如下:
在这项工作中,我们提出了 Textless Vision-Language Transformer (TVLT),其中同构 Transformer 块接受原始视觉和音频输入,用于视觉和语言表示学习,且模态特定设计最小化,不使用文本专用模块,如分词或自动语音识别 (ASR)。TVLT 通过重建连续视频帧和音频频谱图的遮蔽补丁(遮蔽自编码)以及对比建模以对齐视频和音频来训练。TVLT 在各种多模态任务上达到了与其基于文本的对应物相当的性能,例如视觉问答、图像检索、视频检索和多模态情感分析,推理速度快 28 倍,参数量仅为 1/3。我们的发现表明,在不假设文本预先存在的情况下,可以从低级视觉和音频信号中学习紧凑高效的视觉-语言表示。
原始代码可以在这里找到。此模型由Zineng Tang贡献。
使用提示
- TVLT 是一种同时接受
pixel_values
和audio_values
作为输入的模型。可以使用 TvltProcessor 为模型准备数据。该处理器将图像处理器(用于图像/视频模态)和音频特征提取器(用于音频模态)封装为一个。 - TVLT 使用不同大小的图像/视频和音频进行训练:作者将输入图像/视频调整并裁剪为 224,并将音频频谱图的长度限制为 2048。为了使视频和音频的批处理成为可能,作者使用
pixel_mask
指示哪些像素是真实的/填充的,以及audio_mask
指示哪些音频值是真实的/填充的。 - TVLT 的设计与标准的 Vision Transformer (ViT) 和遮蔽自编码器 (MAE) 非常相似,如 ViTMAE 中所示。区别在于该模型包含了音频模态的嵌入层。
- 此模型的 PyTorch 版本仅在 torch 1.10 及更高版本中可用。
TvltConfig
class transformers.TvltConfig
< 来源 >( image_size = 224 spectrogram_length = 2048 frequency_length = 128 image_patch_size = [16, 16] audio_patch_size = [16, 16] num_image_channels = 3 num_audio_channels = 1 num_frames = 8 hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 intermediate_size = 3072 hidden_act = 'gelu' hidden_dropout_prob = 0.0 attention_probs_dropout_prob = 0.0 initializer_range = 0.02 layer_norm_eps = 1e-06 qkv_bias = True use_mean_pooling = False decoder_num_attention_heads = 16 decoder_hidden_size = 512 decoder_num_hidden_layers = 8 decoder_intermediate_size = 2048 pixel_mask_ratio = 0.75 audio_mask_ratio = 0.15 audio_mask_type = 'frame-level' task_matching = True task_mae = True loss_type = 'classification' **kwargs )
参数
- image_size (
int
, 可选, 默认为 224) — 每张图像的大小(分辨率)。 - spectrogram_length (
int
, 可选, 默认为 2048) — 每个音频频谱图的时间长度。 - frequency_length (
int
, 可选, 默认为 128) — 音频频谱图的频率长度。 - image_patch_size (
list[int]
, 可选, 默认为[16, 16]
) — 每个图像补丁的大小(分辨率)。 - audio_patch_size (
list[int]
, 可选, 默认为[16, 16]
) — 每个音频补丁的大小(分辨率)。 - num_image_channels (
int
, 可选, 默认为 3) — 输入图像通道的数量。 - num_audio_channels (
int
, 可选, 默认为 1) — 输入音频通道的数量。 - num_frames (
int
, 可选, 默认为 8) — 输入视频的最大帧数。 - hidden_size (
int
, 可选, 默认为 768) — 编码器层和池化器层的维度。 - num_hidden_layers (
int
, 可选, 默认为 12) — Transformer 编码器中的隐藏层数量。 - num_attention_heads (
int
, 可选, 默认为 12) — Transformer 编码器中每个注意力层头的数量。 - intermediate_size (
int
, 可选, 默认为 3072) — Transformer 编码器中“中间”(即,前馈)层的维度。 - hidden_act (
str
或function
, 可选, 默认为"gelu"
) — 编码器和池化器中的非线性激活函数(函数或字符串)。如果为字符串,则支持"gelu"
、"relu"
、"selu"
和"gelu_new"
。 - hidden_dropout_prob (
float
, 可选, 默认为 0.0) — 嵌入层、编码器和池化器中所有全连接层的 dropout 概率。 - attention_probs_dropout_prob (
float
, 可选, 默认为 0.0) — 注意力概率的 dropout 比率。 - initializer_range (
float
, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的截断正态分布初始化器的标准差。 - layer_norm_eps (
float
, 可选, 默认为 1e-06) — 层归一化层使用的 epsilon 值。 - qkv_bias (
bool
, 可选, 默认为True
) — 是否在查询、键和值中添加偏置。 - use_mean_pooling (
bool
, 可选, 默认为False
) — 是否对最终隐藏状态进行均值池化,而不是使用 [CLS] 标记的最终隐藏状态。 - decoder_num_attention_heads (
int
, 可选, 默认为 16) — 解码器中每个注意力层的注意力头数量。 - decoder_hidden_size (
int
, 可选, 默认为 512) — 解码器的维度。 - decoder_num_hidden_layers (
int
, 可选, 默认为 8) — 解码器中的隐藏层数量。 - decoder_intermediate_size (
int
, 可选, 默认为 2048) — 解码器中“中间”(即,前馈)层的维度。 - pixel_mask_ratio (
float
, 可选, 默认为 0.75) — 图像补丁遮蔽比。 - audio_mask_ratio (
float
, 可选, 默认为 0.15) — 音频补丁遮蔽比。 - audio_mask_type (
str
, 可选, 默认为"frame-level"
) — 音频补丁遮蔽类型,选择“frame-level”和“patch-level”之间。 - task_matching (
bool
, 可选, 默认为True
) — 是否在预训练中使用视觉音频匹配任务。 - task_mae (
bool
, 可选, 默认为True
) — 是否在预训练中使用遮蔽自编码器 (MAE)。 - loss_type (
str
, 可选, 默认为"classification"
) — 损失类型包括回归和分类。
这是用于存储 TvltModel 配置的配置类。它用于根据指定的参数实例化 TVLT 模型,定义模型架构。使用默认值实例化配置将产生与 TVLT ZinengTang/tvlt-base 架构类似的配置。
配置对象继承自 PretrainedConfig,可用于控制模型输出。有关更多信息,请参阅 PretrainedConfig 的文档。
示例
>>> from transformers import TvltConfig, TvltModel
>>> # # Initializing a TVLT ZinengTang/tvlt-base style configuration
>>> configuration = TvltConfig()
>>> # # Initializing a model (with random weights) from the ZinengTang/tvlt-base style configuration
>>> model = TvltModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config
TvltProcessor
class transformers.TvltProcessor
< 来源 >( image_processor feature_extractor )
参数
- image_processor (
TvltImageProcessor
) — TvltImageProcessor 的实例。图像处理器是必需的输入。 - feature_extractor (
TvltFeatureExtractor
) — TvltFeatureExtractor 的实例。特征提取器是必需的输入。
构建一个 TVLT 处理器,它将 TVLT 图像处理器和 TVLT 特征提取器封装到一个处理器中。
TvltProcessor 提供了 TvltImageProcessor 和 TvltFeatureExtractor 的所有功能。有关更多信息,请参阅上述两个方法的文档字符串 call()。
__call__
< 来源 >( images = None audio = None images_mixed = None sampling_rate = None mask_audio = False mask_pixel = False *args **kwargs )
将 images
参数转发给 TvltImageProcessor 的 preprocess(),并将 audio
参数转发给 TvltFeatureExtractor 的 call()。请参阅上述两种方法的文档字符串以获取更多信息。
TvltImageProcessor
class transformers.TvltImageProcessor
< 来源 >( do_resize: bool = True size: typing.Optional[dict[str, int]] = None patch_size: list = [16, 16] num_frames: int = 8 resample: Resampling = <Resampling.BILINEAR: 2> do_center_crop: bool = True crop_size: typing.Optional[dict[str, int]] = None do_rescale: bool = True rescale_factor: typing.Union[int, float] = 0.00392156862745098 do_normalize: bool = True image_mean: typing.Union[float, list[float], NoneType] = [0.5, 0.5, 0.5] image_std: typing.Union[float, list[float], NoneType] = [0.5, 0.5, 0.5] init_mask_generator = False **kwargs )
参数
- do_resize (
bool
, 可选, 默认为True
) — 是否将图像的 (高度, 宽度) 尺寸调整为指定的size
。可以通过preprocess
方法中的do_resize
参数覆盖。 - size (
dict[str, int]
可选, 默认为{"shortest_edge" -- 224}
): 调整大小后输出图像的尺寸。图像的最短边将调整为size["shortest_edge"]
,同时保持原始图像的纵横比。可以通过preprocess
方法中的size
覆盖。 - patch_size (
list[int]
可选, 默认为 [16,16]) — 图像块嵌入的块大小。 - num_frames (
int
可选, 默认为 8) — 视频帧的最大数量。 - resample (
PILImageResampling
, 可选, 默认为PILImageResampling.BILINEAR
) — 如果调整图像大小,则使用的重采样滤波器。可以通过preprocess
方法中的resample
参数覆盖。 - do_center_crop (
bool
, 可选, 默认为True
) — 是否将图像中心裁剪到指定的crop_size
。可以通过preprocess
方法中的do_center_crop
参数覆盖。 - crop_size (
dict[str, int]
, 可选, 默认为{"height" -- 224, "width": 224}
): 应用中心裁剪后图像的尺寸。可以通过preprocess
方法中的crop_size
参数覆盖。 - do_rescale (
bool
, 可选, 默认为True
) — 是否按指定的缩放因子rescale_factor
重新缩放图像。可以通过preprocess
方法中的do_rescale
参数覆盖。 - rescale_factor (
int
或float
, 可选, 默认为 1/255) — 定义如果重新缩放图像,则使用的缩放因子。可以通过preprocess
方法中的rescale_factor
参数覆盖。 - do_normalize (
bool
, 可选, 默认为True
) — 是否对图像进行归一化。可以通过preprocess
方法中的do_normalize
参数覆盖。 - image_mean (
float
或list[float]
, 可选, 默认为IMAGENET_STANDARD_MEAN
) — 如果对图像进行归一化,则使用的平均值。这是一个浮点数或浮点数列表,其长度与图像中的通道数相同。可以通过preprocess
方法中的image_mean
参数覆盖。 - image_std (
float
或list[float]
, 可选, 默认为IMAGENET_STANDARD_STD
) — 如果对图像进行归一化,则使用的标准差。这是一个浮点数或浮点数列表,其长度与图像中的通道数相同。可以通过preprocess
方法中的image_std
参数覆盖。
构造一个 TVLT 图像处理器。
该处理器可用于通过将图像转换为 1 帧视频来为模型准备视频或图像。
预处理
< 来源 >( videos: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']] do_resize: typing.Optional[bool] = None size: typing.Optional[dict[str, int]] = None patch_size: typing.Optional[list[int]] = None num_frames: typing.Optional[int] = None resample: Resampling = None do_center_crop: typing.Optional[bool] = None crop_size: typing.Optional[dict[str, int]] = None do_rescale: typing.Optional[bool] = None rescale_factor: typing.Optional[float] = None do_normalize: typing.Optional[bool] = None image_mean: typing.Union[float, list[float], NoneType] = None image_std: typing.Union[float, list[float], NoneType] = None is_mixed: bool = False return_tensors: typing.Union[str, transformers.utils.generic.TensorType, NoneType] = None data_format: ChannelDimension = <ChannelDimension.FIRST: 'channels_first'> input_data_format: typing.Union[str, transformers.image_utils.ChannelDimension, NoneType] = None **kwargs ) → BatchFeature
参数
- videos (
ImageInput
) — 要预处理的图像或视频。期望是像素值范围为 0 到 255 的单帧或批次帧。如果传入的帧像素值在 0 到 1 之间,请设置do_rescale=False
。 - do_resize (
bool
, 可选, 默认为self.do_resize
) — 是否调整图像大小。 - size (
dict[str, int]
, 可选, 默认为self.size
) — 应用调整大小后图像的尺寸。 - patch_size (
list[int]
可选, 默认为 self.patch_size) — 图像块嵌入的块大小。 - num_frames (
int
可选, 默认为 self.num_frames) — 视频帧的最大数量。 - resample (
PILImageResampling
, 可选, 默认为self.resample
) — 如果调整图像大小,则使用的重采样滤波器。这可以是枚举PILImageResampling
之一,仅当do_resize
设置为True
时有效。 - do_center_crop (
bool
, 可选, 默认为self.do_centre_crop
) — 是否对图像进行中心裁剪。 - crop_size (
dict[str, int]
, 可选, 默认为self.crop_size
) — 应用中心裁剪后图像的尺寸。 - 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
) — 图像平均值。 - image_std (
float
或list[float]
, 可选, 默认为self.image_std
) — 图像标准差。 - is_mixed (
bool
, 可选) — 如果输入视频包含负样本。 - return_tensors (
str
或TensorType
, 可选) — 要返回的张量类型。可以是以下之一:- 未设置:返回
np.ndarray
列表。 TensorType.TENSORFLOW
或'tf'
:返回tf.Tensor
类型的批次。TensorType.PYTORCH
或'pt'
:返回torch.Tensor
类型的批次。TensorType.NUMPY
或'np'
:返回np.ndarray
类型的批次。TensorType.JAX
或'jax'
:返回jax.numpy.ndarray
类型的批次。
- 未设置:返回
- data_format (
ChannelDimension
或str
, 可选, 默认为ChannelDimension.FIRST
) — 输出图像的通道维度格式。可以是以下之一:ChannelDimension.FIRST
:图像格式为 (num_channels, height, width)。ChannelDimension.LAST
:图像格式为 (height, width, num_channels)。- 未设置:使用输入图像推断的通道维度格式。
- 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)。
返回
一个具有以下字段的 BatchFeature
-
pixel_values — 将馈送到模型的像素值,形状为 (batch_size, num_channels, height, width)。
-
pixel_mask — 将馈送到模型的像素掩码,形状为 (batch_size, num_pixel_patches)。
-
pixel_values_mixed — 包含正样本和负样本的像素值,将馈送到模型,形状为 (batch_size, num_channels, height, width)。
-
pixel_mask_mixed — 包含正样本和负样本的像素掩码,将馈送到模型,形状为 (batch_size, num_pixel_patches)。
预处理一个或多个视频或图像。
TvltFeatureExtractor
class transformers.TvltFeatureExtractor
< 来源 >( spectrogram_length = 2048 num_channels = 1 patch_size = [16, 16] feature_size = 128 sampling_rate = 44100 hop_length_to_sampling_rate = 86 n_fft = 2048 padding_value = 0.0 **kwargs )
参数
- spectrogram_length (
dict[str, int]
可选, 默认为 2048) — 每个音频频谱图的时间长度。 - num_channels (
int
可选, 默认为 1) — 音频通道数。 - patch_size (
list[int]
可选, 默认为[16, 16]
) — 音频块嵌入的块大小。 - feature_size (
int
, 可选, 默认为 128) — 音频频谱图的频率长度。 - sampling_rate (
int
, 可选, 默认为 44100) — 音频文件应以赫兹 (Hz) 为单位进行数字化的采样率。 - hop_length_to_sampling_rate (
int
, 可选, 默认为 86) — 跳跃长度是用于获取梅尔频率系数的 STFT 重叠窗口的长度。例如,采样率为 44100 时,跳跃长度为 512,44100 / 512 = 86。 - n_fft (
int
, 可选, 默认为 2048) — 傅里叶变换的大小。 - padding_value (
float
, 可选, 默认为 0.0) — 用于填充音频的填充值。应与静音相对应。
构造一个 TVLT 音频特征提取器。该特征提取器可用于为模型准备音频。
此特征提取器继承自 FeatureExtractionMixin,其中包含大部分主要方法。用户应参考此超类以获取有关这些方法的更多信息。
__call__
< 来源 >( raw_speech: typing.Union[numpy.ndarray, list[float], list[numpy.ndarray], list[list[float]]] return_tensors: typing.Union[str, transformers.utils.generic.TensorType, NoneType] = None return_attention_mask: typing.Optional[bool] = True sampling_rate: typing.Optional[int] = None resample: bool = False mask_audio: bool = False **kwargs ) → BatchFeature
参数
- raw_speech (
np.ndarray
,list[float]
,list[np.ndarray]
,list[list[float]]
) — 要填充的序列或序列批次。每个序列可以是 numpy 数组、浮点值列表、numpy 数组列表或浮点值列表的列表。必须是单通道音频,而不是立体声,即每个时间步长一个浮点数。 - return_tensors (
str
或 TensorType, 可选) — 如果设置,将返回张量而不是 Python 整数列表。可接受的值为:'pt'
:返回 PyTorchtorch.Tensor
对象。'np'
:返回 Numpynp.ndarray
对象。
- return_attention_mask (
bool
, 可选, 默认为True
) — 是否返回注意力掩码。如果保留默认值,将根据特定特征提取器的默认值返回注意力掩码。什么是注意力掩码?对于 TvltTransformer 模型,对于批处理推理,应始终传递
attention_mask
,以避免细微的错误。 - sampling_rate (
int
, 可选) —raw_speech
输入的采样率。强烈建议在转发调用时传递sampling_rate
,以防止无声错误并允许自动语音识别管道。当前模型支持采样率 16000 和 44100。 - resample (
bool
, 可选, 默认为False
) — 如果采样率不匹配,则重新采样输入音频以匹配。 - mask_audio (
bool
, 可选, 默认为False
) — 是否为 MAE 任务遮盖输入音频。
返回
一个具有以下字段的 BatchFeature
-
audio_values — 将馈送到模型的音频值,形状为 (batch_size, num_channels, height, width)。
-
audio_mask — 将馈送到模型的音频掩码,形状为 (batch_size, num_audio_patches)。
准备一个或多个音频以供模型使用的主要方法。
TvltModel
class transformers.TvltModel
< 来源 >( config )
参数
- config (TvltConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化模型不会加载与模型相关的权重,只加载配置。请查看 from_pretrained() 方法以加载模型权重。
裸 TVLT 模型转换器输出原始隐藏状态,不带任何特定头部。该模型是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用,有关一般用法和行为的所有事项,请参考 PyTorch 文档。
转发
< 来源 >( pixel_values: FloatTensor audio_values: FloatTensor pixel_mask: typing.Optional[torch.FloatTensor] = None audio_mask: typing.Optional[torch.FloatTensor] = None mask_pixel: bool = False mask_audio: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.deprecated.tvlt.modeling_tvlt.TvltModelOutput
或 tuple(torch.FloatTensor)
参数
- pixel_values (形状为
(batch_size, num_frames, num_channels, height, width)
的torch.FloatTensor
) — 像素值。像素值可以使用 TvltProcessor 获得。有关详细信息,请参阅 TvltProcessor.call()。 - audio_values (形状为
(batch_size, num_channels, height, width)
的torch.FloatTensor
) — 音频值。音频值可以使用 TvltProcessor 获得。有关详细信息,请参阅 TvltProcessor.call()。 - pixel_mask (
torch.FloatTensor
形状为(batch_size, num_pixel_patches)
) — 像素掩码。像素掩码可以使用 TvltProcessor 获取。详情请参阅 TvltProcessor.call()。 - audio_mask (
torch.FloatTensor
形状为(batch_size, num_audio_patches)
) — 音频掩码。音频掩码可以使用 TvltProcessor 获取。详情请参阅 TvltProcessor.call()。 - pixel_values_mixed (
torch.FloatTensor
形状为(batch_size, num_frames, num_channels, height, width)
) — 在Tvlt视觉-音频匹配中混合正负样本的像素值。混合像素值可以使用 TvltProcessor 获取。详情请参阅 TvltProcessor.call()。 - pixel_mask_mixed (
torch.FloatTensor
形状为(batch_size, num_channels, height, width)
) — 混合像素值的像素掩码。混合像素掩码可以使用 TvltProcessor 获取。详情请参阅 TvltProcessor.call()。 - mask_pixel (
bool
, 可选) — 是否对MAE任务的像素进行掩码。仅在 TvltForPreTraining 中设置为 True。 - mask_audio (
bool
, 可选) — 是否对MAE任务的音频进行掩码。仅在 TvltForPreTraining 中设置为 True。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。更多详细信息请参阅返回张量下的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。更多详细信息请参阅返回张量下的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.models.deprecated.tvlt.modeling_tvlt.TvltModelOutput
或 tuple(torch.FloatTensor)
一个 transformers.models.deprecated.tvlt.modeling_tvlt.TvltModelOutput
或 torch.FloatTensor
元组(如果传递了 return_dict=False
或当 config.return_dict=False
时),包含根据配置(TvltConfig)和输入而定的各种元素。
- last_hidden_state (
torch.FloatTensor
, 形状为(batch_size, sequence_length, hidden_size)
) — 模型最后一层输出的隐藏状态序列。 - last_pixel_hidden_state (
torch.FloatTensor
形状为(batch_size, pixel_sequence_length, hidden_size)
) — 模型最后一层输出的像素序列隐藏状态。 - last_audio_hidden_state (
torch.FloatTensor
形状为(batch_size, audio_sequence_length, hidden_size)
) — 模型最后一层输出的音频序列隐藏状态。 - pixel_label_masks (
torch.FloatTensor
形状为(batch_size, pixel_patch_length)
) — 指示哪些像素块被掩码(1)哪些没有(0)的张量。 - audio_label_masks (
torch.FloatTensor
形状为(batch_size, audio_patch_length)
) — 指示哪些音频块被掩码(1)哪些没有(0)的张量。 - pixel_ids_restore (
torch.LongTensor
形状为(batch_size, pixel_patch_length)
) — 包含像素掩码 ID 排列的张量。 - audio_ids_restore (
torch.LongTensor
形状为(batch_size, audio_patch_length)
) — 包含音频掩码 ID 排列的张量。 - 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 后的注意力权重,用于计算自注意力头中的加权平均值。
TvltModel 的 forward 方法,重写了 __call__
特殊方法。
尽管 forward pass 的配方需要在此函数中定义,但在此之后应该调用 Module
实例,而不是直接调用此函数,因为前者负责运行预处理和后处理步骤,而后者则会默默地忽略它们。
示例
>>> from transformers import TvltProcessor, TvltModel
>>> import numpy as np
>>> import torch
>>> num_frames = 8
>>> images = list(np.random.randn(num_frames, 3, 224, 224))
>>> audio = list(np.random.randn(10000))
>>> processor = TvltProcessor.from_pretrained("ZinengTang/tvlt-base")
>>> model = TvltModel.from_pretrained("ZinengTang/tvlt-base")
>>> input_dict = processor(images, audio, sampling_rate=44100, return_tensors="pt")
>>> outputs = model(**input_dict)
>>> loss = outputs.loss
TvltForPreTraining
class transformers.TvltForPreTraining
< source >( config )
参数
- config (TvltConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重,只加载配置。请查看 from_pretrained() 方法来加载模型权重。
用于自监督预训练的 TVLT 模型 Transformer,顶部带解码器。此模型是 PyTorch torch.nn.Module 的子类。将其作为常规 PyTorch Module 使用,并参考 PyTorch 文档中所有与通用用法和行为相关的事项。
转发
< source >( pixel_values: FloatTensor audio_values: FloatTensor pixel_mask: typing.Optional[torch.FloatTensor] = None audio_mask: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None pixel_values_mixed: typing.Optional[torch.FloatTensor] = None pixel_mask_mixed: typing.Optional[torch.FloatTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.deprecated.tvlt.modeling_tvlt.TvltForPreTrainingOutput
或 tuple(torch.FloatTensor)
参数
- pixel_values (
torch.FloatTensor
形状为(batch_size, num_frames, num_channels, height, width)
) — 像素值。像素值可以使用 TvltProcessor 获取。详情请参阅 TvltProcessor.call()。 - audio_values (
torch.FloatTensor
形状为(batch_size, num_channels, height, width)
) — 音频值。音频值可以使用 TvltProcessor 获取。详情请参阅 TvltProcessor.call()。 - pixel_mask (
torch.FloatTensor
形状为(batch_size, num_pixel_patches)
) — 像素掩码。像素掩码可以使用 TvltProcessor 获取。详情请参阅 TvltProcessor.call()。 - audio_mask (
torch.FloatTensor
形状为(batch_size, num_audio_patches)
) — 音频掩码。音频掩码可以使用 TvltProcessor 获取。详情请参阅 TvltProcessor.call()。 - pixel_values_mixed (
torch.FloatTensor
形状为(batch_size, num_frames, num_channels, height, width)
) — 在Tvlt视觉-音频匹配中混合正负样本的像素值。混合像素值可以使用 TvltProcessor 获取。详情请参阅 TvltProcessor.call()。 - pixel_mask_mixed (
torch.FloatTensor
形状为(batch_size, num_channels, height, width)
) — 混合像素值的像素掩码。混合像素值可以使用 TvltProcessor 获取。详情请参阅 TvltProcessor.call()。 - mask_pixel (
bool
, 可选) — 是否对MAE任务的像素进行掩码。仅在 TvltForPreTraining 中设置为 True。 - mask_audio (
bool
, 可选) — 是否对MAE任务的音频进行掩码。仅在 TvltForPreTraining 中设置为 True。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。更多详细信息请参阅返回张量下的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。更多详细信息请参阅返回张量下的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 而不是普通元组。 - pixel_values_mixed (
torch.FloatTensor
形状为(batch_size, num_frames, num_channels, height, width)
) — 在Tvlt视觉-音频匹配中混合正负样本的像素值。音频值可以使用 TvltProcessor 获取。详情请参阅 TvltProcessor.call()。 - pixel_mask_mixed (
torch.FloatTensor
形状为(batch_size, num_channels, height, width)
) — 混合像素值的像素掩码。混合像素值可以使用 TvltProcessor 获取。详情请参阅 TvltProcessor.call()。 - labels (
torch.LongTensor
形状为(batch_size, num_labels)
, 可选) — 用于计算视觉-音频匹配损失的标签。索引应在[0, 1]
之间。num_labels
必须为 1。
返回
transformers.models.deprecated.tvlt.modeling_tvlt.TvltForPreTrainingOutput
或 tuple(torch.FloatTensor)
一个 transformers.models.deprecated.tvlt.modeling_tvlt.TvltForPreTrainingOutput
或 torch.FloatTensor
元组(如果传递了 return_dict=False
或当 config.return_dict=False
时),包含根据配置(TvltConfig)和输入而定的各种元素。
- loss (
torch.FloatTensor
,形状为(1,)
) — 像素重建损失。 - matching_logits (
torch.FloatTensor
形状为(batch_size, 1)
) — 匹配目标 logits。 - pixel_logits (
torch.FloatTensor
形状为(batch_size, pixel_patch_length, image_patch_size ** 3 * pixel_num_channels)
):像素重建 logits。 - audio_logits (
torch.FloatTensor
形状为(batch_size, audio_patch_length, image_patch_size[0] * image_patch_size[1])
):音频重建 logits。 - 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 后的注意力权重,用于计算自注意力头中的加权平均值。
TvltForPreTraining 的 forward 方法,重写了 __call__
特殊方法。
尽管 forward pass 的配方需要在此函数中定义,但在此之后应该调用 Module
实例,而不是直接调用此函数,因为前者负责运行预处理和后处理步骤,而后者则会默默地忽略它们。
示例
>>> from transformers import TvltProcessor, TvltForPreTraining
>>> import numpy as np
>>> import torch
>>> num_frames = 8
>>> images = list(np.random.randn(num_frames, 3, 224, 224))
>>> images_mixed = list(np.random.randn(num_frames, 3, 224, 224))
>>> audio = list(np.random.randn(10000))
>>> processor = TvltProcessor.from_pretrained("ZinengTang/tvlt-base")
>>> model = TvltForPreTraining.from_pretrained("ZinengTang/tvlt-base")
>>> input_dict = processor(
... images, audio, images_mixed, sampling_rate=44100, mask_pixel=True, mask_audio=True, return_tensors="pt"
... )
>>> outputs = model(**input_dict)
>>> loss = outputs.loss
TvltForAudioVisualClassification
class transformers.TvltForAudioVisualClassification
< source >( config )
参数
- config (TvltConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重,只加载配置。请查看 from_pretrained() 方法来加载模型权重。
Tvlt 模型 Transformer,顶部带分类器头([CLS] 标记最终隐藏状态顶部的 MLP),用于视听分类任务,例如 CMU-MOSEI 情感分析和音频到视频检索。
此模型是 PyTorch torch.nn.Module 的子类。将其作为常规 PyTorch Module 使用,并参考 PyTorch 文档中所有与通用用法和行为相关的事项。
转发
< source >( pixel_values: FloatTensor audio_values: FloatTensor pixel_mask: typing.Optional[torch.FloatTensor] = None audio_mask: typing.Optional[torch.FloatTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None labels: typing.Optional[torch.LongTensor] = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- pixel_values (
torch.FloatTensor
形状为(batch_size, num_frames, num_channels, height, width)
) — 像素值。像素值可以使用 TvltProcessor 获取。详情请参阅 TvltProcessor.call()。 - audio_values (
torch.FloatTensor
形状为(batch_size, num_channels, height, width)
) — 音频值。音频值可以使用 TvltProcessor 获取。详情请参阅 TvltProcessor.call()。 - pixel_mask (
torch.FloatTensor
形状为(batch_size, num_pixel_patches)
) — 像素掩码。像素掩码可以使用 TvltProcessor 获取。详情请参阅 TvltProcessor.call()。 - audio_mask (
torch.FloatTensor
形状为(batch_size, num_audio_patches)
) — 音频掩码。音频掩码可以使用 TvltProcessor 获取。详情请参阅 TvltProcessor.call()。 - pixel_values_mixed (
torch.FloatTensor
形状为(batch_size, num_frames, num_channels, height, width)
) — 在Tvlt视觉-音频匹配中混合正负样本的像素值。混合像素值可以使用 TvltProcessor 获取。详情请参阅 TvltProcessor.call()。 - pixel_mask_mixed (
torch.FloatTensor
形状为(batch_size, num_channels, height, width)
) — 混合像素值的像素掩码。混合像素值可以使用 TvltProcessor 获取。详情请参阅 TvltProcessor.call()。 - mask_pixel (
bool
, 可选) — 是否对MAE任务的像素进行掩码。仅在 TvltForPreTraining 中设置为 True。 - mask_audio (
bool
, 可选) — 是否对MAE任务的音频进行掩码。仅在 TvltForPreTraining 中设置为 True。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。更多详细信息请参阅返回张量下的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。更多详细信息请参阅返回张量下的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 而不是普通元组。 - labels (
torch.LongTensor
形状为(batch_size, num_labels)
, 可选) — 用于计算视听损失的标签。索引应在[0, ..., num_classes-1]
之间,其中num_classes
指视听任务中的类别数量。
返回
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.SequenceClassifierOutput 或 torch.FloatTensor
元组(如果传递了 return_dict=False
或当 config.return_dict=False
时),包含根据配置(TvltConfig)和输入而定的各种元素。
-
loss (形状为
(1,)
的torch.FloatTensor
,可选,当提供labels
时返回) — 分类损失(如果 config.num_labels==1,则为回归损失)。 -
logits (形状为
(batch_size, config.num_labels)
的torch.FloatTensor
) — 分类(如果 config.num_labels==1,则为回归)分数(SoftMax 之前)。 -
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 后的注意力权重,用于计算自注意力头中的加权平均值。
TvltForAudioVisualClassification 的 forward 方法,重写了 __call__
特殊方法。
尽管 forward pass 的配方需要在此函数中定义,但在此之后应该调用 Module
实例,而不是直接调用此函数,因为前者负责运行预处理和后处理步骤,而后者则会默默地忽略它们。
示例
>>> from transformers import TvltProcessor, TvltForAudioVisualClassification
>>> import numpy as np
>>> import torch
>>> num_frames = 8
>>> images = list(np.random.randn(num_frames, 3, 224, 224))
>>> audio = list(np.random.randn(10000))
>>> processor = TvltProcessor.from_pretrained("ZinengTang/tvlt-base")
>>> model = TvltForAudioVisualClassification.from_pretrained("ZinengTang/tvlt-base")
>>> input_dict = processor(images, audio, sampling_rate=44100, return_tensors="pt")
>>> outputs = model(**input_dict)
>>> loss = outputs.loss