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, optional, defaults to 224) — 每个图像的大小（分辨率）。 - spectrogram_length (
int, optional, defaults to 2048) — 每个音频频谱图的时间长度。 - frequency_length (
int, optional, defaults to 128) — 音频频谱图的频率长度。 - image_patch_size (
List[int], optional, defaults to[16, 16]) — 每个图像块的大小（分辨率）。 - audio_patch_size (
List[int], optional, defaults to[16, 16]) — 每个音频块的大小（分辨率）。 - num_image_channels (
int, optional, defaults to 3) — 输入图像通道数。 - num_audio_channels (
int, optional, defaults to 1) — 输入音频通道数。 - num_frames (
int, optional, defaults to 8) — 输入视频的最大帧数。 - hidden_size (
int, optional, defaults to 768) — 编码器层和池化层的维度。 - num_hidden_layers (
int, optional, defaults to 12) — Transformer 编码器中的隐藏层数。 - num_attention_heads (
int, optional, defaults to 12) — Transformer 编码器中每个注意力层的注意力头数。 - intermediate_size (
int, optional, defaults to 3072) — Transformer 编码器中“中间”（即，前馈）层的维度。 - hidden_act (
strorfunction, optional, defaults to"gelu") — 编码器和池化层中的非线性激活函数（函数或字符串）。如果为字符串，则支持"gelu"、"relu"、"selu"和"gelu_new"。 - hidden_dropout_prob (
float, optional, defaults to 0.0) — 嵌入层、编码器和池化层中所有全连接层的 dropout 概率。 - attention_probs_dropout_prob (
float, optional, defaults to 0.0) — 注意力概率的 dropout 比率。 - initializer_range (
float, optional, defaults to 0.02) — 用于初始化所有权重矩阵的截断正态分布初始化器的标准差。 - layer_norm_eps (
float, optional, defaults to 1e-06) — 层归一化层使用的 epsilon 值。 - qkv_bias (
bool, optional, defaults toTrue) — 是否向 queries、keys 和 values 添加偏置。 - use_mean_pooling (
bool, optional, defaults toFalse) — 是否使用均值池化最终隐藏状态，而不是使用 [CLS] 标记的最终隐藏状态。 - decoder_num_attention_heads (
int, optional, defaults to 16) — 解码器中每个注意力层的注意力头数。 - decoder_hidden_size (
int, optional, defaults to 512) — 解码器的维度。 - decoder_num_hidden_layers (
int, optional, defaults to 8) — 解码器中的隐藏层数。 - decoder_intermediate_size (
int, optional, defaults to 2048) — 解码器中“中间”（即，前馈）层的维度。 - pixel_mask_ratio (
float, optional, defaults to 0.75) — 图像块掩码比例。 - audio_mask_ratio (
float, optional, defaults to 0.15) — 音频块掩码比例。 - audio_mask_type (
str, optional, defaults to"frame-level") — 音频块掩码类型，选择 “frame-level” 和 “patch-level” 之间。 - task_matching (
bool, optional, defaults toTrue) — 是否在预训练中使用视觉音频匹配任务。 - task_mae (
bool, optional, defaults toTrue) — 是否在预训练中使用掩码自编码器 (MAE)。 - loss_type (
str, optional, defaults to"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.configTvltProcessor
class transformers.TvltProcessor
< source >( image_processor feature_extractor )
参数
- image_processor (
TvltImageProcessor) — TvltImageProcessor 的一个实例。图像处理器是必需的输入。 - feature_extractor (
TvltFeatureExtractor) — TvltFeatureExtractor 的一个实例。特征提取器是必需的输入。
构建一个 TVLT 处理器，该处理器将 TVLT 图像处理器和 TVLT 特征提取器包装成一个单独的处理器。
TvltProcessor 提供了 TvltImageProcessor 和 TvltFeatureExtractor 的所有功能。有关更多信息，请参阅 call() 的文档字符串。
__call__
< source >( 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
< source >( do_resize: bool = True size: typing.Dict[str, int] = None patch_size: typing.List[int] = [16, 16] num_frames: int = 8 resample: Resampling = <Resampling.BILINEAR: 2> do_center_crop: bool = True crop_size: typing.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, typing.List[float], NoneType] = [0.5, 0.5, 0.5] image_std: typing.Union[float, typing.List[float], NoneType] = [0.5, 0.5, 0.5] init_mask_generator = False **kwargs )
参数
- do_resize (
bool, optional, defaults toTrue) — 是否将图像的（高度，宽度）尺寸调整为指定的size。 可以被preprocess方法中的do_resize参数覆盖。 - size (
Dict[str, int]optional, defaults to{"shortest_edge" -- 224}): 调整大小后输出图像的大小。图像的最短边将调整为size["shortest_edge"]，同时保持原始图像的纵横比。可以被preprocess方法中的size覆盖。 - patch_size (
List[int]optional, defaults to [16,16]) — 图像块嵌入的块大小。 - num_frames (
intoptional, defaults to 8) — 视频帧的最大数量。 - resample (
PILImageResampling, optional, defaults toPILImageResampling.BILINEAR) — 如果调整图像大小，则使用的重采样滤波器。可以被preprocess方法中的resample参数覆盖。 - do_center_crop (
bool, optional, defaults toTrue) — 是否将图像中心裁剪为指定的crop_size。 可以被preprocess方法中的do_center_crop参数覆盖。 - crop_size (
Dict[str, int], optional, defaults to{"height" -- 224, "width": 224}): 应用中心裁剪后图像的大小。可以被preprocess方法中的crop_size参数覆盖。 - do_rescale (
bool, optional, defaults toTrue) — 是否按指定的比例rescale_factor缩放图像。可以被preprocess方法中的do_rescale参数覆盖。 - rescale_factor (
intorfloat, optional, defaults to 1/255) — 定义缩放图像时使用的比例因子。可以被preprocess方法中的rescale_factor参数覆盖。 - do_normalize (
bool, optional, defaults toTrue) — 是否标准化图像。可以被preprocess方法中的do_normalize参数覆盖。 - image_mean (
floatorList[float], optional, defaults toIMAGENET_STANDARD_MEAN) — 如果标准化图像，则使用的均值。这是一个浮点数或浮点数列表，其长度为图像中通道的数量。可以被preprocess方法中的image_mean参数覆盖。 - image_std (
floatorList[float], optional, defaults toIMAGENET_STANDARD_STD) — 如果标准化图像，则使用的标准差。这是一个浮点数或浮点数列表，其长度为图像中通道的数量。可以被preprocess方法中的image_std参数覆盖。
构建一个 TVLT 图像处理器。
此处理器可用于通过将图像转换为 1 帧视频来为模型准备视频或图像。
preprocess
< source >( videos: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']] do_resize: bool = None size: typing.Dict[str, int] = None patch_size: typing.List[int] = None num_frames: int = None resample: Resampling = None do_center_crop: bool = None crop_size: typing.Dict[str, int] = None do_rescale: bool = None rescale_factor: float = None do_normalize: bool = None image_mean: typing.Union[float, typing.List[float], NoneType] = None image_std: typing.Union[float, typing.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, optional, defaults toself.do_resize) — 是否调整图像大小。 - size (
Dict[str, int], optional, defaults toself.size) — 应用调整大小后图像的大小。 - patch_size (
List[int]optional, 默认为 self.patch_size) — 图像块嵌入的块大小。 - num_frames (
intoptional, 默认为 self.num_frames) — 视频帧的最大数量。 - resample (
PILImageResampling, optional, 默认为self.resample) — 如果调整图像大小，则使用的重采样过滤器。这可以是枚举类型PILImageResampling之一。仅当do_resize设置为True时才有效。 - do_center_crop (
bool, optional, 默认为self.do_centre_crop) — 是否对图像进行中心裁剪。 - crop_size (
Dict[str, int], optional, 默认为self.crop_size) — 应用中心裁剪后图像的大小。 - do_rescale (
bool, optional, 默认为self.do_rescale) — 是否将图像值重新缩放到 [0 - 1] 之间。 - rescale_factor (
float, optional, 默认为self.rescale_factor) — 如果do_rescale设置为True，则通过此重缩放因子来重缩放图像。 - do_normalize (
bool, optional, 默认为self.do_normalize) — 是否对图像进行归一化。 - image_mean (
float或List[float], optional, 默认为self.image_mean) — 图像均值。 - image_std (
float或List[float], optional, 默认为self.image_std) — 图像标准差。 - is_mixed (
bool, optional) — 如果输入视频具有负样本。 - return_tensors (
str或TensorType, optional) — 返回张量的类型。可以是以下之一：- 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, optional, 默认为ChannelDimension.FIRST) — 输出图像的通道维度格式。可以是以下之一：ChannelDimension.FIRST: 图像格式为 (num_channels, height, width)。ChannelDimension.LAST: 图像格式为 (height, width, num_channels)。- Unset: 使用输入图像的推断通道维度格式。
- input_data_format (
ChannelDimension或str, optional) — 输入图像的通道维度格式。如果未设置，则从输入图像推断通道维度格式。可以是以下之一："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
< source >( 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]optional, 默认为 2048) — 每个音频频谱图的时间长度。 - num_channels (
intoptional, 默认为 1) — 音频通道的数量。 - patch_size (
List[int]optional, 默认为[16, 16]) — 音频块嵌入的块大小。 - feature_size (
int, optional, 默认为 128) — 音频频谱图的频率长度。 - sampling_rate (
int, optional, 默认为 44100) — 音频文件应数字化的采样率，以赫兹 (Hz) 表示。 - hop_length_to_sampling_rate (
int, optional, 默认为 86) — Hop length 是用于获取梅尔频率系数的 STFT 的重叠窗口的长度。例如，对于采样率 44100，hop length 为 512，其中 44100 / 512 = 86 - n_fft (
int, optional, 默认为 2048) — 傅里叶变换的大小。 - padding_value (
float, optional, 默认为 0.0) — 用于填充音频的填充值。应对应于静音。
构建 TVLT 音频特征提取器。此特征提取器可用于为模型准备音频。
此特征提取器继承自 FeatureExtractionMixin，其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。
__call__
< source >( raw_speech: typing.Union[numpy.ndarray, typing.List[float], typing.List[numpy.ndarray], typing.List[typing.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, optional) — 如果设置，将返回张量而不是 python 整数列表。可接受的值为：'pt': 返回 PyTorchtorch.Tensor对象。'np': 返回 Numpynp.ndarray对象。
- return_attention_mask (
bool, optional, 默认为True) — 是否返回注意力掩码。如果保留为默认值，将根据特定 feature_extractor 的默认值返回注意力掩码。 什么是注意力掩码？对于 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
< source >( config )
参数
- config (TvltConfig) — 带有模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重，仅加载配置。 查看 from_pretrained() 方法来加载模型权重。
裸 TVLT 模型转换器，输出原始隐藏状态，顶部没有任何特定的 head。 此模型是 PyTorch torch.nn.Module 子类。 将其用作常规 PyTorch 模块，并参阅 PyTorch 文档以获取与常规用法和行为相关的所有事项。
forward
< source >( 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 (
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)) — pixel_values_mixed 的像素掩码。 混合的像素掩码可以使用 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 传递的配方需要在该函数中定义，但应该在之后调用 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.lossTvltForPreTraining
class transformers.TvltForPreTraining
< source >( config )
参数
- config (TvltConfig) — 带有模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重，仅加载配置。 查看 from_pretrained() 方法来加载模型权重。
带有用于自监督预训练的解码器顶部的 TVLT 模型转换器。 此模型是 PyTorch torch.nn.Module 子类。 将其用作常规 PyTorch 模块，并参阅 PyTorch 文档以获取与常规用法和行为相关的所有事项。
forward
< 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)) —pixel_values_mixed的像素掩码。 混合像素掩码可以使用 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)) —pixel_values_mixed的像素掩码。 混合像素值可以使用 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 前向方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 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.lossTvltForAudioVisualClassification
class transformers.TvltForAudioVisualClassification
< source >( config )
参数
- config (TvltConfig) — 带有模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重，仅加载配置。 查看 from_pretrained() 方法来加载模型权重。
Tvlt 模型转换器，顶部带有一个分类器头（[CLS] 标记的最终隐藏状态之上的 MLP），用于视听分类任务，例如 CMU-MOSEI 情感分析和音频到视频检索。
此模型是 PyTorch torch.nn.Module 子类。 将其用作常规 PyTorch 模块，并参阅 PyTorch 文档，了解与常规用法和行为相关的所有事项。
forward
< 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)) —pixel_values_mixed的像素掩码。 混合像素掩码可以使用 TvltProcessor 获得。 有关详细信息，请参阅 TvltProcessor.call()。 - mask_pixel (
bool, 可选) — 是否为 MAE 任务掩码像素。 仅在 TvltForPreTraining 中设置为 True。 - mask_audio (
bool, 可选) — 是否为 MAE 任务掩码音频。 仅在 TvltForPreTraining 中设置为 True。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参见返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。 详见返回张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是纯元组。 - labels (
torch.LongTensor, 形状为(batch_size, num_labels), optional) — 用于计算视听损失的标签。 索引应在[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 (
torch.FloatTensor, 形状为(1,), optional, 当提供labels时返回) — 分类（或回归，如果 config.num_labels==1）损失。 -
logits (
torch.FloatTensor, 形状为(batch_size, config.num_labels)) — 分类（或回归，如果 config.num_labels==1）得分（在 SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor元组（如果模型具有嵌入层，则为嵌入层的输出，加上每层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出端的隐藏状态，加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
TvltForAudioVisualClassification 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 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