Hugging Face 的 LOGO

Transformers 文档

邻域注意力Transformer

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

邻域注意力Transformer

PyTorch

该模型目前处于维护模式，我们不接受任何更改其代码的新PR。如果您在使用此模型时遇到任何问题，请重新安装支持此模型的最后一个版本：v4.40.2。您可以通过运行以下命令进行安装：pip install -U transformers==4.40.2。

概述

NAT是由Ali Hassani、Steven Walton、Jiachen Li、Shen Li和Humphrey Shi在邻域注意力Transformer中提出的。

它是一种基于邻域注意力（一种滑动窗口自注意力模式）的层级视觉Transformer。

论文摘要如下：

我们提出了邻域注意力（NA），这是第一个用于视觉的高效可扩展滑动窗口注意力机制。NA是一种像素级操作，将自注意力（SA）定位到最近的相邻像素，因此与SA的二次复杂度相比，它具有线性时间和空间复杂度。滑动窗口模式使得NA的感受野可以增长而无需额外的像素移位，并且与Swin Transformer的窗口自注意力（WSA）不同，它保留了平移等变性。我们开发了NATTEN（邻域注意力扩展），一个带有高效C++和CUDA内核的Python包，它使得NA比Swin的WSA运行速度快40%，同时内存使用量减少25%。我们进一步提出了邻域注意力Transformer（NAT），一种基于NA的新型分层Transformer设计，可提升图像分类和下游视觉性能。NAT的实验结果具有竞争力；NAT-Tiny在ImageNet上达到83.2%的top-1准确率，在MS-COCO上达到51.4%的mAP，在ADE20K上达到48.4%的mIoU，与类似大小的Swin模型相比，ImageNet准确率提高了1.9%，COCO mAP提高了1.0%，ADE20K mIoU提高了2.6%。

drawing 邻域注意力与其他注意力模式的比较。摘自原始论文。

此模型由Ali Hassani贡献。原始代码可在此处找到。

使用技巧

  • 可以使用AutoImageProcessor API来准备模型所需的图像。
  • NAT可用作骨干网络。当output_hidden_states = True时，它将同时输出hidden_states和reshaped_hidden_states。reshaped_hidden_states的形状为(batch, num_channels, height, width)，而不是(batch_size, height, width, num_channels)。

备注

  • NAT依赖于NATTEN的邻域注意力实现。您可以通过参考shi-labs.com/natten安装预构建的Linux轮子，或者通过运行pip install natten在您的系统上构建。请注意，后者可能需要时间进行编译。NATTEN尚不支持Windows设备。
  • 目前仅支持补丁大小为4。

资源

Hugging Face官方和社区（🌎表示）资源列表，帮助您开始使用NAT。

图像分类

如果您有兴趣在此处提交资源，请随时开启 Pull Request，我们将对其进行审查！该资源最好能展示一些新内容，而不是重复现有资源。

NatConfig

类 transformers.NatConfig

< >

( patch_size = 4 num_channels = 3 embed_dim = 64 depths = [3, 4, 6, 5] num_heads = [2, 4, 8, 16] kernel_size = 7 mlp_ratio = 3.0 qkv_bias = True hidden_dropout_prob = 0.0 attention_probs_dropout_prob = 0.0 drop_path_rate = 0.1 hidden_act = 'gelu' initializer_range = 0.02 layer_norm_eps = 1e-05 layer_scale_init_value = 0.0 out_features = None out_indices = None **kwargs )

参数

  • patch_size (int, 可选, 默认为4) — 每个补丁的大小（分辨率）。注意：目前仅支持补丁大小为4。
  • num_channels (int, 可选, 默认为3) — 输入通道数。
  • embed_dim (int, 可选, 默认为64) — 补丁嵌入的维度。
  • depths (list[int], 可选, 默认为[3, 4, 6, 5]) — 编码器每个级别的层数。
  • num_heads (list[int], 可选, 默认为[2, 4, 8, 16]) — Transformer编码器每层中的注意力头数。
  • kernel_size (int, 可选, 默认为7) — 邻域注意力核大小。
  • mlp_ratio (float, 可选, 默认为3.0) — MLP隐藏维度与嵌入维度的比率。
  • qkv_bias (bool, 可选, 默认为True) — 是否应为查询、键和值添加可学习的偏差。
  • hidden_dropout_prob (float, 可选, 默认为0.0) — 嵌入和编码器中所有全连接层的dropout概率。
  • attention_probs_dropout_prob (float, 可选, 默认为0.0) — 注意力概率的dropout比率。
  • drop_path_rate (float, 可选, 默认为0.1) — 随机深度率。
  • hidden_act (str 或 function, 可选, 默认为"gelu") — 编码器中的非线性激活函数（函数或字符串）。如果是字符串，支持"gelu"、"relu"、"selu"和"gelu_new"。
  • initializer_range (float, 可选, 默认为0.02) — 用于初始化所有权重矩阵的truncated_normal_initializer的标准偏差。
  • layer_norm_eps (float, 可选, 默认为1e-05) — 层归一化层使用的epsilon。
  • layer_scale_init_value (float, 可选, 默认为0.0) — 层缩放的初始值。如果小于等于0则禁用。
  • out_features (list[str], 可选) — 如果用作骨干网络，输出特征的列表。可以是"stem"、"stage1"、"stage2"等（取决于模型有多少个阶段）。如果未设置且out_indices已设置，则默认为相应的阶段。如果两者都未设置，则默认为最后一个阶段。必须与stage_names属性中定义的顺序相同。
  • out_indices (list[int], 可选) — 如果用作骨干网络，输出特征的索引列表。可以是0、1、2等（取决于模型有多少个阶段）。如果未设置且out_features已设置，则默认为相应的阶段。如果两者都未设置，则默认为最后一个阶段。必须与stage_names属性中定义的顺序相同。

这是用于存储NatModel配置的配置类。它用于根据指定的参数实例化一个Nat模型，定义模型架构。使用默认值实例化配置将生成与Nat shi-labs/nat-mini-in1k-224架构类似的配置。

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

示例

>>> from transformers import NatConfig, NatModel

>>> # Initializing a Nat shi-labs/nat-mini-in1k-224 style configuration
>>> configuration = NatConfig()

>>> # Initializing a model (with random weights) from the shi-labs/nat-mini-in1k-224 style configuration
>>> model = NatModel(configuration)

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

NatModel

类 transformers.NatModel

< >

( config add_pooling_layer = True )

参数

  • config (NatConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只加载配置。请查阅from_pretrained()方法加载模型权重。

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

正向传播

< >

( pixel_values: typing.Optional[torch.FloatTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.deprecated.nat.modeling_nat.NatModelOutput 或 tuple(torch.FloatTensor)

参数

  • pixel_values (形状为(batch_size, num_channels, height, width)的torch.FloatTensor) — 像素值。像素值可以使用AutoImageProcessor获取。有关详细信息，请参见ViTImageProcessor.call()。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参见返回张量下的attentions。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参见返回张量下的hidden_states。
  • return_dict (bool, 可选) — 是否返回ModelOutput而不是普通元组。

返回

transformers.models.deprecated.nat.modeling_nat.NatModelOutput 或 tuple(torch.FloatTensor)

一个transformers.models.deprecated.nat.modeling_nat.NatModelOutput或一个torch.FloatTensor元组（如果传入return_dict=False或config.return_dict=False），包含根据配置（NatConfig）和输入而变化的不同元素。

  • last_hidden_state (torch.FloatTensor, 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。

  • pooler_output (torch.FloatTensor，形状为 (batch_size, hidden_size)，可选，当传递 add_pooling_layer=True 时返回) — 最后一层隐藏状态的平均池化。

  • 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 后的注意力权重，用于计算自注意力头中的加权平均值。

  • reshaped_hidden_states (tuple(torch.FloatTensor), 可选, 当传入output_hidden_states=True或config.output_hidden_states=True时返回) — torch.FloatTensor元组（一个用于嵌入输出 + 每个阶段的输出），形状为(batch_size, hidden_size, height, width)。

    模型在每层输出处的隐藏状态，以及重新调整以包含空间维度的初始嵌入输出。

NatModel正向传播方法，重写了__call__特殊方法。

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

示例

>>> from transformers import AutoImageProcessor, NatModel
>>> import torch
>>> from datasets import load_dataset

>>> dataset = load_dataset("huggingface/cats-image")
>>> image = dataset["test"]["image"][0]

>>> image_processor = AutoImageProcessor.from_pretrained("shi-labs/nat-mini-in1k-224")
>>> model = NatModel.from_pretrained("shi-labs/nat-mini-in1k-224")

>>> 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, 7, 7, 512]

NatForImageClassification

类 transformers.NatForImageClassification

< >

( config )

参数

  • config (NatConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只加载配置。请查阅from_pretrained()方法加载模型权重。

Nat模型Transformer，顶部带有图像分类头（[CLS] token最终隐藏状态上方的线性层），例如用于ImageNet。

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

正向传播

< >

( pixel_values: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.deprecated.nat.modeling_nat.NatImageClassifierOutput 或 tuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor，形状为 (batch_size, num_channels, height, width)) — 像素值。像素值可以使用 AutoImageProcessor 获取。详细信息请参阅 ViTImageProcessor.call()。
  • 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.models.deprecated.nat.modeling_nat.NatImageClassifierOutput 或 tuple(torch.FloatTensor)

一个 transformers.models.deprecated.nat.modeling_nat.NatImageClassifierOutput 或一个 torch.FloatTensor 的元组（如果传入 return_dict=False 或 config.return_dict=False），包含根据配置（NatConfig）和输入的不同元素。

  • 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, sequence_length, sequence_length)。

    注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。

  • reshaped_hidden_states (tuple(torch.FloatTensor), 可选, 当传入output_hidden_states=True或config.output_hidden_states=True时返回) — torch.FloatTensor元组（一个用于嵌入输出 + 每个阶段的输出），形状为(batch_size, hidden_size, height, width)。

    模型在每层输出处的隐藏状态，以及重新调整以包含空间维度的初始嵌入输出。

NatForImageClassification 的前向方法，重写了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoImageProcessor, NatForImageClassification
>>> import torch
>>> from datasets import load_dataset

>>> dataset = load_dataset("huggingface/cats-image")
>>> image = dataset["test"]["image"][0]

>>> image_processor = AutoImageProcessor.from_pretrained("shi-labs/nat-mini-in1k-224")
>>> model = NatForImageClassification.from_pretrained("shi-labs/nat-mini-in1k-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])
tiger cat
< > 在 GitHub 上更新

←MobileViTV2 PoolFormer→