Transformers 文档

带有寄存器的 DINOv2

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

带有寄存器的 DINOv2

PyTorch FlashAttention SDPA

概述

带有寄存器的 DINOv2 模型由 Timothée Darcet、Maxime Oquab、Julien Mairal、Piotr Bojanowski 在 Vision Transformers Need Registers 中提出。

Vision Transformer (ViT) 是一种 Transformer 编码器模型(类似于 BERT),最初引入用于在 ImageNet 上进行监督图像分类。

接下来,人们找到了使 ViT 在自监督图像特征提取(即学习有意义的特征,也称为嵌入)方面表现出色的方法,无需任何标签。 这方面的一些示例论文包括 DINOv2MAE

DINOv2 的作者注意到 ViT 在注意力图中存在伪影。 这是由于模型使用一些图像块作为“寄存器”。 作者提出了一个修复方案:只需添加一些新的 tokens(称为“寄存器” tokens),这些 tokens 仅在预训练期间使用(之后丢弃)。 这导致

  • 没有伪影
  • 可解释的注意力图
  • 以及改进的性能。

该论文的摘要如下

Transformer 最近成为学习视觉表征的强大工具。 在本文中,我们识别并描述了监督和自监督 ViT 网络的特征图中的伪影。 这些伪影对应于在推理期间主要出现在图像低信息背景区域中的高范数 tokens,这些 tokens 被重新用于内部计算。 我们提出了一种简单而有效的解决方案,即向 Vision Transformer 的输入序列提供额外的 tokens 以填充该角色。 我们表明,该解决方案完全解决了监督和自监督模型的问题,为密集视觉预测任务上的自监督视觉模型设定了新的技术水平,使具有更大模型的对象发现方法成为可能,最重要的是,它为下游视觉处理带来了更平滑的特征图和注意力图。

drawing 使用和不使用寄存器训练的各种模型的注意力图可视化。 摘自原始论文

提示

  • 带有寄存器的 DINOv2 的用法与不带寄存器的 DINOv2 相同,您只会获得更好的性能。

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

Dinov2WithRegistersConfig

class transformers.Dinov2WithRegistersConfig

< >

( hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 mlp_ratio = 4 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 layerscale_value = 1.0 drop_path_rate = 0.0 use_swiglu_ffn = False num_register_tokens = 4 out_features = None out_indices = None apply_layernorm = True reshape_hidden_states = True **kwargs )

参数

  • hidden_size (int, 可选, 默认为 768) — 编码器层和池化器层的维度。
  • num_hidden_layers (int, 可选, 默认为 12) — Transformer 编码器中隐藏层的数量。
  • num_attention_heads (int, 可选, 默认为 12) — Transformer 编码器中每个注意力层的注意力头数。
  • mlp_ratio (int, 可选, 默认为 4) — MLP 的隐藏层大小相对于 hidden_size 的比率。
  • hidden_act (strfunction, 可选, 默认为 "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) — layer normalization 层使用的 epsilon 值。
  • image_size (int, 可选, 默认为 224) — 每张图片的大小(分辨率)。
  • patch_size (int, 可选, 默认为 16) — 每个 patch 的大小(分辨率)。
  • num_channels (int, optional, defaults to 3) — 输入通道的数量。
  • qkv_bias (bool, optional, defaults to True) — 是否向 queries, keys 和 values 添加偏置。
  • layerscale_value (float, optional, defaults to 1.0) — 用于层缩放的初始值。
  • drop_path_rate (float, optional, defaults to 0.0) — 每个样本的随机深度比率(当应用于残差层的主路径中时)。
  • use_swiglu_ffn (bool, optional, defaults to False) — 是否使用 SwiGLU 前馈神经网络。
  • num_register_tokens (int, optional, defaults to 4) — 要使用的寄存器令牌的数量。
  • out_features (List[str], optional) — 如果用作骨干网络,则输出的特征列表。可以是 "stem", "stage1", "stage2" 等中的任何一个(取决于模型有多少个阶段)。如果未设置且 out_indices 已设置,则默认为相应的阶段。如果未设置且 out_indices 也未设置,则默认为最后一个阶段。必须与 stage_names 属性中定义的顺序相同。
  • out_indices (List[int], optional) — 如果用作骨干网络,则输出的特征索引列表。可以是 0, 1, 2 等中的任何一个(取决于模型有多少个阶段)。如果未设置且 out_features 已设置,则默认为相应的阶段。如果未设置且 out_features 也未设置,则默认为最后一个阶段。必须与 stage_names 属性中定义的顺序相同。
  • apply_layernorm (bool, optional, defaults to True) — 如果模型用作骨干网络,是否对特征图应用层归一化。
  • reshape_hidden_states (bool, optional, defaults to True) — 如果模型用作骨干网络,是否将特征图重塑为形状为 (batch_size, hidden_size, height, width) 的 4D 张量。如果为 False,则特征图将是形状为 (batch_size, seq_len, hidden_size) 的 3D 张量。

这是用于存储 Dinov2WithRegistersModel 配置的配置类。它用于根据指定的参数实例化 Dinov2WithRegisters 模型,定义模型架构。使用默认值实例化配置将产生与带有寄存器的 DINOv2 facebook/dinov2-with-registers-base 架构类似的配置。

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

示例

>>> from transformers import Dinov2WithRegistersConfig, Dinov2WithRegistersModel

>>> # Initializing a Dinov2WithRegisters base style configuration
>>> configuration = Dinov2WithRegistersConfig()

>>> # Initializing a model (with random weights) from the base style configuration
>>> model = Dinov2WithRegistersModel(configuration)

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

Dinov2WithRegistersModel

class transformers.Dinov2WithRegistersModel

< >

( config: Dinov2WithRegistersConfig )

参数

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

裸机 Dinov2WithRegisters 模型 Transformer,输出原始隐藏状态,顶部没有任何特定的 head。此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参阅 PyTorch 文档以了解所有与常规用法和行为相关的事项。

forward

< >

( pixel_values: typing.Optional[torch.Tensor] = None bool_masked_pos: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) transformers.modeling_outputs.BaseModelOutputWithPoolingtuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor, 形状为 (batch_size, num_channels, height, width)) — 像素值。像素值可以使用 AutoImageProcessor 获得。有关详细信息,请参阅 BitImageProcessor.preprocess()
  • bool_masked_pos (torch.BoolTensor, 形状为 (batch_size, sequence_length)) — 布尔掩码位置。指示哪些补丁被掩码 (1) 以及哪些没有 (0)。仅与预训练相关。
  • head_mask (torch.FloatTensor, 形状为 (num_heads,)(num_layers, num_heads), optional) — 用于使自注意力模块的选定 head 失效的掩码。在 [0, 1] 中选择的掩码值:

    • 1 表示 head 未被掩码
    • 0 表示 head 被掩码
  • output_attentions (bool, optional) — 是否返回所有注意力层的 attentions 张量。 有关更多详细信息,请参见返回的张量下的 attentions
  • output_hidden_states (bool, optional) — 是否返回所有层的 hidden states。 有关更多详细信息,请参见返回的张量下的 hidden_states
  • return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通元组。

返回值

transformers.modeling_outputs.BaseModelOutputWithPoolingtuple(torch.FloatTensor)

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

  • 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), optional, 当传递了 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 元组(如果模型具有嵌入层,则为嵌入的输出 + 每个层的输出一个),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的 Hidden-states 加上可选的初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), optional, 当传递了 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组(每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    注意力 softmax 之后的 Attention weights,用于计算自注意力 head 中的加权平均值。

Dinov2WithRegistersModel forward 方法,覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoImageProcessor, Dinov2WithRegistersModel
>>> 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("facebook/dinov2_with_registers-base")
>>> model = Dinov2WithRegistersModel.from_pretrained("facebook/dinov2_with_registers-base")

>>> 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, 257, 768]

Dinov2WithRegistersForImageClassification

class transformers.Dinov2WithRegistersForImageClassification

< >

( config: Dinov2WithRegistersConfig )

参数

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

Dinov2WithRegisters 模型 Transformer,顶部带有一个图像分类头([CLS] token 的最终隐藏状态之上的线性层),例如用于 ImageNet。

此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参阅 PyTorch 文档以了解与常规用法和行为相关的所有事项。

forward

< >

( 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 return_dict: typing.Optional[bool] = None ) transformers.modeling_outputs.ImageClassifierOutputtuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor,形状为 (batch_size, num_channels, height, width)) — 像素值。像素值可以使用 AutoImageProcessor 获得。 有关详细信息,请参阅 BitImageProcessor.preprocess()
  • 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.ImageClassifierOutput 或一个 torch.FloatTensor 元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含各种元素,具体取决于配置 (Dinov2WithRegistersConfig) 和输入。

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

Dinov2WithRegistersForImageClassification forward 方法,覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoImageProcessor, Dinov2WithRegistersForImageClassification
>>> 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("facebook/dinov2_with_registers-small-imagenet1k-1-layer")
>>> model = Dinov2WithRegistersForImageClassification.from_pretrained("facebook/dinov2_with_registers-small-imagenet1k-1-layer")

>>> 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
< > 在 GitHub 上更新