Hugging Face 的徽标

Transformers 文档

FocalNet

Hugging Face's logo
加入 Hugging Face 社区

并获得增强文档体验的权限

开始使用

FocalNet

概述

FocalNet 模型由 Jianwei Yang、Chunyuan Li、Xiyang Dai、Lu Yuan 和 Jianfeng Gao 在Focal Modulation Networks 中提出。FocalNet 完全取代了自注意力机制（用于 ViT 和 Swin 等模型中），采用焦点调制机制对视觉中的标记交互进行建模。作者声称，在图像分类、目标检测和分割任务中，FocalNet 的性能优于具有相似计算成本的自注意力模型。

论文摘要如下：

我们提出了焦点调制网络（简称 FocalNet），其中自注意力（SA）完全被焦点调制机制所取代，用于对视觉中的标记交互进行建模。焦点调制包括三个组成部分：(i) 使用一堆深度卷积层实现的层次化上下文，用于编码从短距离到长距离的视觉上下文，(ii) 基于每个查询标记的内容选择性地收集上下文的门控聚合，以及 (iii) 将聚合的上下文注入查询的元素级调制或仿射变换。大量实验表明，在图像分类、目标检测和分割任务中，FocalNet 的性能优于具有相似计算成本的最先进的 SA 模型（例如 Swin 和 Focal Transformer）。具体来说，微型和基本尺寸的 FocalNet 在 ImageNet-1K 上分别实现了 82.3% 和 83.9% 的 top-1 准确率。在 ImageNet-22K 上以 224 分辨率进行预训练后，当以 224 和 384 分辨率进行微调时，它分别获得了 86.5% 和 87.3% 的 top-1 准确率。当迁移到下游任务时，FocalNet 表现出明显的优势。对于使用 Mask R-CNN 进行的目标检测，以 1 倍时间表训练的 FocalNet 基础模型比 Swin 模型高出 2.1 个百分点，并且已经超过了以 3 倍时间表训练的 Swin 模型（49.0 对 48.5）。对于使用 UPerNet 进行的语义分割，单尺度 FocalNet 基础模型比 Swin 模型高出 2.4 个百分点，并且在多尺度上也优于 Swin 模型（50.5 对 49.7）。使用大型 FocalNet 和 Mask2former，我们在 ADE20K 语义分割上实现了 58.5 mIoU，在 COCO 全景分割上实现了 57.9 PQ。使用巨型 FocalNet 和 DINO，我们在 COCO minival 和 test-dev 上分别实现了 64.3 和 64.4 mAP，在 Swinv2-G 和 BEIT-3 等更大的注意力模型的基础上，建立了新的 SOTA。

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

FocalNetConfig

类 transformers.FocalNetConfig

< >

( image_size = 224 patch_size = 4 num_channels = 3 embed_dim = 96 use_conv_embed = False hidden_sizes = [192, 384, 768, 768] depths = [2, 2, 6, 2] focal_levels = [2, 2, 2, 2] focal_windows = [3, 3, 3, 3] hidden_act = 'gelu' mlp_ratio = 4.0 hidden_dropout_prob = 0.0 drop_path_rate = 0.1 use_layerscale = False layerscale_value = 0.0001 use_post_layernorm = False use_post_layernorm_in_modulation = False normalize_modulator = False initializer_range = 0.02 layer_norm_eps = 1e-05 encoder_stride = 32 out_features = None out_indices = None **kwargs )

参数

  • image_size (int, 可选, 默认值: 224) — 每张图片的大小（分辨率）。
  • patch_size (int, 可选, 默认值: 4) — 嵌入层中每个补丁的大小（分辨率）。
  • num_channels (int, 可选, 默认值: 3) — 输入通道的数量。
  • embed_dim (int, 可选, 默认值: 96) — 补丁嵌入的维度。
  • use_conv_embed (bool, *可选*, 默认值: False) — 是否使用卷积嵌入。作者指出，使用卷积嵌入通常可以提高性能，但默认情况下不使用。
  • hidden_sizes (List[int], *可选*, 默认值: [192, 384, 768, 768]) — 每个阶段的维度 (隐藏大小)。
  • depths (list(int), *可选*, 默认值: [2, 2, 6, 2]) — 编码器中每个阶段的深度 (层数)。
  • focal_levels (list(int), *可选*, 默认值: [2, 2, 2, 2]) — 编码器中各个阶段各层的焦点级别数。
  • focal_windows (list(int), *可选*, 默认值: [3, 3, 3, 3]) — 编码器中各个阶段各层的焦点窗口大小。
  • hidden_act (str 或 function, *可选*, 默认值: "gelu") — 编码器中的非线性激活函数 (函数或字符串)。如果是字符串，则支持 "gelu"、"relu"、"selu" 和 "gelu_new"。
  • mlp_ratio (float, *可选*, 默认值: 4.0) — MLP 隐藏维度与嵌入维度的比率。
  • hidden_dropout_prob (float, *可选*, 默认值: 0.0) — 嵌入和编码器中所有全连接层的 dropout 概率。
  • drop_path_rate (float, *可选*, 默认值为 0.1) — 随机深度比率。
  • use_layerscale (bool, *可选*, 默认值为 False) — 是否在编码器中使用层级缩放。
  • layerscale_value (float, *可选*, 默认值为 0.0001) — 层级缩放的初始值。
  • use_post_layernorm (bool, *可选*, 默认值为 False) — 是否在编码器中使用后层归一化。
  • use_post_layernorm_in_modulation (bool, *可选*, 默认值为 False) — 是否在调制层中使用后层归一化。
  • normalize_modulator (bool, *可选*, 默认值为 False) — 是否对调制器进行归一化。
  • initializer_range (float, *可选*, 默认值为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
  • layer_norm_eps (float, *可选*, 默认值为 1e-05) — 层归一化层使用的 epsilon。
  • encoder_stride (int, 可选, 默认值为 32) — 用于在掩码图像建模的解码器头部增加空间分辨率的因子。
  • 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 属性中定义的顺序相同。

这是用于存储 FocalNetModel 配置的配置类。它用于根据指定的参数实例化 FocalNet 模型，定义模型架构。使用默认值实例化配置将产生与 FocalNet microsoft/focalnet-tiny 架构类似的配置。

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

示例

>>> from transformers import FocalNetConfig, FocalNetModel

>>> # Initializing a FocalNet microsoft/focalnet-tiny style configuration
>>> configuration = FocalNetConfig()

>>> # Initializing a model (with random weights) from the microsoft/focalnet-tiny style configuration
>>> model = FocalNetModel(configuration)

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

FocalNetModel

类 transformers.FocalNetModel

< >

( config add_pooling_layer = True use_mask_token = False )

参数

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

FocalNet 模型输出原始隐藏状态，顶部没有任何特定头部。此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以获取有关一般使用和行为的所有信息。

forward

< >

( pixel_values: Optional = None bool_masked_pos: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.models.focalnet.modeling_focalnet.FocalNetModelOutput or tuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor 类型为 (batch_size, num_channels, height, width)) — 像素值。像素值可以使用 AutoImageProcessor 获取。有关详细信息，请参阅 AutoImageProcessor.__call__()。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的 hidden_states。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
  • bool_masked_pos (torch.BoolTensor 类型为 (batch_size, num_patches)) — 布尔掩码位置。指示哪些补丁被掩码 (1) 和哪些没有被掩码 (0)。

返回值

transformers.models.focalnet.modeling_focalnet.FocalNetModelOutput 或 tuple(torch.FloatTensor)

一个 transformers.models.focalnet.modeling_focalnet.FocalNetModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（FocalNetConfig）和输入包含各种元素。

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

    模型在每一层输出处的隐藏状态以及初始嵌入输出。

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

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

FocalNetModel 正向方法会覆盖 __call__ 特殊方法。

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

示例

>>> from transformers import AutoImageProcessor, FocalNetModel
>>> 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("microsoft/focalnet-tiny")
>>> model = FocalNetModel.from_pretrained("microsoft/focalnet-tiny")

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

FocalNetForMaskedImageModeling

类 transformers.FocalNetForMaskedImageModeling

< >

( config )

参数

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

顶部带有解码器的 FocalNet 模型，用于掩码图像建模。

这遵循与 SimMIM 中相同的实现。

请注意，我们在 示例目录 中提供了一个脚本，用于在自定义数据上预训练此模型。

此模型是一个 PyTorch torch.nn.Module 子类。 将其用作常规 PyTorch 模块，并参考 PyTorch 文档以获取有关一般用法和行为的所有内容。

forward

< >

( pixel_values: Optional = None bool_masked_pos: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.models.focalnet.modeling_focalnet.FocalNetMaskedImageModelingOutput 或 tuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor ，形状为 (batch_size, num_channels, height, width)) — 像素值。可以使用 AutoImageProcessor 获取像素值。有关详细信息，请参阅 AutoImageProcessor.__call__()。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的 hidden_states。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
  • bool_masked_pos (torch.BoolTensor 形状为 (batch_size, num_patches)) — 布尔掩码位置。指示哪些补丁被掩码 (1) 和哪些没有被掩码 (0)。

返回值

transformers.models.focalnet.modeling_focalnet.FocalNetMaskedImageModelingOutput 或 tuple(torch.FloatTensor)

一个 transformers.models.focalnet.modeling_focalnet.FocalNetMaskedImageModelingOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置 (FocalNetConfig) 和输入包含各种元素。

  • loss (torch.FloatTensor 形状为 (1,), 可选，当提供 bool_masked_pos 时返回) — 掩码图像建模 (MLM) 损失。

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

    模型在每一层输出处的隐藏状态以及初始嵌入输出。

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

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

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

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

示例

>>> from transformers import AutoImageProcessor, FocalNetConfig, FocalNetForMaskedImageModeling
>>> 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("microsoft/focalnet-base-simmim-window6-192")
>>> config = FocalNetConfig()
>>> model = FocalNetForMaskedImageModeling(config)

>>> 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.logits
>>> list(reconstructed_pixel_values.shape)
[1, 3, 192, 192]

FocalNetForImageClassification

类 transformers.FocalNetForImageClassification

< >

( config )

参数

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

FocalNet 模型，顶部是图像分类头（在池化输出顶部有一个线性层），例如用于 ImageNet。

此模型是一个 PyTorch torch.nn.Module 子类。 将其用作常规 PyTorch 模块，并参考 PyTorch 文档以获取有关一般用法和行为的所有内容。

forward

< >

( pixel_values: Optional = None labels: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.models.focalnet.modeling_focalnet.FocalNetImageClassifierOutput 或 tuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor ，形状为 (batch_size, num_channels, height, width)) — 像素值。像素值可以使用 AutoImageProcessor 获取。有关详细信息，请参阅 AutoImageProcessor.__call__()。
  • 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.focalnet.modeling_focalnet.FocalNetImageClassifierOutput 或 tuple(torch.FloatTensor)

一个 transformers.models.focalnet.modeling_focalnet.FocalNetImageClassifierOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），其中包含根据配置 (FocalNetConfig) 和输入的不同元素。

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

    模型在每一层输出处的隐藏状态以及初始嵌入输出。

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

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

FocalNetForImageClassification 的 forward 方法重载了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoImageProcessor, FocalNetForImageClassification
>>> 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("microsoft/focalnet-tiny")
>>> model = FocalNetForImageClassification.from_pretrained("microsoft/focalnet-tiny")

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

←EfficientNet GLPN→