FocalNet
概述
FocalNet模型是由Jianwei Yang、Chunyuan Li、Xiyang Dai、Lu Yuan和Jianfeng Gao在Focal Modulation Networks中提出的。 FocalNets完全取代了自注意力机制(用于ViT和Swin等模型中),通过焦点调制机制来建模视觉中的标记交互。 作者声称,在图像分类、目标检测和分割任务中,FocalNets在相似的计算成本下优于基于自注意力的模型。
论文的摘要如下:
我们提出了焦点调制网络(简称FocalNets),其中自注意力(SA)完全被焦点调制机制取代,用于在视觉中建模令牌交互。焦点调制包括三个组件:(i)分层上下文化,使用一系列深度卷积层实现,以从短到长范围编码视觉上下文,(ii)门控聚合,根据每个查询令牌的内容选择性地收集上下文,以及(iii)逐元素调制或仿射变换,将聚合的上下文注入查询。大量实验表明,FocalNets在图像分类、目标检测和分割任务上以相似的计算成本优于最先进的SA对应物(例如,Swin和Focal Transformers)。具体来说,FocalNets的小型和基础型在ImageNet-1K上分别达到了82.3%和83.9%的top-1准确率。在224分辨率下预训练于ImageNet-22K后,当分别以224和384分辨率微调时,它达到了86.5%和87.3%的top-1准确率。当转移到下游任务时,FocalNets表现出明显的优势。对于使用Mask R-CNN的目标检测,FocalNet基础型在1×训练下比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。
FocalNetConfig
类 transformers.FocalNetConfig
< source >( 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
, optional, 默认为 224) — 每张图像的尺寸(分辨率)。 - patch_size (
int
, optional, defaults to 4) — 嵌入层中每个补丁的大小(分辨率)。 - num_channels (
int
, optional, 默认为 3) — 输入通道的数量。 - embed_dim (
int
, optional, 默认为 96) — 补丁嵌入的维度. - use_conv_embed (
bool
, 可选, 默认为False
) — 是否使用卷积嵌入。作者指出,使用卷积嵌入通常会提高性能,但默认情况下不使用它。 - hidden_sizes (
List[int]
, optional, 默认为[192, 384, 768, 768]
) — 每个阶段的维度(隐藏大小)。 - depths (
list(int)
, optional, defaults to[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
, optional, defaults to 4.0) — MLP隐藏维度与嵌入维度的比率。 - hidden_dropout_prob (
float
, optional, 默认为 0.0) — 嵌入层和编码器中所有全连接层的 dropout 概率。 - drop_path_rate (
float
, optional, 默认为 0.1) — 随机深度率. - use_layerscale (
bool
, 可选, 默认为False
) — 是否在编码器中使用层缩放. - layerscale_value (
float
, optional, 默认为 0.0001) — 层比例的初始值。 - use_post_layernorm (
bool
, optional, defaults toFalse
) — 是否在编码器中使用后层归一化。 - use_post_layernorm_in_modulation (
bool
, optional, defaults toFalse
) — 是否在调制层中使用后层归一化。 - normalize_modulator (
bool
, optional, defaults toFalse
) — 是否对调制器进行归一化。 - initializer_range (
float
, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。 - layer_norm_eps (
float
, optional, defaults to 1e-05) — 层归一化层使用的epsilon值。 - encoder_stride (
int
, optional, defaults to 32) — 用于在解码器头部增加空间分辨率的因子,用于掩码图像建模。 - out_features (
List[str]
, 可选) — 如果用作骨干网络,输出特征的列表。可以是"stem"
,"stage1"
,"stage2"
等。 (取决于模型有多少个阶段)。如果未设置且out_indices
已设置,将默认为相应的阶段。如果未设置且out_indices
也未设置,将默认为最后一个阶段。必须与stage_names
属性中定义的顺序相同。 - out_indices (
List[int]
, optional) — 如果用作骨干网络,输出特征的索引列表。可以是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
< source >( config add_pooling_layer = True use_mask_token = False )
参数
- config (FocalNetConfig) — 包含模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型相关的权重,只会加载配置。查看 from_pretrained() 方法以加载模型权重。
裸的FocalNet模型输出原始隐藏状态,没有任何特定的头部。 此模型是PyTorch torch.nn.Module 的子类。将其用作常规的PyTorch模块,并参考PyTorch文档以获取与一般使用和行为相关的所有信息。
前进
< source >( pixel_values: typing.Optional[torch.FloatTensor] = None bool_masked_pos: typing.Optional[torch.BoolTensor] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.focalnet.modeling_focalnet.FocalNetModelOutput
或 tuple(torch.FloatTensor)
参数
- pixel_values (
torch.FloatTensor
of shape(batch_size, num_channels, height, width)
) — 像素值。像素值可以使用AutoImageProcessor获取。详情请参见AutoImageProcessor.__call__()
. - output_hidden_states (
bool
, optional) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回一个ModelOutput而不是一个普通的元组。 - bool_masked_pos (
torch.BoolTensor
of shape(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
< source >( config )
参数
- config (FocalNetConfig) — 包含模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型相关的权重,只会加载配置。查看 from_pretrained() 方法以加载模型权重。
FocalNet 模型,顶部带有解码器,用于掩码图像建模。
这与SimMIM中的实现相同。
请注意,我们在示例目录中提供了一个脚本来在自定义数据上预训练此模型。
该模型是一个PyTorch torch.nn.Module 子类。将其作为常规的PyTorch模块使用,并参考PyTorch文档以获取与一般使用和行为相关的所有信息。
前进
< source >( pixel_values: typing.Optional[torch.FloatTensor] = None bool_masked_pos: typing.Optional[torch.BoolTensor] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.focalnet.modeling_focalnet.FocalNetMaskedImageModelingOutput
或 tuple(torch.FloatTensor)
参数
- pixel_values (
torch.FloatTensor
of shape(batch_size, num_channels, height, width)
) — 像素值。像素值可以使用AutoImageProcessor获取。详情请参见AutoImageProcessor.__call__()
. - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回一个ModelOutput而不是一个普通的元组。 - bool_masked_pos (
torch.BoolTensor
of shape(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
< source >( config )
参数
- config (FocalNetConfig) — 包含模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型相关的权重,只会加载配置。查看 from_pretrained() 方法以加载模型权重。
FocalNet 模型,顶部带有图像分类头(在池化输出之上的线性层),例如用于 ImageNet。
该模型是一个PyTorch torch.nn.Module 子类。将其作为常规的PyTorch模块使用,并参考PyTorch文档以获取与一般使用和行为相关的所有信息。
前进
< source >( pixel_values: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.focalnet.modeling_focalnet.FocalNetImageClassifierOutput
或 tuple(torch.FloatTensor)
参数
- pixel_values (
torch.FloatTensor
of shape(batch_size, num_channels, height, width)
) — 像素值。像素值可以使用AutoImageProcessor获取。详情请参见AutoImageProcessor.__call__()
. - output_hidden_states (
bool
, optional) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。 - labels (
torch.LongTensor
of shape(batch_size,)
, optional) — 用于计算图像分类/回归损失的标签。索引应在[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 的前向方法,重写了 __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