ViTMSN
概述
ViTMSN 模型由 Mahmoud Assran、Mathilde Caron、Ishan Misra、Piotr Bojanowski、Florian Bordes、Pascal Vincent、Armand Joulin、Michael Rabbat 和 Nicolas Ballas 在 Masked Siamese Networks for Label-Efficient Learning 中提出。该论文提出了一种联合嵌入架构，用于匹配掩码补丁的原型与未掩码补丁的原型。在这种设置下，他们的方法在少样本和极少样本情况下获得了优异的性能。
论文中的摘要如下：
我们提出了 Masked Siamese Networks (MSN)，这是一个用于学习图像表示的自监督学习框架。我们的方法将包含随机掩码补丁的图像视图的表示与原始未掩码图像的表示进行匹配。当应用于视觉Transformer时，这种自监督预训练策略特别可扩展，因为只有未掩码补丁由网络处理。因此，MSN 提高了联合嵌入架构的可扩展性，同时生成语义级别高的表示，在少样本图像分类方面具有竞争力。例如，在 ImageNet-1K 上，仅使用 5,000 个标注图像，我们的基础 MSN 模型就获得了 72.4% 的 top-1 准确率，而使用 1% 的 ImageNet-1K 标签，我们获得了 75.7% 的 top-1 准确率，为该基准的自监督学习树立了新的最先进水平。
MSN 架构。摘自 原始论文。该模型由 sayakpaul 贡献。原始代码可以在这里找到 here.
使用技巧
- MSN（掩码孪生网络）是一种用于视觉Transformer（ViTs）自监督预训练的方法。预训练目标是将分配给图像未掩码视图的原型与相同图像的掩码视图的原型进行匹配。
- 作者只发布了主干网络的预训练权重（ImageNet-1k 预训练）。因此，要将它用于您自己的图像分类数据集，请使用 ViTMSNForImageClassification 类，它从 ViTMSNModel 初始化。遵循 这个笔记本，了解有关微调的详细教程。
- MSN 在少样本和极少样本情况下特别有用。值得注意的是，在微调时，它仅使用 1% 的 ImageNet-1K 标签就获得了 75.7% 的 top-1 准确率。
使用缩放点积注意力（SDPA）
PyTorch 包含一个原生缩放点积注意力（SDPA）运算符，作为 torch.nn.functional 的一部分。此函数包含多种实现，可根据输入和使用的硬件应用。请参阅 官方文档 或 GPU 推理 页面以了解更多信息。
当实现可用时，SDPA 默认用于 torch>=2.1.1，但您也可以在 from_pretrained() 中设置 attn_implementation="sdpa" 以显式请求使用 SDPA。
from transformers import ViTMSNForImageClassification
model = ViTMSNForImageClassification.from_pretrained("facebook/vit-msn-base", attn_implementation="sdpa", torch_dtype=torch.float16)
...为了获得最佳加速效果，我们建议以半精度加载模型（例如 torch.float16 或 torch.bfloat16）。
在本地基准测试（A100-40GB、PyTorch 2.3.0、操作系统 Ubuntu 22.04）中，使用 float32 和 facebook/vit-msn-base 模型，我们在推理期间看到了以下加速效果。
| 批次大小 | 平均推理时间（毫秒），急切模式 | 平均推理时间（毫秒），sdpa 模型 | 加速效果，Sdpa / 急切（x） |
|---|---|---|---|
| 1 | 7 | 6 | 1.17 |
| 2 | 8 | 6 | 1.33 |
| 4 | 8 | 6 | 1.33 |
| 8 | 8 | 6 | 1.33 |
资源
一个包含官方 Hugging Face 和社区（由 🌎 指示）资源的列表，可帮助您开始使用 ViT MSN。
- ViTMSNForImageClassification 由此 示例脚本 和 笔记本 支持。
- 另请参阅：图像分类任务指南
如果您有兴趣提交要包含在此处的资源，请随时打开 Pull Request，我们将对其进行审核！理想情况下，该资源应该展示一些新内容，而不是重复现有的资源。
ViTMSNConfig
class transformers.ViTMSNConfig
< 源代码 >( 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 image_size = 224 patch_size = 16 num_channels = 3 qkv_bias = True **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) — 初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float, 可选, 默认为 1e-06) — 层归一化层使用的 epsilon。 - image_size (
int, 可选, 默认为 224) — 每个图像的大小（分辨率）。 - patch_size (
int, 可选, 默认为 16) — 每个 patch 的大小（分辨率）。 - num_channels (
int, 可选, 默认为 3) — 输入通道数。 - qkv_bias (
bool, 可选, 默认为True) — 是否为查询、键和值添加偏置。
这是一个配置类，用于存储 ViTMSNModel 的配置。它用于根据指定的参数实例化 ViT MSN 模型，定义模型架构。使用默认值实例化配置将生成与 ViT facebook/vit_msn_base 架构类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。有关更多信息，请阅读 PretrainedConfig 的文档。
示例
>>> from transformers import ViTMSNModel, ViTMSNConfig
>>> # Initializing a ViT MSN vit-msn-base style configuration
>>> configuration = ViTConfig()
>>> # Initializing a model from the vit-msn-base style configuration
>>> model = ViTMSNModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configViTMSNModel
class transformers.ViTMSNModel
< 源代码 >( config: ViTMSNConfig use_mask_token: bool = False )
参数
- config (ViTMSNConfig) — 模型配置类，包含模型的所有参数。使用配置文件进行初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
ViTMSN 模型的裸模型，输出原始隐藏状态，没有任何特定的头部。此模型是 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.BaseModelOutput or tuple(torch.FloatTensor)
参数
- pixel_values (
torch.FloatTensor形状为(batch_size, num_channels, height, width)) — 像素值。可以使用 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.BaseModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置 (ViTMSNConfig) 和输入的各种元素。
-
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 之后的注意力权重，用于计算自注意力头中的加权平均值。
该 ViTMSNModel 前向方法覆盖了 __call__ 特殊方法。
虽然前向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoImageProcessor, ViTMSNModel
>>> 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("facebook/vit-msn-small")
>>> model = ViTMSNModel.from_pretrained("facebook/vit-msn-small")
>>> inputs = image_processor(images=image, return_tensors="pt")
>>> with torch.no_grad():
... outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateViTMSNForImageClassification
class transformers.ViTMSNForImageClassification
< 源代码 >( config: ViTMSNConfig )
参数
- config (ViTMSNConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
顶部带有图像分类头的 ViTMSN 模型，例如用于 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 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 而不是一个简单的元组。
返回值
transformers.modeling_outputs.ImageClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.ImageClassifierOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置 (ViTMSNConfig) 和输入而不同的各种元素。
-
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 ViTMSNForImageClassification 正向方法，覆盖了 __call__ 特殊方法。
虽然前向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoImageProcessor, ViTMSNForImageClassification
>>> import torch
>>> from PIL import Image
>>> import requests
>>> torch.manual_seed(2)
>>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
>>> image = Image.open(requests.get(url, stream=True).raw)
>>> image_processor = AutoImageProcessor.from_pretrained("facebook/vit-msn-small")
>>> model = ViTMSNForImageClassification.from_pretrained("facebook/vit-msn-small")
>>> inputs = image_processor(images=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])
tusker