Transformers 文档

VideoMAE

Hugging Face's logo
加入 Hugging Face 社区

并获得增强型文档体验

开始使用

VideoMAE

概述

VideoMAE 模型由 Zhan Tong、Yibing Song、Jue Wang 和 Limin Wang 在 VideoMAE:掩码自动编码器是用于自监督视频预训练的有效学习器 中提出。VideoMAE 将掩码自动编码器 (MAE) 扩展到视频,在几个视频分类基准测试中取得了最先进的性能。

论文中的摘要如下:

在相对较小的数据集上实现最佳性能通常需要在超大规模数据集上对视频 Transformer 进行预训练。在本文中,我们表明视频掩码自动编码器 (VideoMAE) 是用于自监督视频预训练 (SSVP) 的数据高效学习器。我们受到最近 ImageMAE 的启发,并提出了定制的视频片段掩码和重建。这些简单的设计被证明可以有效地克服视频重建过程中由时间相关性引起的信漏。我们在 SSVP 上获得了三个重要发现:(1) 极高的掩码比例(即 90% 到 95%)仍然可以产生 VideoMAE 的良好性能。时间冗余的视频内容使掩码比例高于图像。 (2) VideoMAE 在非常小的数据集(即大约 3000-4000 个视频)上取得了令人印象深刻的结果,而无需使用任何额外数据。这部分归因于视频重建的挑战性任务,以强制执行高级结构学习。 (3) VideoMAE 表明,对于 SSVP 而言,数据质量比数据量更重要。预训练和目标数据集之间的领域偏移是 SSVP 中的重要问题。值得注意的是,我们使用 vanilla ViT 主干的 VideoMAE 在 Kinects-400 上可以达到 83.9%,在 Something-Something V2 上达到 75.3%,在 UCF101 上达到 90.8%,在 HMDB51 上达到 61.1%,而无需使用任何额外数据。

drawing VideoMAE 预训练。摘自 原始论文

此模型由 nielsr 贡献。原始代码可以在这里找到 这里

使用缩放点积注意力 (SDPA)

PyTorch 将原生缩放点积注意力 (SDPA) 运算符作为 torch.nn.functional 的一部分。此函数包含多个实现,可以根据输入和使用的硬件应用。有关更多信息,请参阅 官方文档GPU 推理 页面。

对于 torch>=2.1.1,SDPA 默认情况下在可用时使用,但您也可以在 from_pretrained() 中设置 attn_implementation="sdpa" 以明确请求使用 SDPA。

from transformers import VideoMAEForVideoClassification
model = VideoMAEForVideoClassification.from_pretrained("MCG-NJU/videomae-base-finetuned-kinetics", attn_implementation="sdpa", torch_dtype=torch.float16)
...

为了获得最佳加速,我们建议以半精度(例如 torch.float16torch.bfloat16)加载模型。

在使用 float32MCG-NJU/videomae-base-finetuned-kinetics 模型的本地基准测试(A100-40GB、PyTorch 2.3.0、操作系统 Ubuntu 22.04)中,我们在推理期间看到了以下加速。

批次大小 平均推理时间(毫秒),急切模式 平均推理时间(毫秒),sdpa 模型 加速,Sdpa / Eager (x)
1 37 10 3.7
2 24 18 1.33
4 43 32 1.34
8 84 60 1.4

资源

以下是 Hugging Face 官方资源和社区资源 (🌎 表示) 的列表,它们可以帮助您开始使用 VideoMAE。如果您有兴趣提交要在此处包含的资源,请随时打开一个 Pull Request,我们会审核它!理想情况下,资源应该展示一些新内容,而不是重复现有的资源。

视频分类

VideoMAEConfig

class transformers.VideoMAEConfig

< >

( image_size = 224 patch_size = 16 num_channels = 3 num_frames = 16 tubelet_size = 2 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-12 qkv_bias = True use_mean_pooling = True decoder_num_attention_heads = 6 decoder_hidden_size = 384 decoder_num_hidden_layers = 4 decoder_intermediate_size = 1536 norm_pix_loss = True **kwargs )

参数

  • image_size (int, 可选, 默认值为 224) — 每个图像的大小(分辨率)。
  • patch_size (int, 可选, 默认值为 16) — 每个补丁的大小(分辨率)。
  • num_channels (int, 可选, 默认值为 3) — 输入通道的数量。
  • num_frames (int, 可选, 默认值为 16) — 每个视频中的帧数。
  • tubelet_size (int, 可选, 默认值为 2) — 小管的数量。
  • hidden_size (int, 可选, 默认值为 768) — 编码器层和池化层的维度。
  • num_hidden_layers (int, 可选, 默认值为 12) — Transformer 编码器中隐藏层的数量。
  • num_attention_heads (int, 可选, 默认值为 12) — Transformer 编码器中每个注意力层的注意力头的数量。
  • 中间层大小 (int, 可选, 默认值 3072) — Transformer 编码器中“中间”(即前馈)层的维度。
  • 隐藏激活函数 (strfunction, 可选, 默认值 "gelu") — 编码器和池化器中的非线性激活函数(函数或字符串)。如果为字符串,则支持 "gelu""relu""selu""gelu_new"
  • 隐藏层丢失概率 (float, 可选, 默认值 0.0) — 嵌入、编码器和池化器中所有全连接层的丢失概率。
  • 注意力概率丢失概率 (float, 可选, 默认值 0.0) — 注意力概率的丢失率。
  • 初始化范围 (float, 可选, 默认值 0.02) — 初始化所有权重矩阵的截断正态初始化的标准差。
  • 层归一化ε (float, 可选, 默认值 1e-12) — 层归一化层使用的ε。
  • 是否添加 qkv 偏差 (bool, 可选, 默认值 True) — 是否向查询、键和值添加偏差。
  • 使用平均池化 (bool, 可选, 默认值 True) — 是否对最终隐藏状态进行平均池化,而不是使用 [CLS] 标记的最终隐藏状态。
  • 解码器注意力头数量 (int, 可选, 默认值 6) — 解码器中每个注意力层的注意力头数量。
  • 解码器隐藏层大小 (int, 可选, 默认值 384) — 解码器的维度。
  • decoder_intermediate_size (int, 可选, 默认值为 1536) — 解码器中“中间”(即前馈)层的维度。
  • norm_pix_loss (bool, 可选, 默认值为 True) — 是否对目标补丁像素进行归一化。

这是用于存储 VideoMAEModel 配置的配置类。它用于根据指定的参数实例化 VideoMAE 模型,定义模型架构。使用默认值实例化配置将产生与 VideoMAE MCG-NJU/videomae-base 架构相似的配置。

配置对象继承自 PretrainedConfig,可用于控制模型输出。阅读 PretrainedConfig 的文档以了解更多信息。

示例

>>> from transformers import VideoMAEConfig, VideoMAEModel

>>> # Initializing a VideoMAE videomae-base style configuration
>>> configuration = VideoMAEConfig()

>>> # Randomly initializing a model from the configuration
>>> model = VideoMAEModel(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

VideoMAEFeatureExtractor

class transformers.VideoMAEFeatureExtractor

< >

( *args **kwargs )

__call__

< >

( images **kwargs )

预处理图像或一批图像。

VideoMAEImageProcessor

class transformers.VideoMAEImageProcessor

< >

( do_resize: bool = True size: Dict = None resample: Resampling = <Resampling.BILINEAR: 2> do_center_crop: bool = True crop_size: Dict = None do_rescale: bool = True rescale_factor: Union = 0.00392156862745098 do_normalize: bool = True image_mean: Union = None image_std: Union = None **kwargs )

参数

  • do_resize (bool, 可选, 默认值为 True) — 是否将图像的(高度、宽度)尺寸调整为指定的 size。可以在 preprocess 方法中被 do_resize 参数覆盖。
  • resample (PILImageResampling, 可选, 默认值 Resampling.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 (intfloat, 可选, 默认值 1/255) — 如果重新缩放图像,则要使用的比例因子。 可以被preprocess方法中的rescale_factor参数覆盖。
  • do_normalize (bool, 可选, 默认值 True) — 是否对图像进行标准化。 可以被preprocess方法中的do_normalize参数覆盖。
  • image_mean (floatList[float], 可选, 默认值 IMAGENET_STANDARD_MEAN) — 如果对图像进行标准化,则要使用的均值。 这是一个浮点数或浮点数列表,其长度等于图像中通道数。 可以被preprocess方法中的image_mean参数覆盖。
  • image_std (floatList[float], 可选, 默认值 IMAGENET_STANDARD_STD) — 如果对图像进行标准化,则要使用的标准差。 这是一个浮点数或浮点数列表,其长度等于图像中通道数。 可以被preprocess方法中的image_std参数覆盖。

构造一个 VideoMAE 图像处理器。

preprocess

< >

( videos: Union do_resize: bool = None size: Dict = None resample: Resampling = None do_center_crop: bool = None crop_size: Dict = None do_rescale: bool = None rescale_factor: float = None do_normalize: bool = None image_mean: Union = None image_std: Union = None return_tensors: Union = None data_format: ChannelDimension = <ChannelDimension.FIRST: 'channels_first'> input_data_format: Union = None )

参数

  • images (ImageInput) — 要预处理的图像。预期单个或批量的图像,像素值范围为 0 到 255。如果传入像素值范围为 0 到 1 的图像,请设置 do_rescale=False
  • do_resize (bool, 可选, 默认值为 self.do_resize) — 是否调整图像大小。
  • size (Dict[str, int], 可选, 默认值为 self.size) — 应用调整大小后图像的大小。
  • 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_std (floatList[float], 可选, 默认值 self.image_std) — 图像标准差。
  • return_tensors (strTensorType, 可选) — 要返回的张量类型。可以是以下之一:
    • 未设置:返回 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 (ChannelDimensionstr, 可选, 默认值 ChannelDimension.FIRST) — 输出图像的通道维度格式。可以是以下之一:
    • ChannelDimension.FIRST:图像格式为 (通道数, 高度, 宽度)。
    • ChannelDimension.LAST:图像格式为 (高度, 宽度, 通道数)。
    • 未设置:使用输入图像的推断通道维度格式。
  • input_data_format (ChannelDimensionstr, 可选) — 输入图像的通道维度格式。如果未设置,则从输入图像推断通道维度格式。可以是以下之一:
    • "channels_first"ChannelDimension.FIRST:图像格式为 (通道数, 高度, 宽度)。
    • "channels_last"ChannelDimension.LAST:图像格式为 (高度, 宽度, 通道数)。
    • "none"ChannelDimension.NONE:图像格式为 (高度, 宽度)。

预处理图像或图像批次。

VideoMAEModel

class transformers.VideoMAEModel

< >

( config )

参数

  • config (VideoMAEConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,只会加载配置。查看 from_pretrained() 方法加载模型权重。

裸 VideoMAE 模型转换器,输出原始隐藏状态,没有任何特定头部。此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档以了解有关一般用法和行为的所有事项。

forward

< >

( pixel_values: FloatTensor bool_masked_pos: Optional = None head_mask: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.modeling_outputs.BaseModelOutputtuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor 形状为 (batch_size, num_frames,
  • head_mask (torch.FloatTensor 形状为 (num_heads,)(num_layers, num_heads)可选) — 用于使自注意力模块中选定头部无效的掩码。掩码值选择在 [0, 1] 中:

    • 1 表示头部 **未被掩码**,
    • 0 表示头部 **被掩码**。
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。有关详细信息,请参阅返回张量中的 attentions
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。有关详细信息,请参阅返回张量中的 hidden_states
  • return_dict (bool可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。
  • bool_masked_pos (torch.BoolTensor 形状为 (batch_size, sequence_length)可选) — 布尔掩码位置。指示哪些补丁被掩码 (1) 以及哪些没有 (0)。批次中的每个视频都必须具有相同数量的掩码补丁。如果为 None,则所有补丁都被考虑。序列长度为 (num_frames // tubelet_size) * (image_size // patch_size) ** 2

返回

transformers.modeling_outputs.BaseModelOutputtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.BaseModelOutput 或一个 torch.FloatTensor 元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含取决于配置 (VideoMAEConfig) 和输入的各种元素。

  • last_hidden_state (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层的输出处的隐藏状态序列。

  • 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 后的注意力权重,用于计算自注意力头中的加权平均值。

VideoMAEModel 正向方法,覆盖 __call__ 特殊方法。

尽管正向传递的配方需要在此函数中定义,但应随后调用 Module 实例,而不是调用此函数,因为前者负责运行前处理和后处理步骤,而后者会静默地忽略它们。

示例

>>> import av
>>> import numpy as np

>>> from transformers import AutoImageProcessor, VideoMAEModel
>>> from huggingface_hub import hf_hub_download

>>> np.random.seed(0)


>>> 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])


>>> def sample_frame_indices(clip_len, frame_sample_rate, seg_len):
...     '''
...     Sample a given number of frame indices from the video.
...     Args:
...         clip_len (`int`): Total number of frames to sample.
...         frame_sample_rate (`int`): Sample every n-th frame.
...         seg_len (`int`): Maximum allowed index of sample's last frame.
...     Returns:
...         indices (`List[int]`): List of sampled frame indices
...     '''
...     converted_len = int(clip_len * frame_sample_rate)
...     end_idx = np.random.randint(converted_len, seg_len)
...     start_idx = end_idx - converted_len
...     indices = np.linspace(start_idx, end_idx, num=clip_len)
...     indices = np.clip(indices, start_idx, end_idx - 1).astype(np.int64)
...     return indices


>>> # video clip consists of 300 frames (10 seconds at 30 FPS)
>>> file_path = hf_hub_download(
...     repo_id="nielsr/video-demo", filename="eating_spaghetti.mp4", repo_type="dataset"
... )
>>> container = av.open(file_path)

>>> # sample 16 frames
>>> indices = sample_frame_indices(clip_len=16, frame_sample_rate=1, seg_len=container.streams.video[0].frames)
>>> video = read_video_pyav(container, indices)

>>> image_processor = AutoImageProcessor.from_pretrained("MCG-NJU/videomae-base")
>>> model = VideoMAEModel.from_pretrained("MCG-NJU/videomae-base")

>>> # prepare video for the model
>>> inputs = image_processor(list(video), return_tensors="pt")

>>> # forward pass
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_state
>>> list(last_hidden_states.shape)
[1, 1568, 768]

VideoMAEForPreTraining

VideoMAEForPreTraining 包含顶部的解码器,用于自监督预训练。

class transformers.VideoMAEForPreTraining

< >

( config )

参数

  • config (VideoMAEConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,只会加载配置。查看 from_pretrained() 方法以加载模型权重。

带有解码器用于自监督预训练的 VideoMAE 模型变换器。此模型是一个 PyTorch torch.nn.Module 子类。将其用作常规的 PyTorch 模块,并参考 PyTorch 文档了解与一般使用和行为相关的所有事项。

forward

< >

( pixel_values: FloatTensor bool_masked_pos: BoolTensor head_mask: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.models.videomae.modeling_videomae.VideoMAEForPreTrainingOutputtuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor 形状为 (batch_size, num_frames, num_channels, height, width)) — 像素值。像素值可以使用 AutoImageProcessor 获取。有关详细信息,请参阅 VideoMAEImageProcessor.call()
  • head_mask (torch.FloatTensor 形状为 (num_heads,)(num_layers, num_heads)可选) — 用于将自注意力模块的选定头部置为零的掩码。掩码值选择在 [0, 1] 中:

    • 1 表示头部未被掩码
    • 0 表示头部被掩码
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的attentions
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的hidden_states
  • return_dict (bool可选) — 是否返回 ModelOutput 而不是普通元组。
  • bool_masked_pos (torch.BoolTensor 形状为 (batch_size, sequence_length)) — 布尔掩码位置。指示哪些补丁被掩码 (1) 以及哪些没有 (0)。批次中的每个视频都必须具有相同数量的掩码补丁。序列长度为 (num_frames // tubelet_size) * (image_size // patch_size) ** 2

返回

transformers.models.videomae.modeling_videomae.VideoMAEForPreTrainingOutputtuple(torch.FloatTensor)

A transformers.models.videomae.modeling_videomae.VideoMAEForPreTrainingOutputtorch.FloatTensor 元组(如果传递了 return_dict=Falseconfig.return_dict=False),包含根据配置 (VideoMAEConfig) 和输入的不同元素。

  • loss (torch.FloatTensor 形状为 (1,)) — 像素重建损失。
  • logits (torch.FloatTensor 形状为 (batch_size, patch_size ** 2 * num_channels)) — 像素重建 logits。
  • hidden_states (tuple(torch.FloatTensor)可选,在传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 元组(一个用于嵌入的输出 + 一个用于每一层的输出)形状为 (batch_size, sequence_length, hidden_size)。每一层模型的输出隐藏状态加上初始嵌入输出。
  • attentions (tuple(torch.FloatTensor)可选,在传递 output_attentions=Trueconfig.output_attentions=True 时返回) — torch.FloatTensor 元组(每一层一个)形状为 (batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均值。

The VideoMAEForPreTraining 正向方法,重写 __call__ 特殊方法。

尽管正向传递的配方需要在此函数中定义,但应随后调用 Module 实例,而不是调用此函数,因为前者负责运行前处理和后处理步骤,而后者会静默地忽略它们。

示例

>>> from transformers import AutoImageProcessor, VideoMAEForPreTraining
>>> import numpy as np
>>> import torch

>>> num_frames = 16
>>> video = list(np.random.randint(0, 256, (num_frames, 3, 224, 224)))

>>> image_processor = AutoImageProcessor.from_pretrained("MCG-NJU/videomae-base")
>>> model = VideoMAEForPreTraining.from_pretrained("MCG-NJU/videomae-base")

>>> pixel_values = image_processor(video, return_tensors="pt").pixel_values

>>> num_patches_per_frame = (model.config.image_size // model.config.patch_size) ** 2
>>> seq_length = (num_frames // model.config.tubelet_size) * num_patches_per_frame
>>> bool_masked_pos = torch.randint(0, 2, (1, seq_length)).bool()

>>> outputs = model(pixel_values, bool_masked_pos=bool_masked_pos)
>>> loss = outputs.loss

VideoMAEForVideoClassification

class transformers.VideoMAEForVideoClassification

< >

( config )

参数

  • config (VideoMAEConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,仅加载配置。查看 from_pretrained() 方法来加载模型权重。

具有视频分类头的 VideoMAE 模型转换器(在所有标记的平均池化隐藏状态之上添加一个线性层),例如 ImageNet。此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档以了解与一般使用和行为相关的所有事项。

forward

< >

( pixel_values: Optional = None head_mask: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.modeling_outputs.ImageClassifierOutputtuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor 形状为 (batch_size, num_frames, num_channels, height, width)) — 像素值。像素值可以使用 AutoImageProcessor 获取。有关详细信息,请参见 VideoMAEImageProcessor.call()
  • head_mask (torch.FloatTensor 形状为 (num_heads,)(num_layers, num_heads)可选) — 用于使自注意力模块中选定的头部无效的掩码。在 [0, 1] 中选择掩码值:

    • 1 表示头部未被掩码
    • 0 表示头部被掩码
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。有关详细信息,请参见返回张量中的 attentions
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。有关详细信息,请参见返回张量中的 hidden_states
  • return_dict (bool可选) — 是否返回 ModelOutput 而不是简单的元组。
  • labels (torch.LongTensor 形状为 (batch_size,)可选) — 用于计算图像分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 中。如果 config.num_labels == 1,则计算回归损失(均方损失),如果 config.num_labels > 1,则计算分类损失(交叉熵)。

返回

transformers.modeling_outputs.ImageClassifierOutputtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.ImageClassifierOutputtorch.FloatTensor 的元组(如果传递 return_dict=False 或当 config.return_dict=False 时),包括根据配置 (VideoMAEConfig) 和输入而变化的各种元素。

  • loss (torch.FloatTensor 形状为 (1,)可选,当提供 labels 时返回) — 分类(或如果 config.num_labels==1 则为回归)损失。

  • logits (torch.FloatTensor 形状为 (batch_size, config.num_labels)) — 分类(或如果 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, patch_size, sequence_length)

    注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均值。

The VideoMAEForVideoClassification forward method overrides the __call__ special method.

尽管正向传递的配方需要在此函数中定义,但应随后调用 Module 实例,而不是调用此函数,因为前者负责运行前处理和后处理步骤,而后者会静默地忽略它们。

示例

>>> import av
>>> import torch
>>> import numpy as np

>>> from transformers import AutoImageProcessor, VideoMAEForVideoClassification
>>> from huggingface_hub import hf_hub_download

>>> np.random.seed(0)


>>> 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])


>>> def sample_frame_indices(clip_len, frame_sample_rate, seg_len):
...     '''
...     Sample a given number of frame indices from the video.
...     Args:
...         clip_len (`int`): Total number of frames to sample.
...         frame_sample_rate (`int`): Sample every n-th frame.
...         seg_len (`int`): Maximum allowed index of sample's last frame.
...     Returns:
...         indices (`List[int]`): List of sampled frame indices
...     '''
...     converted_len = int(clip_len * frame_sample_rate)
...     end_idx = np.random.randint(converted_len, seg_len)
...     start_idx = end_idx - converted_len
...     indices = np.linspace(start_idx, end_idx, num=clip_len)
...     indices = np.clip(indices, start_idx, end_idx - 1).astype(np.int64)
...     return indices


>>> # video clip consists of 300 frames (10 seconds at 30 FPS)
>>> file_path = hf_hub_download(
...     repo_id="nielsr/video-demo", filename="eating_spaghetti.mp4", repo_type="dataset"
... )
>>> container = av.open(file_path)

>>> # sample 16 frames
>>> indices = sample_frame_indices(clip_len=16, frame_sample_rate=1, seg_len=container.streams.video[0].frames)
>>> video = read_video_pyav(container, indices)

>>> image_processor = AutoImageProcessor.from_pretrained("MCG-NJU/videomae-base-finetuned-kinetics")
>>> model = VideoMAEForVideoClassification.from_pretrained("MCG-NJU/videomae-base-finetuned-kinetics")

>>> inputs = image_processor(list(video), return_tensors="pt")

>>> with torch.no_grad():
...     outputs = model(**inputs)
...     logits = outputs.logits

>>> # model predicts one of the 400 Kinetics-400 classes
>>> predicted_label = logits.argmax(-1).item()
>>> print(model.config.id2label[predicted_label])
eating spaghetti
< > Update on GitHub