Transformers 文档

Hiera

Hiera

概述

Hiera 在 Hiera: A Hierarchical Vision Transformer without the Bells-and-Whistles 中被提出,作者包括 Chaitanya Ryali, Yuan-Ting Hu, Daniel Bolya, Chen Wei, Haoqi Fan, Po-Yao Huang, Vaibhav Aggarwal, Arkabandhu Chowdhury, Omid Poursaeed, Judy Hoffman, Jitendra Malik, Yanghao Li, Christoph Feichtenhofer

本文介绍了“Hiera”,一种分层的视觉Transformer,它通过移除不必要的组件来简化现代分层视觉Transformer的架构,而不会影响准确性或效率。与传统的Transformer不同,后者通过添加复杂的视觉特定组件来提高监督分类性能,Hiera表明这些通常被称为“花哨”的添加对于高准确性并不是必需的。通过利用强大的视觉预训练任务(MAE)进行预训练,Hiera保持了简单性,并在各种图像和视频识别任务中实现了卓越的准确性和速度。该方法表明,视觉任务所需的空间偏差可以通过适当的预训练有效地学习,从而消除了增加架构复杂性的需求。

论文的摘要如下:

现代分层视觉变换器在追求监督分类性能的过程中添加了多种视觉专用组件。虽然这些组件带来了有效的准确性和吸引人的FLOP计数,但增加的复杂性实际上使这些变换器比其原始的ViT版本更慢。在本文中,我们认为这种额外的复杂性是不必要的。通过使用强大的视觉预训练任务(MAE)进行预训练,我们可以从最先进的多阶段视觉变换器中去除所有花哨的组件,而不会损失准确性。在此过程中,我们创建了Hiera,一个极其简单的分层视觉变换器,它比以前的模型更准确,同时在推理和训练期间都显著更快。我们在各种图像和视频识别任务上评估了Hiera。我们的代码和模型可在https://github.com/facebookresearch/hiera获取。

drawing Hiera architecture. Taken from the original paper.

该模型是由EduardoPacheconamangarg110共同贡献的。原始代码可以在[这里]找到 (https://github.com/facebookresearch/hiera)。

资源

以下是官方 Hugging Face 和社区(由🌎表示)提供的资源列表,帮助您开始使用 Hiera。如果您有兴趣提交资源以包含在此处,请随时打开一个 Pull Request,我们将进行审核!理想情况下,资源应展示一些新内容,而不是重复现有资源。

Image Classification

HieraConfig

transformers.HieraConfig

< >

( embed_dim = 96 image_size = [224, 224] patch_size = [7, 7] patch_stride = [4, 4] patch_padding = [3, 3] mlp_ratio = 4.0 depths = [2, 3, 16, 3] num_heads = [1, 2, 4, 8] embed_dim_multiplier = 2.0 num_query_pool = 3 query_stride = [2, 2] masked_unit_size = [8, 8] masked_unit_attention = [True, True, False, False] drop_path_rate = 0.0 num_channels = 3 hidden_act = 'gelu' initializer_range = 0.02 layer_norm_init = 1.0 layer_norm_eps = 1e-06 decoder_hidden_size = None decoder_depth = None decoder_num_heads = None normalize_pixel_loss = True mask_ratio = 0.6 out_features = None out_indices = None **kwargs )

参数

  • embed_dim (int, optional, 默认为 96) — 补丁嵌入的维度.
  • image_size (list(int), 可选, 默认为 [224, 224]) — 输入的大小(分辨率),格式为(高度,宽度)用于图像, (帧数,高度,宽度)用于视频。
  • patch_size (list(int), 可选, 默认为 [7, 7]) — 每个补丁的大小(分辨率)。
  • patch_stride (list(int), optional, defaults to [4, 4]) — 补丁的步幅。
  • patch_padding (list(int), optional, 默认为 [3, 3]) — 补丁的填充。
  • mlp_ratio (float, optional, defaults to 4.0) — MLP隐藏维度与嵌入维度的比率。
  • depths (list(int), 可选, 默认为 [2, 3, 16, 3]) — Transformer编码器中每一层的深度。
  • num_heads (list(int), 可选, 默认为 [1, 2, 4, 8]) — Transformer编码器每一层中的注意力头数。
  • embed_dim_multiplier (float, optional, 默认为 2.0) — Transformer 编码器每一层中 patch 嵌入维度的乘数。
  • num_query_pool (int, optional, 默认为 3) — 查询池阶段的数量。
  • query_stride (list(int), 可选, 默认为 [2, 2]) — 查询池的步幅.
  • masked_unit_size (list(int), optional, defaults to [8, 8]) — 掩码单元的大小。
  • masked_unit_attention (list(bool), 可选, 默认为 [True, True, False, False]) — 是否在Transformer编码器的每一层中使用掩码单元注意力。
  • drop_path_rate (float, optional, defaults to 0.0) — 路径丢弃率.
  • num_channels (int, optional, 默认为 3) — 输入通道的数量。
  • hidden_act (str, 可选, 默认为 "gelu") — 编码器中的非线性激活函数(函数或字符串)。如果是字符串,支持 "gelu", "relu", "selu""gelu_new".
  • initializer_range (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差和用于初始化所有偏置向量的 zero_initializer。
  • layer_norm_init (float, optional, defaults to 1.0) — 层归一化层的初始权重值。
  • layer_norm_eps (float, optional, 默认为 1e-06) — 层归一化层使用的 epsilon 值。
  • decoder_hidden_size (int, optional) — 用于MAE预训练的解码器嵌入的维度。
  • decoder_depth (int, optional) — 用于MAE预训练的解码器深度。
  • decoder_num_heads (int, optional) — 用于MAE预训练的解码器每层中的注意力头数。
  • normalize_pixel_loss (bool, optional, defaults to True) — 是否通过像素数量来归一化像素损失。
  • mask_ratio (float, optional, defaults to 0.6) — 输入中被掩码的标记的比例。
  • 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属性中定义的顺序相同。

这是用于存储HieraModel配置的配置类。它用于根据指定的参数实例化一个Hiera模型,定义模型架构。使用默认值实例化配置将产生类似于Hiera facebook/hiera-base-224架构的配置。

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

示例:

>>> from transformers import HieraConfig, HieraModel

>>> # Initializing a Hiera hiera-base-patch16-224 style configuration
>>> configuration = HieraConfig()

>>> # Initializing a model (with random weights) from the hiera-base-patch16-224 style configuration
>>> model = HieraModel(configuration)

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

HieraModel

transformers.HieraModel

< >

( config: HieraConfig add_pooling_layer: bool = True is_mae: bool = False )

参数

  • config (HieraConfig) — 包含模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型相关的权重,只会加载配置。查看 from_pretrained() 方法以加载模型权重。
  • add_pooling_layer (bool, optional, defaults to True) — 是否应用池化层.
  • is_mae (bool, 可选, 默认为 False) — 是否在MAE模式下运行模型。

裸的Hiera模型转换器输出原始隐藏状态,没有任何特定的头部。 此模型是PyTorch torch.nn.Module 的子类。将其用作常规的PyTorch模块,并参考PyTorch文档以获取与一般使用和行为相关的所有事项。

前进

< >

( pixel_values: typing.Optional[torch.Tensor] = None noise: typing.Optional[torch.FloatTensor] = None head_mask: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None interpolate_pos_encoding: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) transformers.models.hiera.modeling_hiera.HieraModelOutputtuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor of shape (batch_size, num_channels, height, width)) — 像素值。像素值可以使用AutoImageProcessor获取。详情请参见BitImageProcessor.call()
  • head_mask (torch.FloatTensor 形状为 (num_heads,)(num_layers, num_heads), 可选) — 用于屏蔽自注意力模块中选定的头部的掩码。掩码值在 [0, 1] 中选择:
    • 1 表示头部 未被屏蔽,
    • 0 表示头部 被屏蔽.
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量下的attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • interpolate_pos_encoding (bool, optional) — 是否插值预训练的位置编码.
  • return_dict (bool, 可选) — 是否返回一个ModelOutput而不是一个普通的元组。
  • 噪声 (torch.FloatTensor 形状为 (batch_size, num_mask_units), 可选) 主要用于测试目的,以控制随机性并在 is_mae 设置为 True 时保持可重复性。

返回

transformers.models.hiera.modeling_hiera.HieraModelOutputtuple(torch.FloatTensor)

一个 transformers.models.hiera.modeling_hiera.HieraModelOutput 或一个由 torch.FloatTensor 组成的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含根据配置(HieraConfig)和输入的各种元素。

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

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

  • bool_masked_pos (torch.BoolTensor 形状为 (batch_size, sequence_length)) — 指示哪些补丁被掩码(0)和哪些未被掩码(1)的张量。

  • ids_restore (torch.LongTensor 形状为 (batch_size, sequence_length)) — 包含(打乱的)掩码补丁的原始索引的张量。

  • 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, height, width, hidden_size)。这些是模型的重新整形和重新展开的隐藏状态。

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

HieraModel 的 forward 方法,重写了 __call__ 特殊方法。

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

示例:

>>> from transformers import AutoImageProcessor, HieraModel
>>> 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/hiera-tiny-224-hf")
>>> model = HieraModel.from_pretrained("facebook/hiera-tiny-224-hf")

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

HieraForPreTraining

class transformers.HieraForPreTraining

< >

( config: HieraConfig )

参数

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

带有解码器的Hiera模型转换器,用于自监督预训练。

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

该模型是一个PyTorch torch.nn.Module 子类。将其用作常规的PyTorch模块,并参考PyTorch文档以获取与一般使用和行为相关的所有信息。

前进

< >

( pixel_values: typing.Optional[torch.Tensor] = None noise: typing.Optional[torch.FloatTensor] = None head_mask: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None interpolate_pos_encoding: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) transformers.models.hiera.modeling_hiera.HieraForPreTrainingOutputtuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor of shape (batch_size, num_channels, height, width)) — 像素值。像素值可以使用AutoImageProcessor获取。详情请参见BitImageProcessor.call()
  • head_mask (torch.FloatTensor 形状为 (num_heads,)(num_layers, num_heads), 可选) — 用于屏蔽自注意力模块中选定的头部的掩码。掩码值在 [0, 1] 中选择:
    • 1 表示头部 未被屏蔽,
    • 0 表示头部 被屏蔽.
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量中的attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • interpolate_pos_encoding (bool, optional) — 是否插值预训练的位置编码.
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
  • 噪声 (torch.FloatTensor 形状为 (batch_size, num_mask_units), 可选) 主要用于测试目的,以控制随机性并在 is_mae 设置为 True 时保持可重复性。

返回

transformers.models.hiera.modeling_hiera.HieraForPreTrainingOutputtuple(torch.FloatTensor)

一个 transformers.models.hiera.modeling_hiera.HieraForPreTrainingOutput 或一个由 torch.FloatTensor 组成的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含各种 元素,具体取决于配置(HieraConfig)和输入。

  • loss (torch.FloatTensor 形状为 (1,)) — 像素重建损失。
  • logits (torch.FloatTensor 形状为 (batch_size, sequence_length, patch_size ** 2 * num_channels)) — 像素重建 logits。
  • bool_masked_pos (torch.BoolTensor 形状为 (batch_size, sequence_length)) — 指示哪些补丁被掩码(0)和哪些未被掩码(1)的张量。
  • ids_restore (torch.LongTensor 形状为 (batch_size, sequence_length)) — 包含(打乱的)掩码补丁的原始索引的张量。
  • 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, height, width, hidden_size)。模型在每层输出处的隐藏状态 加上初始嵌入输出,重新调整为包含空间维度。

HieraForPreTraining 的前向方法,重写了 __call__ 特殊方法。

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

示例:

>>> from transformers import AutoImageProcessor, HieraForPreTraining
>>> 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("facebook/hiera-tiny-224-mae-hf")
>>> model = HieraForPreTraining.from_pretrained("facebook/hiera-tiny-224-mae-hf")

>>> inputs = image_processor(images=image, return_tensors="pt")

>>> outputs = model(**inputs)
>>> logits = outputs.logits
>>> loss = outputs.loss
>>> print(list(logits.shape))
[1, 196, 768]

HieraForImageClassification

transformers.HieraForImageClassification

< >

( config: HieraConfig )

参数

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

Hiera 模型转换器,顶部带有图像分类头(在最终隐藏状态上具有平均池化的线性层),例如用于 ImageNet。

请注意,通过在模型的前向传播中将interpolate_pos_encoding设置为True,可以在比训练时更高分辨率的图像上微调Hiera。这将把预训练的位置嵌入插值到更高的分辨率。

该模型是一个PyTorch torch.nn.Module 子类。将其用作常规的PyTorch模块,并参考PyTorch文档以获取与一般使用和行为相关的所有信息。

前进

< >

( pixel_values 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 interpolate_pos_encoding: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) transformers.models.hiera.modeling_hiera.HieraForImageClassificationOutputtuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor of shape (batch_size, num_channels, height, width)) — 像素值。像素值可以使用AutoImageProcessor获取。详情请参见BitImageProcessor.call()
  • head_mask (torch.FloatTensor 形状为 (num_heads,)(num_layers, num_heads), 可选) — 用于屏蔽自注意力模块中选定的头部的掩码。掩码值在 [0, 1] 中选择:
    • 1 表示头部 未被屏蔽,
    • 0 表示头部 被屏蔽.
  • output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量中的attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • interpolate_pos_encoding (bool, optional) — 是否插值预训练的位置编码.
  • 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.hiera.modeling_hiera.HieraForImageClassificationOutputtuple(torch.FloatTensor)

一个 transformers.models.hiera.modeling_hiera.HieraForImageClassificationOutput 或一个由 torch.FloatTensor 组成的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含各种 元素,具体取决于配置(HieraConfig)和输入。

  • loss (torch.FloatTensor 形状为 (1,), optional) — 训练任务的损失值。

  • logits (torch.FloatTensor 形状为 (batch_size, num_labels)) — 分类头的预测分数(输出层的logits)。

  • hidden_states (tuple(torch.FloatTensor), optional) — 由 torch.FloatTensor 组成的元组(一个用于嵌入的输出 + 一个用于每个阶段的输出),形状为 (batch_size, sequence_length, hidden_size)。这些是模型的展开隐藏状态。

    模型在每层输出处的隐藏状态加上初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), optional) — 由 torch.FloatTensor 组成的元组(每个阶段一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

  • reshaped_hidden_states (tuple(torch.FloatTensor), optional) — 由 torch.FloatTensor 组成的元组(一个用于嵌入的输出 + 一个用于每个阶段的输出),形状为 (batch_size, height, width, hidden_size)。这些是模型的重新整形和重新展开的隐藏状态。

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

HieraForImageClassification 的前向方法,重写了 __call__ 特殊方法。

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

示例:

>>> from transformers import AutoImageProcessor, HieraForImageClassification
>>> 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/hiera-tiny-224-in1k-hf")
>>> model = HieraForImageClassification.from_pretrained("facebook/hiera-tiny-224-in1k-hf")

>>> 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
< > Update on GitHub