视觉Transformer (ViT)
概述
Vision Transformer (ViT) 模型是在 An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale 中由 Alexey Dosovitskiy、Lucas Beyer、Alexander Kolesnikov、Dirk Weissenborn、Xiaohua Zhai、Thomas Unterthiner、Mostafa Dehghani、Matthias Minderer、Georg Heigold、Sylvain Gelly、Jakob Uszkoreit、Neil Houlsby 提出的。 这是第一篇成功在 ImageNet 上训练 Transformer 编码器的论文,与传统的卷积架构相比取得了非常好的结果。
论文的摘要如下:
虽然 Transformer 架构已成为自然语言处理任务的事实标准,但其在计算机视觉中的应用仍然有限。 在视觉领域,注意力机制要么与卷积网络一起使用,要么用于替换卷积网络的某些组件,同时保留其整体结构。 我们表明,这种对 CNN 的依赖性不是必需的,直接应用于图像块序列的纯 Transformer 在图像分类任务上可以表现得非常好。 当在大量数据上进行预训练并迁移到多个中等规模或小型图像识别基准(ImageNet、CIFAR-100、VTAB 等)时,Vision Transformer (ViT) 与最先进的卷积网络相比取得了优异的结果,同时训练所需的计算资源明显减少。
ViT 架构。 取自 原始论文。继最初的 Vision Transformer 之后,一些后续工作已经完成
DeiT (Data-efficient Image Transformers) 由 Facebook AI 开发。 DeiT 模型是蒸馏的视觉 Transformer。 DeiT 的作者还发布了训练效率更高的 ViT 模型,您可以直接将其插入 ViTModel 或 ViTForImageClassification 中。 有 4 种变体可用(有 3 种不同尺寸):facebook/deit-tiny-patch16-224、facebook/deit-small-patch16-224、facebook/deit-base-patch16-224 和 facebook/deit-base-patch16-384。 请注意,应该使用 DeiTImageProcessor 来准备模型的图像。
BEiT (BERT pre-training of Image Transformers) 由微软研究院开发。 BEiT 模型使用受 BERT(遮蔽图像建模)启发且基于 VQ-VAE 的自监督方法,优于监督预训练的视觉 Transformer。
DINO (a method for self-supervised training of Vision Transformers) 由 Facebook AI 开发。 使用 DINO 方法训练的视觉 Transformer 表现出卷积模型从未见过的非常有趣的特性。 它们能够分割物体,而从未接受过分割的训练。 DINO 检查点可以在 hub 上找到。
MAE (Masked Autoencoders) 由 Facebook AI 开发。 通过对视觉 Transformer 进行预训练,以重建对很大一部分(75%)遮蔽块的像素值(使用非对称编码器-解码器架构),作者表明,这种简单的方法在微调后优于监督预训练。
该模型由 nielsr 贡献。 原始代码(用 JAX 编写)可以在 这里 找到。
请注意,我们从 Ross Wightman 的 timm 库 中转换了权重,他已将权重从 JAX 转换为 PyTorch。 功劳归他!
使用技巧
- 为了将图像馈送到 Transformer 编码器,每个图像都被分成一系列固定大小的非重叠块,这些块随后被线性嵌入。 添加一个 [CLS] 令牌,用作整个图像的表示,可用于分类。 作者还添加了绝对位置嵌入,并将生成的向量序列馈送到标准 Transformer 编码器。
- 由于 Vision Transformer 期望每个图像都具有相同的大小(分辨率),因此可以使用 ViTImageProcessor 来调整大小(或重新缩放)并规范化模型的图像。
- 预训练或微调期间使用的块分辨率和图像分辨率都反映在每个检查点的名称中。 例如,
google/vit-base-patch16-224
指的是块分辨率为 16x16 且微调分辨率为 224x224 的基础架构。 所有检查点都可以在 hub 上找到。 - 可用的检查点要么 (1) 仅在 ImageNet-21k(包含 1400 万张图像和 21,000 个类别)上进行预训练,要么 (2) 也在 ImageNet(也称为 ILSVRC 2012,包含 130 万张图像和 1,000 个类别)上进行微调。
- Vision Transformer 使用 224x224 的分辨率进行预训练。 在微调期间,使用高于预训练的分辨率通常是有益的 (Touvron 等人,2019)、(Kolesnikov 等人,2020)。 为了在更高分辨率下进行微调,作者根据预训练位置嵌入在原始图像中的位置执行 2D 插值。
- 监督预训练获得了最佳结果,这在 NLP 中并非如此。 作者还使用自监督预训练目标进行了实验,即遮蔽块预测(受遮蔽语言建模的启发)。 使用这种方法,较小的 ViT-B/16 模型在 ImageNet 上获得了 79.9% 的准确率,比从头开始训练提高了 2%,但仍比监督预训练落后 4%。
使用缩放点积注意力 (SDPA)
PyTorch 将本机缩放点积注意力 (SDPA) 运算符作为 torch.nn.functional
的一部分。 此函数包含几种实现,可以根据输入和使用的硬件应用。 有关更多信息,请参阅 官方文档 或 GPU 推理 页面。
当有实现可用时,SDPA 默认为 torch>=2.1.1
使用,但您也可以在 from_pretrained()
中设置 attn_implementation="sdpa"
,以明确请求使用 SDPA。
from transformers import ViTForImageClassification
model = ViTForImageClassification.from_pretrained("google/vit-base-patch16-224", attn_implementation="sdpa", torch_dtype=torch.float16)
...
为了获得最佳加速,我们建议以半精度(例如 torch.float16
或 torch.bfloat16
)加载模型。
在本地基准测试(A100-40GB、PyTorch 2.3.0、操作系统 Ubuntu 22.04)上,使用 float32
和 google/vit-base-patch16-224
模型,我们在推理期间看到了以下加速。
批次大小 | 平均推理时间(毫秒),急切模式 | 平均推理时间(毫秒),sdpa 模型 | 加速,Sdpa / 急切 (x) |
---|---|---|---|
1 | 7 | 6 | 1.17 |
2 | 8 | 6 | 1.33 |
4 | 8 | 6 | 1.33 |
8 | 8 | 6 | 1.33 |
资源
有关推理以及在自定义数据上微调 ViT 的演示笔记本可以在 这里 找到。 一系列官方 Hugging Face 和社区(由 🌎 表示)资源,可帮助您开始使用 ViT。 如果您有兴趣提交要包含在此处的资源,请随时打开一个 Pull Request,我们将对其进行审查! 该资源应该理想地展示一些新内容,而不是重复现有的资源。
ViTForImageClassification
受以下支持:
- 一篇关于如何使用 Hugging Face Transformers 微调 ViT 进行图像分类 的博文
- 一篇关于使用 Hugging Face Transformers 和
Keras
进行图像分类 的博文 - 一个关于使用 Hugging Face Transformers 进行图像分类微调 的笔记本
- 一个关于如何使用 Hugging Face Trainer 在 CIFAR-10 上微调 Vision Transformer 的笔记本
- 一个关于如何使用 PyTorch Lightning 在 CIFAR-10 上微调 Vision Transformer 的笔记本
⚗️ 优化
- 一篇关于如何使用 Optimum 使用量化加速 Vision Transformer (ViT) 的博文
⚡️ 推理
🚀 部署
- 一篇关于使用 TF Serving 在 Hugging Face 中部署 TensorFlow 视觉模型 的博文
- 一篇关于在 Vertex AI 部署 Hugging Face ViT 的博文
- 一篇关于使用 TF Serving 在 Kubernetes 部署 Hugging Face ViT 的博文
ViTConfig
class transformers.ViTConfig
< source >( 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 = 16 num_channels = 3 qkv_bias = True encoder_stride = 16 **kwargs )
参数
- 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) — 初始化所有权重矩阵的截断正态初始化的标准差。 - patch_size (
int
, 可选, 默认为 16) — 每个补丁的大小(分辨率)。 - num_channels (
int
, 可选, 默认为 3) — 输入通道的数量。 - qkv_bias (
bool
, 可选, 默认为True
) — 是否向查询、键和值添加偏差。 - encoder_stride (
int
, 可选, 默认为 16) — 在掩码图像建模的解码器头中,用于增加空间分辨率的因子。
这是用于存储 ViTModel 配置的配置类。它用于根据指定的参数实例化 ViT 模型,定义模型架构。使用默认值实例化配置将产生与 ViT google/vit-base-patch16-224 架构类似的配置。
配置对象继承自 PretrainedConfig,可用于控制模型输出。阅读 PretrainedConfig 中的文档以获取更多信息。
示例
>>> from transformers import ViTConfig, ViTModel
>>> # Initializing a ViT vit-base-patch16-224 style configuration
>>> configuration = ViTConfig()
>>> # Initializing a model (with random weights) from the vit-base-patch16-224 style configuration
>>> model = ViTModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config
ViTFeatureExtractor
预处理图像或一批图像。
ViTImageProcessor
class transformers.ViTImageProcessor
<( do_resize: bool = True size: Optional = None resample: Resampling = <Resampling.BILINEAR: 2> 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["height"], size["width"])
。可以被preprocess
方法中的do_resize
参数覆盖。 - size (
dict
, 可选, 默认为{"height" -- 224, "width": 224}
): 调整大小后输出图像的大小。可以被preprocess
方法中的size
参数覆盖。 - resample (
PILImageResampling
, 可选, 默认为Resampling.BILINEAR
) — 如果调整图像大小,要使用的重采样滤波器。可以被preprocess
方法中的resample
参数覆盖。 - 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
参数覆盖。
构建一个 ViT 图像处理器。
preprocess
< 源代码 > ( images: Union do_resize: Optional = None size: Dict = None resample: Resampling = None do_rescale: Optional = None rescale_factor: Optional = None do_normalize: Optional = None image_mean: Union = None image_std: Union = None return_tensors: Union = None data_format: Union = <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
) — 格式为{"height": h, "width": w}
的字典,指定调整大小后输出图像的大小。 - resample (
PILImageResampling
过滤器,可选,默认为self.resample
) — 如果调整图像大小,则要使用的PILImageResampling
过滤器,例如PILImageResampling.BILINEAR
。 仅当do_resize
设置为True
时才有效。 - 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
) — 如果do_normalize
设置为True
,则要使用的图像平均值。 - image_std (
float
或List[float]
, 可选,默认为self.image_std
) — 如果do_normalize
设置为True
,则要使用的图像标准差。 - input_data_format (
ChannelDimension
或str
, 可选) — 输入图像的通道维度格式。 如果未设置,则从输入图像推断通道维度格式。 可以是以下之一:"channels_first"
或ChannelDimension.FIRST
: 图像格式为 (通道数, 高度, 宽度)。"channels_last"
或ChannelDimension.LAST
: 图像格式为 (高度, 宽度, 通道数)。"none"
或ChannelDimension.NONE
: 图像格式为 (高度, 宽度)。
预处理图像或图像批次。
ViTImageProcessorFast
class transformers.ViTImageProcessorFast
< 源代码 >( do_resize: bool = True size: Optional = None resample: Resampling = <Resampling.BILINEAR: 2> 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["height"], size["width"])
。 可以被preprocess
方法中的do_resize
参数覆盖。 - size (
dict
, 可选, 默认值为{"height" -- 224, "width": 224}
): 调整大小后输出图像的大小。 可以被preprocess
方法中的size
参数覆盖。 - resample (
PILImageResampling
, 可选, 默认值为Resampling.BILINEAR
) — 如果调整图像大小,则要使用的重采样滤镜。 可以被preprocess
方法中的resample
参数覆盖。 - 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
参数覆盖。
构建一个 ViT 图像处理器。
preprocess
< source > ( images: Union do_resize: Optional = None size: Dict = None resample: Resampling = None do_rescale: Optional = None rescale_factor: Optional = None do_normalize: Optional = None image_mean: Union = None image_std: Union = None return_tensors: Union = 'pt' data_format: Union = <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
) — 格式为{"height": h, "width": w}
的字典,指定调整大小后输出图像的大小。 - resample (
PILImageResampling
过滤器, 可选, 默认值self.resample
) — 如果调整图像大小,则使用的PILImageResampling
过滤器,例如PILImageResampling.BILINEAR
。仅当do_resize
设置为True
时才有效。 - 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
) — 如果do_normalize
设置为True
,则要使用的图像均值。 - image_std (
float
或List[float]
, 可选, 默认值为self.image_std
) — 如果do_normalize
设置为True
,则要使用的图像标准差。 - return_tensors (
str
或TensorType
, 可选) — 要返回的张量类型。仅支持 “pt”。 - data_format (
ChannelDimension
或str
, 可选, 默认值为ChannelDimension.FIRST
) — 输出图像的通道维度格式。当前支持以下格式:"channels_first"
或ChannelDimension.FIRST
: 图像以 (num_channels, height, width) 格式。
- 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) 格式。
预处理图像或图像批次。
ViTModel
class transformers.ViTModel
< 源代码 >( config: ViTConfig add_pooling_layer: bool = True use_mask_token: bool = False )
参数
- config (ViTConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,只会加载配置。查看 from_pretrained() 方法以加载模型权重。
基本的 ViT 模型变压器,输出原始隐藏状态,没有任何特定的头部。此模型是一个 PyTorch torch.nn.Module 子类。将其用作普通的 PyTorch 模块,并参考 PyTorch 文档了解与通用使用和行为相关的所有事宜。
正向传播
< 源代码 > ( 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 获取。详情请参见 ViTImageProcessor.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
。 - interpolate_pos_encoding (
bool
,可选) — 是否插值预训练的位置编码。 - 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
)包含根据配置 (ViTConfig) 和输入的不同元素。
-
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 之后的注意力权重,用于计算自注意力头中的加权平均值。
ViTModel 正向方法,覆盖 __call__
特殊方法。
虽然正向传递的配方需要在这个函数中定义,但应该在之后调用 Module
实例,而不是这个函数,因为前者负责运行预处理和后处理步骤,而后者会默默地忽略它们。
示例
>>> from transformers import AutoImageProcessor, ViTModel
>>> 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-base-patch16-224-in21k")
>>> model = ViTModel.from_pretrained("google/vit-base-patch16-224-in21k")
>>> 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]
ViTForMaskedImageModeling
class transformers.ViTForMaskedImageModeling
< 源代码 >( config: ViTConfig )
参数
- config (ViTConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,只会加载配置。查看 from_pretrained() 方法来加载模型权重。
带有解码器的 ViT 模型,用于掩码图像建模,如 SimMIM 中所提出。
请注意,我们在 示例目录 中提供了一个脚本,用于在自定义数据上预训练此模型。
此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档了解与一般使用和行为相关的任何事宜。
正向传播
< source > ( 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.MaskedImageModelingOutput
or tuple(torch.FloatTensor)
参数
- pixel_values (
torch.FloatTensor
形状为(batch_size, num_channels, height, width)
) — 像素值。像素值可以使用 AutoImageProcessor 获取。有关详细信息,请参阅 ViTImageProcessor.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
。 - interpolate_pos_encoding (
bool
,可选) — 是否对预训练的位置编码进行插值。 - return_dict (
bool
,可选) — 是否返回 ModelOutput 而不是普通元组。 - bool_masked_pos (
torch.BoolTensor
形状为(batch_size, num_patches)
) — 布尔掩码位置。指示哪些补丁被掩码 (1) 以及哪些没有 (0)。
返回
transformers.modeling_outputs.MaskedImageModelingOutput
or tuple(torch.FloatTensor)
transformers.modeling_outputs.MaskedImageModelingOutput
或 torch.FloatTensor
的元组(如果传递了 return_dict=False
或当 config.return_dict=False
时),包含取决于配置 (ViTConfig) 和输入的各种元素。
- loss (
torch.FloatTensor
形状为(1,)
,可选,在提供bool_masked_pos
时返回) — 重建损失。 - reconstruction (
torch.FloatTensor
形状为(batch_size, num_channels, height, width)
) — 重建/完成的图像。 - 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 后的注意力权重,用于计算自注意力头中的加权平均值。
ViTForMaskedImageModeling 正向方法覆盖了 __call__
特殊方法。
虽然正向传递的配方需要在这个函数中定义,但应该在之后调用 Module
实例,而不是这个函数,因为前者负责运行预处理和后处理步骤,而后者会默默地忽略它们。
示例
>>> from transformers import AutoImageProcessor, ViTForMaskedImageModeling
>>> import torch
>>> from PIL import Image
>>> import requests
>>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
>>> image = Image.open(requests.get(url, stream=True).raw)
>>> image_processor = AutoImageProcessor.from_pretrained("google/vit-base-patch16-224-in21k")
>>> model = ViTForMaskedImageModeling.from_pretrained("google/vit-base-patch16-224-in21k")
>>> num_patches = (model.config.image_size // model.config.patch_size) ** 2
>>> pixel_values = image_processor(images=image, return_tensors="pt").pixel_values
>>> # create random boolean mask of shape (batch_size, num_patches)
>>> bool_masked_pos = torch.randint(low=0, high=2, size=(1, num_patches)).bool()
>>> outputs = model(pixel_values, bool_masked_pos=bool_masked_pos)
>>> loss, reconstructed_pixel_values = outputs.loss, outputs.reconstruction
>>> list(reconstructed_pixel_values.shape)
[1, 3, 224, 224]
ViTForImageClassification
class transformers.ViTForImageClassification
< 源代码 >( config: ViTConfig )
参数
- config (ViTConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,只会加载配置。查看 from_pretrained() 方法以加载模型权重。
具有图像分类头的 ViT 模型变换器(在 [CLS] 令牌的最终隐藏状态之上有一个线性层),例如用于 ImageNet。
请注意,可以通过在模型的前向传播中将 interpolate_pos_encoding
设置为 True
,在比训练过的图像分辨率更高的图像上微调 ViT。这将把预训练的 位置嵌入插值到更高的分辨率。
此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档了解与一般使用和行为相关的任何事宜。
正向传播
< 源代码 > ( pixel_values: Optional = None head_mask: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None interpolate_pos_encoding: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.ImageClassifierOutput 或 tuple(torch.FloatTensor)
参数
- pixel_values (
torch.FloatTensor
形状为(batch_size, num_channels, height, width)
) — 像素值。像素值可以使用 AutoImageProcessor 获取。查看 ViTImageProcessor.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
。 - interpolate_pos_encoding (
bool
, 可选) — 是否插值预训练的位置编码。 - 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
时),包含取决于配置 (ViTConfig) 和输入的各种元素。
-
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 ViTForImageClassification forward 方法,覆盖 __call__
特殊方法。
虽然正向传递的配方需要在这个函数中定义,但应该在之后调用 Module
实例,而不是这个函数,因为前者负责运行预处理和后处理步骤,而后者会默默地忽略它们。
示例
>>> from transformers import AutoImageProcessor, ViTForImageClassification
>>> 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-base-patch16-224")
>>> model = ViTForImageClassification.from_pretrained("google/vit-base-patch16-224")
>>> 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])
Egyptian cat
TFViTModel
class transformers.TFViTModel
< 源代码 >( config: ViTConfig *inputs add_pooling_layer = True **kwargs )
参数
- config (ViTConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,只会加载配置。查看 from_pretrained() 方法来加载模型权重。
基本的 ViT 模型变压器,输出原始隐藏状态,没有任何特定的头部。
此模型继承自 TFPreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头等)。
此模型也是一个 keras.Model 子类。将它用作常规的 TF 2.0 Keras 模型,并参考 TF 2.0 文档以了解与一般使用和行为相关的所有事宜。
transformers
中的 TensorFlow 模型和层接受两种格式作为输入
- 将所有输入作为关键字参数(如 PyTorch 模型),或
- 将所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是,Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持,当使用 model.fit()
等方法时,事情应该“正常工作”——只需以 model.fit()
支持的任何格式传递你的输入和标签!但是,如果你想在 Keras 方法(如 fit()
和 predict()
)之外使用第二种格式,例如在使用 Keras Functional
API 创建你自己的层或模型时,你可以使用三种可能性来收集第一个位置参数中的所有输入张量
- 一个包含
pixel_values
的单一张量,没有其他任何东西:model(pixel_values)
- 一个包含一个或多个输入张量的可变长度列表,按照文档字符串中给出的顺序:
model([pixel_values, attention_mask])
或model([pixel_values, attention_mask, token_type_ids])
- 一个字典,其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量:
model({"pixel_values": pixel_values, "token_type_ids": token_type_ids})
请注意,当使用 子类化 创建模型和层时,你无需担心这些问题,因为你可以像传递给任何其他 Python 函数一样传递输入!
调用
< 源代码 > ( pixel_values: TFModelInputType | None = None head_mask: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None interpolate_pos_encoding: Optional[bool] = None return_dict: Optional[bool] = None training: bool = False ) → transformers.modeling_tf_outputs.TFBaseModelOutputWithPooling 或 tuple(tf.Tensor)
参数
- pixel_values (
np.ndarray
,tf.Tensor
,List[tf.Tensor]
`Dict[str, tf.Tensor]
或Dict[str, np.ndarray]
且每个示例必须具有形状(batch_size, num_channels, height, width)
) — 像素值。像素值可使用 AutoImageProcessor 获取。有关详细信息,请参阅 ViTImageProcessor.call()。 - head_mask (
np.ndarray
或tf.Tensor
形状为(num_heads,)
或(num_layers, num_heads)
, 可选) — 用于将自注意力模块的选定头归零的掩码。掩码值选择在[0, 1]
中:- 1 表示头未被掩码,
- 0 表示头被掩码。
- output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量中的attentions
。此参数仅能在急切模式下使用,在图模式下,将使用配置中的值。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量中的hidden_states
。此参数仅能在急切模式下使用,在图模式下,将使用配置中的值。 - interpolate_pos_encoding (
bool
, 可选) — 是否插值预训练的位置编码。 - return_dict (
bool
, 可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。此参数可以在急切模式下使用,在图模式下,该值将始终设置为 True。 - training (
bool
, 可选,默认为 `False“) — 是否在训练模式下使用模型(某些模块,如 dropout 模块,在训练和评估之间的行为有所不同)。
返回
transformers.modeling_tf_outputs.TFBaseModelOutputWithPooling 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFBaseModelOutputWithPooling 或一个 tf.Tensor
元组(如果传递了 return_dict=False
或当 config.return_dict=False
时),包含取决于配置 (ViTConfig) 和输入的各种元素。
-
last_hidden_state (
tf.Tensor
形状为(batch_size, sequence_length, hidden_size)
) — 模型最后一层的输出处的隐藏状态序列。 -
pooler_output (
tf.Tensor
形状为(batch_size, hidden_size)
) — 序列第一个标记(分类标记)的最后一层隐藏状态,经线性层和 Tanh 激活函数进一步处理。线性层权重在预训练期间从下一个句子预测(分类)目标中训练得到。此输出通常不是输入语义内容的良好摘要,通常最好对整个输入序列的隐藏状态序列进行平均或池化。
-
hidden_states (
tuple(tf.Tensor)
, 可选,当传递output_hidden_states=True
或config.output_hidden_states=True
时返回) —tf.Tensor
元组(一个用于嵌入的输出,一个用于每一层的输出),形状为(batch_size, sequence_length, hidden_size)
。模型在每一层输出处的隐藏状态,加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor)
, 可选,当传递output_attentions=True
或config.output_attentions=True
时返回) —tf.Tensor
元组(每一层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。注意力 softmax 之后的注意力权重,用于计算自注意力头中的加权平均值。
TFViTModel 正向方法,覆盖了 __call__
特殊方法。
虽然正向传递的配方需要在这个函数中定义,但应该在之后调用 Module
实例,而不是这个函数,因为前者负责运行预处理和后处理步骤,而后者会默默地忽略它们。
示例
>>> from transformers import AutoImageProcessor, TFViTModel
>>> 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-base-patch16-224-in21k")
>>> model = TFViTModel.from_pretrained("google/vit-base-patch16-224-in21k")
>>> inputs = image_processor(image, return_tensors="tf")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_state
>>> list(last_hidden_states.shape)
[1, 197, 768]
TFViTForImageClassification
class transformers.TFViTForImageClassification
< 源代码 >( config: ViTConfig *inputs **kwargs )
参数
- config (ViTConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,只会加载配置。查看 from_pretrained() 方法来加载模型权重。
具有图像分类头的 ViT 模型变换器(在 [CLS] 令牌的最终隐藏状态之上有一个线性层),例如用于 ImageNet。
请注意,可以通过在模型的前向传播中将 interpolate_pos_encoding
设置为 True
,在比训练过的图像分辨率更高的图像上微调 ViT。这将把预训练的 位置嵌入插值到更高的分辨率。
此模型继承自 TFPreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头等)。
此模型也是一个 keras.Model 子类。将它用作常规的 TF 2.0 Keras 模型,并参考 TF 2.0 文档以了解与一般使用和行为相关的所有事宜。
transformers
中的 TensorFlow 模型和层接受两种格式作为输入
- 将所有输入作为关键字参数(如 PyTorch 模型),或
- 将所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是,Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持,当使用 model.fit()
等方法时,事情应该“正常工作”——只需以 model.fit()
支持的任何格式传递你的输入和标签!但是,如果你想在 Keras 方法(如 fit()
和 predict()
)之外使用第二种格式,例如在使用 Keras Functional
API 创建你自己的层或模型时,你可以使用三种可能性来收集第一个位置参数中的所有输入张量
- 一个包含
pixel_values
的单一张量,没有其他任何东西:model(pixel_values)
- 一个包含一个或多个输入张量的可变长度列表,按照文档字符串中给出的顺序:
model([pixel_values, attention_mask])
或model([pixel_values, attention_mask, token_type_ids])
- 一个字典,其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量:
model({"pixel_values": pixel_values, "token_type_ids": token_type_ids})
请注意,当使用 子类化 创建模型和层时,你无需担心这些问题,因为你可以像传递给任何其他 Python 函数一样传递输入!
调用
< source > ( pixel_values: TFModelInputType | None = None head_mask: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None interpolate_pos_encoding: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFSequenceClassifierOutput or tuple(tf.Tensor)
参数
- pixel_values (
np.ndarray
,tf.Tensor
,List[tf.Tensor]
`Dict[str, tf.Tensor]
或Dict[str, np.ndarray]
,每个样本的形状必须为(batch_size, num_channels, height, width)
) — 像素值。像素值可以使用 AutoImageProcessor 获取。有关详细信息,请参阅 ViTImageProcessor.call()。 - head_mask (形状为
(num_heads,)
或(num_layers, num_heads)
的np.ndarray
或tf.Tensor
,可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值在[0, 1]
中选择:- 1 表示头部 未掩码,
- 0 表示头部 已掩码。
- output_attentions (
bool
,可选) — 是否返回所有注意力层的注意力张量。有关详细信息,请参阅返回张量中的attentions
。此参数只能在急切模式下使用,在图形模式下,将使用配置中的值。 - output_hidden_states (
bool
,可选) — 是否返回所有层的隐藏状态。有关详细信息,请参阅返回张量中的hidden_states
。此参数只能在急切模式下使用,在图形模式下,将使用配置中的值。 - interpolate_pos_encoding (
bool
,可选) — 是否对预训练的位置编码进行插值。 - return_dict (
bool
,可选) — 是否返回 ModelOutput 而不是普通元组。此参数可以在急切模式下使用,在图形模式下,该值将始终设置为 True。 - training (
bool
,可选,默认值为 `False“) — 是否以训练模式使用模型(某些模块,如 dropout 模块,在训练和评估之间具有不同的行为)。 - labels (
tf.Tensor
或np.ndarray
形状为(batch_size,)
, 可选) — 用于计算图像分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]
中。如果config.num_labels == 1
,则计算回归损失(均方损失),如果config.num_labels > 1
,则计算分类损失(交叉熵)。
返回
transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或一个 tf.Tensor
元组(如果传递了 return_dict=False
或 config.return_dict=False
),包含取决于配置 (ViTConfig) 和输入的各种元素。
-
loss (
tf.Tensor
形状为(batch_size, )
, 可选, 在提供labels
时返回) — 分类(或如果 config.num_labels==1 则为回归)损失。 -
logits (
tf.Tensor
形状为(batch_size, config.num_labels)
) — 分类(或如果 config.num_labels==1 则为回归)分数(在 SoftMax 之前)。 -
hidden_states (
tuple(tf.Tensor)
, 可选,当传递output_hidden_states=True
或config.output_hidden_states=True
时返回) —tf.Tensor
元组(一个用于嵌入的输出,一个用于每一层的输出),形状为(batch_size, sequence_length, hidden_size)
。模型在每一层输出处的隐藏状态,加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor)
, 可选,当传递output_attentions=True
或config.output_attentions=True
时返回) —tf.Tensor
元组(每一层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。注意力 softmax 之后的注意力权重,用于计算自注意力头中的加权平均值。
The TFViTForImageClassification 前向方法,覆盖了 __call__
特殊方法。
虽然正向传递的配方需要在这个函数中定义,但应该在之后调用 Module
实例,而不是这个函数,因为前者负责运行预处理和后处理步骤,而后者会默默地忽略它们。
示例
>>> from transformers import AutoImageProcessor, TFViTForImageClassification
>>> import tensorflow as tf
>>> 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-base-patch16-224")
>>> model = TFViTForImageClassification.from_pretrained("google/vit-base-patch16-224")
>>> inputs = image_processor(image, return_tensors="tf")
>>> logits = model(**inputs).logits
>>> # model predicts one of the 1000 ImageNet classes
>>> predicted_label = int(tf.math.argmax(logits, axis=-1))
>>> print(model.config.id2label[predicted_label])
Egyptian cat
FlaxVitModel
class transformers.FlaxViTModel
< source >( config: ViTConfig input_shape = None seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
参数
- config (ViTConfig) — 模型配置类,包含模型的所有参数。用配置文件初始化不会加载与模型关联的权重,只会加载配置。查看 from_pretrained() 方法以加载模型权重。
- dtype (
jax.numpy.dtype
, 可选, 默认为jax.numpy.float32
) — 计算的数据类型。可以是jax.numpy.float32
、jax.numpy.float16
(在 GPU 上)和jax.numpy.bfloat16
(在 TPU 上)之一。这可以用来在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定,所有计算将使用给定的
dtype
进行。注意,这仅指定计算的 dtype,不会影响模型参数的 dtype。
基本的 ViT 模型变压器,输出原始隐藏状态,没有任何特定的头部。
此模型继承自 FlaxPreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法(例如,下载、保存和从 PyTorch 模型转换权重)
此模型也是 flax.linen.Module 子类。将其用作常规 Flax linen 模块,并参考 Flax 文档了解所有与一般用法和行为相关的事项。
最后,此模型支持固有的 JAX 特性,例如
__call__
< source > ( pixel_values params: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPooling 或 tuple(torch.FloatTensor)
返回
transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPooling 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPooling 或一个 torch.FloatTensor
元组(如果传递了 return_dict=False
或 config.return_dict=False
),包含取决于配置 (<class 'transformers.models.vit.configuration_vit.ViTConfig'>
) 和输入的各种元素。
-
last_hidden_state (
jnp.ndarray
形状为(batch_size, sequence_length, hidden_size)
) — 模型最后一层的输出处的隐藏状态序列。 -
pooler_output (
jnp.ndarray
形状为(batch_size, hidden_size)
) — 序列第一个标记(分类标记)的最后一层隐藏状态,通过线性层和 Tanh 激活函数进一步处理。线性层权重在预训练期间从下一个句子预测(分类)目标进行训练。 -
hidden_states (
tuple(jnp.ndarray)
, 可选,在传递output_hidden_states=True
或config.output_hidden_states=True
时返回) —jnp.ndarray
元组(一个用于嵌入的输出,一个用于每一层的输出),形状为(batch_size, sequence_length, hidden_size)
。模型在每一层输出处的隐藏状态,加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray)
, 可选,在传递output_attentions=True
或config.output_attentions=True
时返回) —jnp.ndarray
元组(每一层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。注意力 softmax 之后的注意力权重,用于计算自注意力头中的加权平均值。
FlaxViTPreTrainedModel
的 forward 方法覆盖了 __call__
特殊方法。
虽然正向传递的配方需要在这个函数中定义,但应该在之后调用 Module
实例,而不是这个函数,因为前者负责运行预处理和后处理步骤,而后者会默默地忽略它们。
示例
>>> from transformers import AutoImageProcessor, FlaxViTModel
>>> from PIL import Image
>>> import requests
>>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
>>> image = Image.open(requests.get(url, stream=True).raw)
>>> image_processor = AutoImageProcessor.from_pretrained("google/vit-base-patch16-224-in21k")
>>> model = FlaxViTModel.from_pretrained("google/vit-base-patch16-224-in21k")
>>> inputs = image_processor(images=image, return_tensors="np")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_state
FlaxViTForImageClassification
class transformers.FlaxViTForImageClassification
< 源代码 >( config: ViTConfig input_shape = None seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
参数
- config (ViTConfig) — 模型配置类,包含模型的所有参数。用配置文件初始化不会加载与模型相关的权重,只会加载配置。查看 from_pretrained() 方法来加载模型权重。
- dtype (
jax.numpy.dtype
, 可选,默认为jax.numpy.float32
) — 计算的数据类型。可以是jax.numpy.float32
、jax.numpy.float16
(在 GPU 上)和jax.numpy.bfloat16
(在 TPU 上)。这可用于启用混合精度训练或半精度推理,在 GPU 或 TPU 上。如果指定,所有计算将使用给定的
dtype
执行。注意,这仅指定计算的 dtype,不影响模型参数的 dtype。
具有图像分类头的 ViT 模型变换器(在 [CLS] 令牌的最终隐藏状态之上有一个线性层),例如用于 ImageNet。
此模型继承自 FlaxPreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法(例如,下载、保存和从 PyTorch 模型转换权重)
此模型也是 flax.linen.Module 子类。将其用作常规 Flax linen 模块,并参考 Flax 文档了解所有与一般用法和行为相关的事项。
最后,此模型支持固有的 JAX 特性,例如
__call__
< 源代码 > ( pixel_values params: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或 tuple(torch.FloatTensor)
返回
transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或 torch.FloatTensor
元组(如果传递了 return_dict=False
或 config.return_dict=False
),包含根据配置(<class 'transformers.models.vit.configuration_vit.ViTConfig'>
)和输入而不同的各种元素。
-
logits (
jnp.ndarray
形状为(batch_size, config.num_labels)
) — 分类(或回归,如果 config.num_labels==1)分数(在 SoftMax 之前)。 -
hidden_states (
tuple(jnp.ndarray)
, 可选,在传递output_hidden_states=True
或config.output_hidden_states=True
时返回) —jnp.ndarray
元组(一个用于嵌入的输出,一个用于每一层的输出),形状为(batch_size, sequence_length, hidden_size)
。模型在每一层输出处的隐藏状态,加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray)
, 可选,在传递output_attentions=True
或config.output_attentions=True
时返回) —jnp.ndarray
元组(每一层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。注意力 softmax 之后的注意力权重,用于计算自注意力头中的加权平均值。
FlaxViTPreTrainedModel
的 forward 方法覆盖了 __call__
特殊方法。
虽然正向传递的配方需要在这个函数中定义,但应该在之后调用 Module
实例,而不是这个函数,因为前者负责运行预处理和后处理步骤,而后者会默默地忽略它们。
示例
>>> from transformers import AutoImageProcessor, FlaxViTForImageClassification
>>> from PIL import Image
>>> import jax
>>> import requests
>>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
>>> image = Image.open(requests.get(url, stream=True).raw)
>>> image_processor = AutoImageProcessor.from_pretrained("google/vit-base-patch16-224")
>>> model = FlaxViTForImageClassification.from_pretrained("google/vit-base-patch16-224")
>>> inputs = image_processor(images=image, return_tensors="np")
>>> outputs = model(**inputs)
>>> logits = outputs.logits
>>> # model predicts one of the 1000 ImageNet classes
>>> predicted_class_idx = jax.numpy.argmax(logits, axis=-1)
>>> print("Predicted class:", model.config.id2label[predicted_class_idx.item()])