Transformers 文档
混合视觉 Transformer (ViT Hybrid)
并获得增强的文档体验
开始使用
混合视觉 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 在 一张图片价值 16x16 个词：用于大规模图像识别的 Transformer 中提出。这是第一篇成功在 ImageNet 上训练 Transformer 编码器的论文，与熟悉的卷积架构相比取得了非常好的结果。ViT hybrid 是 纯视觉 Transformer 的一个微小变体，它利用了卷积骨干（具体来说是 BiT），其特征用作 Transformer 的初始“标记”。
论文摘要如下：
虽然 Transformer 架构已成为自然语言处理任务的事实标准，但其在计算机视觉领域的应用仍然有限。在视觉领域，注意力要么与卷积网络结合使用，要么用于替代卷积网络的某些组件，同时保持其整体结构不变。我们表明，这种对 CNN 的依赖并非必要，直接应用于图像补丁序列的纯 Transformer 在图像分类任务上可以表现得非常好。当在大量数据上进行预训练并迁移到多个中小型图像识别基准（ImageNet、CIFAR-100、VTAB 等）时，视觉 Transformer (ViT) 与最先进的卷积网络相比取得了优异的结果，同时训练所需的计算资源也大大减少。
该模型由 nielsr 贡献。原始代码（用 JAX 编写）可在 此处 找到。
使用缩放点积注意力 (SDPA)
PyTorch 包含一个原生缩放点积注意力 (SDPA) 运算符，作为 torch.nn.functional 的一部分。此函数包含多种实现，可根据输入和所用硬件进行应用。有关更多信息，请参阅 官方文档 或 GPU 推理 页面。
当实现可用时，SDPA 默认用于 `torch>=2.1.1`，但你也可以在 `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 模型，我们在推理过程中观察到以下加速。
| 批次大小 | 平均推理时间（毫秒），eager 模式 | 平均推理时间（毫秒），sdpa 模型 | 加速，Sdpa / Eager (x) |
|---|---|---|---|
| 1 | 29 | 18 | 1.61 |
| 2 | 26 | 18 | 1.44 |
| 4 | 25 | 18 | 1.39 |
| 8 | 34 | 24 | 1.42 |
资源
Hugging Face 官方和社区（由 🌎 标记）资源列表，帮助您开始使用 ViT Hybrid。
- ViTHybridForImageClassification 受此 示例脚本 和 notebook 支持。
- 另请参阅：图像分类任务指南
如果您有兴趣在此处提交资源，请随时开启 Pull Request，我们将对其进行审查！该资源最好能展示一些新内容，而不是重复现有资源。
ViTHybridConfig
class 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 比率。 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float, 可选, 默认为 1e-12) — 层归一化层使用的 epsilon。 - image_size (
int, 可选, 默认为 224) — 每张图片的大小（分辨率）。 - patch_size (
int, 可选, 默认为 1) — 每个补丁的大小（分辨率）。 - 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
class transformers.ViTHybridImageProcessor
< 源 >( do_resize: bool = True size: typing.Optional[dict[str, int]] = None resample: Resampling = <Resampling.BICUBIC: 3> 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] = None image_std: typing.Union[float, list[float], NoneType] = 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参数覆盖。 - do_convert_rgb (
bool, 可选, 默认为True) — 是否将图像转换为 RGB。
构建一个 ViT Hybrid 图像处理器。
预处理
< 源 >( images: 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 resample: Resampling = None do_center_crop: typing.Optional[bool] = None crop_size: typing.Optional[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 do_convert_rgb: typing.Optional[bool] = None return_tensors: typing.Union[str, transformers.utils.generic.TensorType, NoneType] = None data_format: typing.Optional[transformers.image_utils.ChannelDimension] = <ChannelDimension.FIRST: 'channels_first'> input_data_format: typing.Union[str, transformers.image_utils.ChannelDimension, NoneType] = 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) — 是否对图像进行归一化。 - 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, 可选) — 要返回的张量类型。可以是以下之一：- 未设置：返回
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 文档中所有与一般用法和行为相关的事项。
前向
< 源 >( pixel_values: typing.Optional[torch.Tensor] = None bool_masked_pos: typing.Optional[torch.BoolTensor] = None head_mask: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None interpolate_pos_encoding: typing.Optional[bool] = None return_dict: typing.Optional[bool] = 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)) — 序列第一个 token（分类 token）的最后一层隐藏状态，经过辅助预训练任务所用层的进一步处理。例如，对于 BERT 系列模型，这会返回经过线性层和 tanh 激活函数处理后的分类 token。线性层权重在预训练期间通过下一个句子预测（分类）目标进行训练。 -
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 前向方法，覆盖 __call__ 特殊方法。
尽管前向传播的实现需要在该函数中定义，但此后应调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoImageProcessor, ViTHybridModel
>>> import torch
>>> from datasets import load_dataset
>>> dataset = load_dataset("huggingface/cats-image")
>>> 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 )
参数
- config (ViTHybridConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法加载模型权重。
ViT Hybrid 模型变压器，顶部带有图像分类头（[CLS] token 最终隐藏状态顶部的线性层），例如用于 ImageNet。
此模型是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并参考 PyTorch 文档中所有与一般用法和行为相关的事项。
前向
< 源 >( pixel_values: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None interpolate_pos_encoding: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.ImageClassifierOutput 或 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 而不是普通元组。 - labels (
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) 和输入的不同元素。
-
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, 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")
>>> 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