Neighborhood Attention Transformer

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

概述

NAT 由 Ali Hassani、Steven Walton、Jiachen Li、Shen Li 和 Humphrey Shi 在 Neighborhood Attention Transformer 中提出。

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

论文的摘要如下：

我们提出了 Neighborhood Attention (NA)，这是第一个用于视觉的高效且可扩展的滑动窗口注意力机制。 NA 是一种逐像素操作，将自注意力 (SA) 定位到最近的相邻像素，因此与 SA 的二次复杂度相比，具有线性时间和空间复杂度。滑动窗口模式允许 NA 的感受野增长，而无需额外的像素偏移，并保留了平移等变性，这与 Swin Transformer 的 Window Self Attention (WSA) 不同。我们开发了 NATTEN (Neighborhood Attention Extension)，这是一个包含高效 C++ 和 CUDA 内核的 Python 包，它允许 NA 的运行速度比 Swin 的 WSA 快 40%，同时使用的内存最多减少 25%。我们进一步提出了 Neighborhood Attention 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%。

Neighborhood Attention 与其他注意力模式的比较。摘自原始论文。

此模型由 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 对 Neighborhood Attention 的实现。您可以通过参考 shi-labs.com/natten，使用 Linux 的预构建 wheels 安装它，或者通过运行 pip install natten 在您的系统上构建。请注意，后者可能需要一些时间来编译。 NATTEN 尚不支持 Windows 设备。
目前仅支持 patch size 为 4。

资源

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

图像分类

NatForImageClassification 由此示例脚本和notebook 提供支持。
另请参阅：图像分类任务指南

如果您有兴趣提交资源以包含在此处，请随时打开 Pull Request，我们将对其进行审核！该资源最好展示一些新的东西，而不是重复现有资源。

NatConfig

class transformers.NatConfig

< source >

( 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) — 每个 patch 的大小（分辨率）。注意：目前仅支持 patch size 为 4。
num_channels (int, 可选, 默认为 3) — 输入通道数。
embed_dim (int, 可选, 默认为 64) — patch 嵌入的维度。
depths (List[int], 可选, 默认为 [3, 4, 6, 5]) — 编码器每个级别的层数。
num_heads (List[int], 可选, 默认为 [2, 4, 8, 16]) — Transformer 编码器中每层的注意力头数。
kernel_size (int, 可选, 默认为 7) — 邻域注意力（Neighborhood Attention）内核大小。
mlp_ratio (float, 可选, 默认为 3.0) — MLP 隐藏层维度与嵌入层维度的比率。
qkv_bias (bool, 可选, 默认为 True) — 是否向 queries, keys 和 values 添加可学习的偏置。
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，则默认为相应的阶段。如果未设置且未设置 out_indices，则默认为最后一个阶段。必须与 stage_names 属性中定义的顺序相同。
out_indices (List[int], 可选) — 如果用作骨干网络，则输出的特征索引列表。可以是 0, 1, 2 等（取决于模型有多少个阶段）。如果未设置且设置了 out_features，则默认为相应的阶段。如果未设置且未设置 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

class transformers.NatModel

< source >

( config add_pooling_layer = True )

参数

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

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

forward

< source >

( 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 (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor) — 模型最后一层的输出处的隐藏状态序列。
pooler_output (形状为 (batch_size, hidden_size) 的 torch.FloatTensor, 可选, 当传递 add_pooling_layer=True 时返回) — 最后一层隐藏状态的平均池化。
hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — 形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元组（每个嵌入输出 + 每个阶段的输出一个）。

模型在每个层输出处的隐藏状态加上初始嵌入输出。
attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元组（每个阶段一个）。

注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
reshaped_hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — 形状为 (batch_size, hidden_size, height, width) 的 torch.FloatTensor 元组（每个嵌入输出 + 每个阶段的输出一个）。

模型在每个层输出处的隐藏状态加上初始嵌入输出，并重塑为包含空间维度。

NatModel forward 方法，覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoImageProcessor, NatModel
>>> 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("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

class transformers.NatForImageClassification

< source >

( config )

参数

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

带有图像分类头的 Nat 模型 Transformer（在 [CLS] 标记的最终隐藏状态之上有一个线性层），例如用于 ImageNet。

此模型是 PyTorch torch.nn.Module 子类。像使用常规 PyTorch 模块一样使用它，并参阅 PyTorch 文档以了解与通用用法和行为相关的所有事项。

forward

< source >

( 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 or 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 (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 时返回) — 形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元组（每个嵌入输出 + 每个阶段的输出一个）。

模型在每个层输出处的隐藏状态加上初始嵌入输出。
attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元组（每个阶段一个）。

注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
reshaped_hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — 形状为 (batch_size, hidden_size, height, width) 的 torch.FloatTensor 元组（每个嵌入输出 + 每个阶段的输出一个）。

模型在每个层输出处的隐藏状态加上初始嵌入输出，并重塑为包含空间维度。

NatForImageClassification 前向方法，覆盖了 __call__ 特殊方法。

示例

>>> from transformers import AutoImageProcessor, NatForImageClassification
>>> 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("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 上更新

Transformers

Neighborhood Attention Transformer

概述

使用技巧

资源

NatConfig

class transformers.NatConfig

NatModel

class transformers.NatModel

forward

NatForImageClassification

class transformers.NatForImageClassification

forward