混合视觉Transformer (ViT Hybrid)
此模型仅处于维护模式，我们不接受任何更改其代码的新的PR。如果您在运行此模型时遇到任何问题，请重新安装支持此模型的最后一个版本：v4.40.2。您可以通过运行以下命令来执行此操作： pip install -U transformers==4.40.2。
概述
混合视觉Transformer (ViT) 模型由Alexey Dosovitskiy、Lucas Beyer、Alexander Kolesnikov、Dirk Weissenborn、Xiaohua Zhai、Thomas Unterthiner、Mostafa Dehghani、Matthias Minderer、Georg Heigold、Sylvain Gelly、Jakob Uszkoreit和Neil Houlsby在An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale中提出。这是第一篇成功在ImageNet上训练Transformer编码器的论文，与常见的卷积架构相比，取得了非常好的结果。ViT混合模型是普通视觉Transformer的一个轻微变体，它利用了一个卷积主干网络（具体来说是BiT），其特征被用作Transformer的初始“token”。
论文的摘要如下：
虽然Transformer架构已成为自然语言处理任务的事实标准，但其在计算机视觉中的应用仍然有限。在视觉领域，注意力机制要么与卷积神经网络结合使用，要么用来替换卷积神经网络的某些组件，同时保持其整体结构不变。我们证明了这种对CNN的依赖并非必要，直接应用于图像块序列的纯Transformer可以在图像分类任务中表现出色。当在大量数据上进行预训练并迁移到多个中等或小型图像识别基准（ImageNet、CIFAR-100、VTAB等）时，视觉Transformer (ViT) 与最先进的卷积神经网络相比取得了优异的结果，同时训练所需的计算资源大大减少。
此模型由nielsr贡献。原始代码（用JAX编写）可以在这里找到。
使用缩放点积注意力 (SDPA)
PyTorch 将本地的缩放点积注意力 (SDPA) 运算符作为 torch.nn.functional 的一部分包含在内。此函数包含多种实现，可以根据输入和使用的硬件应用。有关更多信息，请参阅官方文档或GPU 推理页面。
当实现可用时，torch>=2.1.1 默认使用 SDPA，但您也可以在 from_pretrained() 中设置 attn_implementation="sdpa" 以明确请求使用 SDPA。
from transformers import ViTHybridForImageClassification
model = ViTHybridForImageClassification.from_pretrained("google/vit-hybrid-base-bit-384", attn_implementation="sdpa", torch_dtype=torch.float16)
...为了获得最佳加速效果，我们建议以半精度（例如 torch.float16 或 torch.bfloat16）加载模型。
在本地基准测试（A100-40GB、PyTorch 2.3.0、操作系统 Ubuntu 22.04）中，使用 float32 和 google/vit-hybrid-base-bit-384 模型，我们在推理过程中观察到以下加速效果。
| 批次大小 | 平均推理时间（毫秒），急切模式 | 平均推理时间（毫秒），sdpa 模型 | 加速倍数，Sdpa / 急切模式 (x) |
|---|---|---|---|
| 1 | 29 | 18 | 1.61 |
| 2 | 26 | 18 | 1.44 |
| 4 | 25 | 18 | 1.39 |
| 8 | 34 | 24 | 1.42 |
资源
以下是帮助您开始使用 ViT Hybrid 的官方 Hugging Face 和社区（由🌎表示）资源列表。
- ViTHybridForImageClassification 受此示例脚本和笔记本的支持。
- 另请参阅：图像分类任务指南
如果您有兴趣提交要在此处包含的资源，请随时打开一个拉取请求，我们将对其进行审查！理想情况下，资源应演示一些新内容，而不是重复现有资源。
ViTHybridConfig
类 transformers.ViTHybridConfig
< 源代码 >( backbone_config = None backbone = None use_pretrained_backbone = False use_timm_backbone = False backbone_kwargs = None 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 image_size = 224 patch_size = 1 num_channels = 3 backbone_featmap_shape = [1, 1024, 24, 24] qkv_bias = True **kwargs )
参数
- backbone_config (
Union[Dict[str, Any], PretrainedConfig], 可选) — 主干网络的配置，可以是字典或主干网络的配置对象。 - backbone (
str, 可选) — 当backbone_config为None时要使用的主干网络名称。如果use_pretrained_backbone为True，则会从 timm 或 transformers 库中加载相应的预训练权重。如果use_pretrained_backbone为False，则加载主干网络的配置并使用它以随机权重初始化主干网络。 - use_pretrained_backbone (
bool，可选，默认为False) — 是否使用预训练的骨干网络权重。 - use_timm_backbone (
bool，可选，默认为False) — 是否从 timm 库加载backbone。如果为False，则从 transformers 库加载骨干网络。 - backbone_kwargs (
dict，可选) — 加载检查点时传递给 AutoBackbone 的关键字参数，例如{'out_indices': (0, 1, 2, 3)}。如果设置了backbone_config，则不能指定此参数。 - 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 比率。 - image_size (
int，可选，默认为 224) — 每个图像的大小（分辨率）。 - patch_size (
int，可选，默认为 1) — 每个 patch 的大小（分辨率）。 - num_channels (
int，可选，默认为 3) — 输入通道的数量。 - backbone_featmap_shape (
List[int]，可选，默认为[1, 1024, 24, 24]) — 仅用于hybrid嵌入类型。骨干网络特征图的形状。 - qkv_bias (
bool，可选，默认为True) — 是否向查询、键和值添加偏置。
这是用于存储 ViTHybridModel 配置的配置类。它用于根据指定的参数实例化 ViT Hybrid 模型，定义模型架构。使用默认值实例化配置将产生与 ViT Hybrid google/vit-hybrid-base-bit-384 架构类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。阅读 PretrainedConfig 中的文档以获取更多信息。
示例
>>> from transformers import ViTHybridConfig, ViTHybridModel
>>> # Initializing a ViT Hybrid vit-hybrid-base-bit-384 style configuration
>>> configuration = ViTHybridConfig()
>>> # Initializing a model (with random weights) from the vit-hybrid-base-bit-384 style configuration
>>> model = ViTHybridModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configViTHybridImageProcessor
类 transformers.ViTHybridImageProcessor
< 源代码 >( do_resize: bool = True size: Dict = None resample: Resampling = <Resampling.BICUBIC: 3> 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 do_convert_rgb: bool = True **kwargs )
参数
- do_resize (
bool，可选，默认为True) — 是否将图像的（高度，宽度）尺寸调整为指定的size。可以在preprocess方法中通过do_resize覆盖。 - size (
Dict[str, int]可选，默认为{"shortest_edge" -- 224})：调整大小后图像的大小。图像的最短边调整为 size[“shortest_edge”]，最长边调整为保持输入纵横比。可以在preprocess方法中通过size覆盖。 - resample (
PILImageResampling，可选，默认为PILImageResampling.BICUBIC) — 如果调整图像大小，则使用哪个重采样滤镜。可以在preprocess方法中通过resample覆盖。 - do_center_crop (
bool，可选，默认为True) — 是否将图像中心裁剪到指定的crop_size。可以在preprocess方法中通过do_center_crop覆盖。 - crop_size (
Dict[str, int]可选，默认为 224) — 应用center_crop后输出图像的大小。可以在preprocess方法中通过crop_size覆盖。 - do_rescale (
bool，可选，默认为True) — 是否按指定的比例rescale_factor重新缩放图像。可以在preprocess方法中通过do_rescale覆盖。 - rescale_factor (
int或float，可选，默认为1/255) — 如果重新缩放图像，则使用哪个比例因子。可以在preprocess方法中通过rescale_factor覆盖。 do_normalize — 是否标准化图像。可以在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参数中覆盖。可以在preprocess方法中的image_std参数中覆盖。 - do_convert_rgb (
bool，可选，默认为True) — 是否将图像转换为 RGB。
构造 ViT Hybrid 图像处理器。
预处理
< 源代码 >( images: Union do_resize: bool = None size: Dict = None resample: Resampling = None do_center_crop: bool = None crop_size: int = None do_rescale: bool = None rescale_factor: float = None do_normalize: bool = None image_mean: Union = None image_std: Union = None do_convert_rgb: bool = None return_tensors: Union = None data_format: Optional = <ChannelDimension.FIRST: 'channels_first'> input_data_format: Union = None **kwargs )
参数
- images (
ImageInput) — 需要预处理的图像。预期为单个或一批像素值范围在 0 到 255 之间的图像。如果传递像素值在 0 到 1 之间的图像，请将do_rescale=False。 - do_resize (
bool, 可选, 默认为self.do_resize) — 是否调整图像大小。 - size (
Dict[str, int], 可选, 默认为self.size) — 调整大小后图像的大小。图像的最短边调整为 size[“shortest_edge”]，最长边调整为保持输入纵横比。 - resample (
int, 可选, 默认为self.resample) — 如果调整图像大小，则使用重采样滤波器。这可以是枚举PILImageResampling中的一个。仅当do_resize设置为True时才有效。 - do_center_crop (
bool, 可选, 默认为self.do_center_crop) — 是否将图像居中裁剪。 - crop_size (
Dict[str, int], 可选, 默认为self.crop_size) — 中心裁剪的大小。仅当do_center_crop设置为True时才有效。 - do_rescale (
bool, 可选, 默认为self.do_rescale) — 是否重新缩放图像。 - rescale_factor (
float, 可选, 默认为self.rescale_factor) — 如果do_rescale设置为True，则用于重新缩放图像的重新缩放因子。 - do_normalize (
bool, 可选, 默认为self.do_normalize) — 是否标准化图像。 - do_convert_rgb (
bool，可选，默认为self.do_convert_rgb) — 是否将图像转换为 RGB。 - 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)。
预处理图像或图像批次。
ViTHybridModel
类 transformers.ViTHybridModel
< 源代码 >( config: ViTHybridConfig add_pooling_layer: bool = True use_mask_token: bool = False )
参数
- config (ViTHybridConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
基本的 ViT Hybrid 模型转换器，输出原始隐藏状态，没有任何特定的头部。此模型是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解与一般用法和行为相关的所有事项。
forward
< 源代码 >( pixel_values: Optional = None bool_masked_pos: Optional = None head_mask: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None interpolate_pos_encoding: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.BaseModelOutputWithPooling 或 tuple(torch.FloatTensor)
参数
- pixel_values (
torch.FloatTensor形状为(batch_size, num_channels, height, width)) — 像素值。可以使用 AutoImageProcessor 获取像素值。有关详细信息，请参阅 ViTHybridImageProcessor.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, num_patches)，可选) — 布尔掩码位置。指示哪些补丁被掩码 (1) 以及哪些没有 (0)。
返回
transformers.modeling_outputs.BaseModelOutputWithPooling 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPooling 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (ViTHybridConfig) 和输入而变化的各种元素。
-
last_hidden_state (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出处的隐藏状态序列。 -
pooler_output (
torch.FloatTensor形状为(batch_size, hidden_size)) — 序列第一个标记（分类标记）的最后一层隐藏状态，经过用于辅助预训练任务的层的进一步处理。例如，对于 BERT 系列模型，这会返回经过线性层和 tanh 激活函数处理后的分类标记。线性层权重在预训练期间从下一句预测（分类）目标中训练得到。 -
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 之后的注意力权重，用于计算自注意力头中的加权平均值。
ViTHybridModel 的 forward 方法覆盖了 __call__ 特殊方法。
尽管正向传递的配方需要在此函数内定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则静默地忽略它们。
示例
>>> from transformers import AutoImageProcessor, ViTHybridModel
>>> import torch
>>> from datasets import load_dataset
>>> dataset = load_dataset("huggingface/cats-image", trust_remote_code=True)
>>> image = dataset["test"]["image"][0]
>>> image_processor = AutoImageProcessor.from_pretrained("google/vit-hybrid-base-bit-384")
>>> model = ViTHybridModel.from_pretrained("google/vit-hybrid-base-bit-384")
>>> inputs = image_processor(image, return_tensors="pt")
>>> with torch.no_grad():
... outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_state
>>> list(last_hidden_states.shape)
[1, 197, 768]ViTHybridForImageClassification
类 transformers.ViTHybridForImageClassification
< 源代码 >( config: ViTHybridConfig )
参数
- 配置 (ViTHybridConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
带有图像分类头的 ViT Hybrid 模型转换器（最终隐藏状态的 [CLS] token 上的线性层），例如用于 ImageNet。
此模型是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解与一般用法和行为相关的所有事项。
forward
< 源代码 >( pixel_values: 可选 = None head_mask: 可选 = None labels: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None interpolate_pos_encoding: 可选 = None return_dict: 可选 = None ) → transformers.modeling_outputs.ImageClassifierOutput 或 tuple(torch.FloatTensor)
参数
- 像素值 (
torch.FloatTensor形状为(batch_size, num_channels, height, width)) — 像素值。可以使用 AutoImageProcessor 获取像素值。有关详细信息，请参阅 ViTHybridImageProcessor.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 而不是普通元组。 - 标签 (
torch.LongTensor形状为(batch_size,)，可选) — 用于计算图像分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]中。如果config.num_labels == 1，则计算回归损失（均方误差损失），如果config.num_labels > 1，则计算分类损失（交叉熵损失）。
返回
transformers.modeling_outputs.ImageClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.ImageClassifierOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置 (ViTHybridConfig) 和输入而异的各种元素。
-
损失 (
torch.FloatTensor形状为(1,)，可选，在提供labels时返回) — 分类（或如果 config.num_labels==1 则为回归）损失。 -
logits (
torch.FloatTensor形状为(batch_size, config.num_labels)) — 分类（或如果 config.num_labels==1 则为回归）分数（在 SoftMax 之前）。 -
隐藏状态 (
tuple(torch.FloatTensor)，可选，在传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入的输出，如果模型具有嵌入层，加上每个阶段的输出）形状为(batch_size, sequence_length, hidden_size)。模型在每个阶段输出处的隐藏状态（也称为特征图）。 -
注意力 (
tuple(torch.FloatTensor)，可选，在传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个）形状为(batch_size, num_heads, patch_size, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
ViTHybridForImageClassification 的前向方法覆盖了 __call__ 特殊方法。
尽管正向传递的配方需要在此函数内定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则静默地忽略它们。
示例
>>> from transformers import AutoImageProcessor, ViTHybridForImageClassification
>>> import torch
>>> from datasets import load_dataset
>>> dataset = load_dataset("huggingface/cats-image", trust_remote_code=True)
>>> image = dataset["test"]["image"][0]
>>> image_processor = AutoImageProcessor.from_pretrained("google/vit-hybrid-base-bit-384")
>>> model = ViTHybridForImageClassification.from_pretrained("google/vit-hybrid-base-bit-384")
>>> inputs = image_processor(image, return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> # model predicts one of the 1000 ImageNet classes
>>> predicted_label = logits.argmax(-1).item()
>>> print(model.config.id2label[predicted_label])
tabby, tabby cat