Transformers 文档
Hiera
并获得增强的文档体验
开始使用
Hiera
概述
Hiera 由 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: A Hierarchical Vision Transformer without the Bells-and-Whistles 中提出。
该论文介绍了一种名为“Hiera”的分层视觉 Transformer,它通过移除不必要的组件,简化了现代分层视觉 Transformer 的架构,同时又不影响其准确性或效率。与传统 Transformer 为了提高监督分类性能而添加复杂的视觉特定组件不同,Hiera 证明了这些通常被称为“花里胡哨”的附加组件对于实现高准确性并非必需。通过利用强大的视觉预训练任务(MAE)进行预训练,Hiera 保持了简洁性,并在各种图像和视频识别任务中,无论是在推理还是训练方面,都实现了卓越的准确性和速度。该方法表明,视觉任务所需的空间偏差可以通过适当的预训练有效学习,从而无需增加架构复杂性。
论文摘要如下:
现代的分层视觉 Transformer 为了追求监督分类性能,添加了若干视觉特定组件。尽管这些组件带来了有效的准确率和吸引人的 FLOPs 计数,但增加的复杂性实际上使得这些 Transformer 比其普通的 ViT 对应物更慢。在本文中,我们认为这种额外的累赘是不必要的。通过使用强大的视觉预训练任务(MAE)进行预训练,我们可以从一个先进的多阶段视觉 Transformer 中剥离所有“花里胡哨”的组件而不损失准确性。在这个过程中,我们创造了 Hiera,一个极其简单的分层视觉 Transformer,它比以前的模型更准确,同时在推理和训练期间都显著更快。我们在各种图像和视频识别任务上评估了 Hiera。我们的代码和模型可在 https://github.com/facebookresearch/hiera 上获取。

该模型由 EduardoPacheco 和 namangarg110 共同贡献。原始代码可在[此处]找到。
资源
Hugging Face 官方及社区(由 🌎 标识)提供了一系列资源,帮助您开始使用 Hiera。如果您有兴趣提交资源以包含在此处,请随时发起 Pull Request,我们将进行审核!理想情况下,资源应展示新内容,而不是重复现有资源。
- HieraForImageClassification 受此示例脚本和笔记本支持。
- 另请参阅:图像分类任务指南
HieraConfig
class 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
, 可选, 默认为 96) — 图像块嵌入的维度。 - image_size (
list(int)
, 可选, 默认为[224, 224]
) — 输入的大小(分辨率),对于图像格式为 (height, width),对于视频格式为 (frames, height, width)。 - patch_size (
list(int)
, 可选, 默认为[7, 7]
) — 每个图像块的大小(分辨率)。 - patch_stride (
list(int)
, 可选, 默认为[4, 4]
) — 图像块的步幅。 - patch_padding (
list(int)
, 可选, 默认为[3, 3]
) — 图像块的填充。 - mlp_ratio (
float
, 可选, 默认为 4.0) — MLP 隐藏维度与嵌入维度的比率。 - depths (
list(int)
, 可选, 默认为[2, 3, 16, 3]
) — Transformer 编码器中每一层的深度。 - num_heads (
list(int)
, 可选, 默认为[1, 2, 4, 8]
) — Transformer 编码器中每一层的注意力头数量。 - embed_dim_multiplier (
float
, 可选, 默认为 2.0) — Transformer 编码器中每一层图像块嵌入维度的乘数。 - num_query_pool (
int
, 可选, 默认为 3) — 查询池化阶段的数量。 - query_stride (
list(int)
, 可选, 默认为[2, 2]
) — 查询池化的步幅。 - masked_unit_size (
list(int)
, 可选, 默认为[8, 8]
) — 掩码单元的大小。 - masked_unit_attention (
list(bool)
, 可选, 默认为[True, True, False, False]
) — 是否在 Transformer 编码器的每一层中使用掩码单元注意力。 - drop_path_rate (
float
, 可选, 默认为 0.0) — Drop path 概率。 - num_channels (
int
, 可选, 默认为 3) — 输入通道数。 - hidden_act (
str
, 可选, 默认为"gelu"
) — 编码器中的非线性激活函数(函数或字符串)。如果是字符串,支持"gelu"
、"relu"
、"selu"
和"gelu_new"
。 - initializer_range (
float
, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差,以及用于初始化所有偏置向量的 zero_initializer。 - layer_norm_init (
float
, 可选, 默认为 1.0) — 层归一化层的初始权重值。 - layer_norm_eps (
float
, 可选, 默认为 1e-06) — 层归一化层使用的 epsilon 值。 - decoder_hidden_size (
int
, 可选) — 用于 MAE 预训练的解码器嵌入维度。 - decoder_depth (
int
, 可选) — 用于 MAE 预训练的解码器深度。 - decoder_num_heads (
int
, 可选) — 用于 MAE 预训练的解码器中每一层的注意力头数量。 - normalize_pixel_loss (
bool
, 可选, 默认为True
) — 是否通过像素数量对像素损失进行归一化。 - mask_ratio (
float
, 可选, 默认为 0.6) — 输入中被掩码的标记的比例。 - 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
属性中定义的顺序相同。
这是用于存储 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
class transformers.HieraModel
< 源 >( config: HieraConfig add_pooling_layer: bool = True is_mae: bool = False )
参数
- config (HieraConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重,仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
- add_pooling_layer (
bool
, 可选, 默认为True
) — 是否应用池化层。 - is_mae (
bool
, 可选, 默认为False
) — 是否以 MAE 模式运行模型。
裸的 Hiera 模型,输出原始隐藏状态,顶部没有任何特定的头部。
此模型继承自 PreTrainedModel。请查看超类文档,了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。
该模型也是 PyTorch 的 torch.nn.Module 子类。可以像常规 PyTorch 模块一样使用它,并参考 PyTorch 文档了解所有与常规用法和行为相关的事项。
forward
< source >( 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.modeling_outputs.BaseModelOutputWithPooling 或 tuple(torch.FloatTensor)
参数
- pixel_values (
torch.Tensor
,形状为(batch_size, num_channels, image_size, image_size)
,可选) — 对应于输入图像的张量。像素值可以使用{image_processor_class}
获取。有关详细信息,请参阅{image_processor_class}.__call__
({processor_class}
使用{image_processor_class}
处理图像)。 - noise (
torch.FloatTensor
,形状为(batch_size, num_mask_units)
,可选) — 主要用于测试目的,以控制随机性并保持可复现性。 - head_mask (
torch.Tensor
,形状为(num_heads,)
或(num_layers, num_heads)
,可选) — 用于使自注意力模块中选定的头无效的掩码。掩码值选自[0, 1]
:- 1 表示头未被掩码,
- 0 表示头被掩码。
- output_attentions (
bool
,可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的 `attentions`。 - output_hidden_states (
bool
,可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的 `hidden_states`。 - interpolate_pos_encoding (
bool
,可选) — 是否对预训练的位置编码进行插值。 - return_dict (
bool
,可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_outputs.BaseModelOutputWithPooling 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPooling 或一个 `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)
) — 序列的第一个标记(分类标记)的最后一层隐藏状态,经过用于辅助预训练任务的层进一步处理。例如,对于 BERT 族模型,这返回分类标记经过线性层和 tanh 激活函数处理后的结果。线性层权重在预训练期间通过下一句预测(分类)目标进行训练。 -
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 后的注意力权重,用于计算自注意力头中的加权平均值。
HieraModel 的 forward 方法,重写了 `__call__` 特殊方法。
尽管前向传播的流程需要在此函数内定义,但之后应该调用 `Module` 实例而不是此函数,因为前者会处理前处理和后处理步骤,而后者会静默地忽略它们。
HieraForPreTraining
class transformers.HieraForPreTraining
< source >( config: HieraConfig )
参数
- config (HieraConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,只加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有解码器的 Hiera 模型 Transformer,用于自监督预训练。
请注意,我们在 examples directory 中提供了一个脚本,用于在自定义数据上预训练此模型。
此模型继承自 PreTrainedModel。请查看超类文档,了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。
该模型也是 PyTorch 的 torch.nn.Module 子类。可以像常规 PyTorch 模块一样使用它,并参考 PyTorch 文档了解所有与常规用法和行为相关的事项。
forward
< source >( 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.HieraForPreTrainingOutput
或 tuple(torch.FloatTensor)
参数
- pixel_values (
torch.Tensor
,形状为(batch_size, num_channels, image_size, image_size)
,可选) — 对应于输入图像的张量。像素值可以使用{image_processor_class}
获取。有关详细信息,请参阅{image_processor_class}.__call__
({processor_class}
使用{image_processor_class}
处理图像)。 - noise (
torch.FloatTensor
,形状为(batch_size, num_mask_units)
,可选) — 主要用于测试目的,以控制随机性并保持可复现性。 - head_mask (
torch.Tensor
,形状为(num_heads,)
或(num_layers, num_heads)
,可选) — 用于使自注意力模块中选定的头无效的掩码。掩码值选自[0, 1]
:- 1 表示头未被掩码,
- 0 表示头被掩码。
- output_attentions (
bool
,可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的 `attentions`。 - output_hidden_states (
bool
,可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的 `hidden_states`。 - interpolate_pos_encoding (
bool
,可选) — 是否对预训练的位置编码进行插值。 - return_dict (
bool
,可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.models.hiera.modeling_hiera.HieraForPreTrainingOutput
或 tuple(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 的 forward 方法,重写了 `__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
class transformers.HieraForImageClassification
< source >( config: HieraConfig )
参数
- config (HieraConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,只加载配置。请查看 from_pretrained() 方法来加载模型权重。
Hiera 模型 Transformer,顶部带有一个图像分类头(在最终隐藏状态上进行平均池化后再接一个线性层),例如用于 ImageNet。
请注意,通过在模型的前向传播中将 `interpolate_pos_encoding` 设置为 `True`,可以在比训练时分辨率更高的图像上微调 Hiera。这将把预训练的位置嵌入插值到更高的分辨率。
此模型继承自 PreTrainedModel。请查看超类文档,了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。
该模型也是 PyTorch 的 torch.nn.Module 子类。可以像常规 PyTorch 模块一样使用它,并参考 PyTorch 文档了解所有与常规用法和行为相关的事项。
forward
< source >( 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.HieraForImageClassificationOutput
或 tuple(torch.FloatTensor)
参数
- pixel_values (`
形状为
(batch_size, num_channels, image_size, image_size)`) -- 对应于输入图像的张量。像素值可以使用{image_processor_class}
获取。有关详细信息,请参阅{image_processor_class}.__call__
(`{processor_class}` 使用 `{image_processor_class}` 处理图像)。 - head_mask (
torch.Tensor
,形状为(num_heads,)
或(num_layers, num_heads)
,可选) — 用于使自注意力模块中选定的头无效的掩码。掩码值选自[0, 1]
:- 1 表示头未被掩码,
- 0 表示头被掩码。
- labels (
torch.LongTensor
,形状为(batch_size,)
,可选) — 用于计算图像分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]
范围内。如果config.num_labels == 1
,则计算回归损失(均方误差损失);如果config.num_labels > 1
,则计算分类损失(交叉熵)。 - output_attentions (
bool
,可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的 `attentions`。 - output_hidden_states (
bool
,可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的 `hidden_states`。 - interpolate_pos_encoding (
bool
,可选) — 是否对预训练的位置编码进行插值。 - return_dict (
bool
,可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.models.hiera.modeling_hiera.HieraForImageClassificationOutput
或 tuple(torch.FloatTensor)
一个 transformers.models.hiera.modeling_hiera.HieraForImageClassificationOutput
或一个 `torch.FloatTensor` 元组(如果传递了 `return_dict=False` 或 `config.return_dict=False`),根据配置(HieraConfig)和输入,包含各种元素。
-
loss (
torch.FloatTensor
,形状为(1,)
,`可选`) — 训练任务的损失值。 -
logits (
torch.FloatTensor
,形状为(batch_size, num_labels)
) — 分类头的预测分数(输出层的 logits)。 -
hidden_states (
tuple(torch.FloatTensor)
,`可选`) — `torch.FloatTensor` 的元组(一个用于嵌入层的输出 + 每个阶段一个输出),形状为 `(batch_size, sequence_length, hidden_size)`。这些是模型的展开隐藏状态。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor)
,`可选`) — `torch.FloatTensor` 的元组(每个阶段一个),形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均值。
-
loss (
torch.FloatTensor
,形状为(1,)
,`可选`) — 训练任务的损失值。 -
logits (
torch.FloatTensor
,形状为(batch_size, num_labels)
) — 分类头的预测分数(输出层的 logits)。 -
hidden_states (
tuple(torch.FloatTensor)
,`可选`) — `torch.FloatTensor` 的元组(一个用于嵌入层的输出 + 每个阶段一个输出),形状为 `(batch_size, sequence_length, hidden_size)`。这些是模型的展开隐藏状态。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor)
,`可选`) — `torch.FloatTensor` 的元组(每个阶段一个),形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均值。
-
reshaped_hidden_states (
tuple(torch.FloatTensor)
,`可选`) — `torch.FloatTensor` 的元组(一个用于嵌入层的输出 + 每个阶段一个输出),形状为 `(batch_size, height, width, hidden_size)`。这些是模型的重塑和重新卷叠的隐藏状态。模型在每层输出处的隐藏状态,以及重新调整以包含空间维度的初始嵌入输出。
HieraForImageClassification 的 forward 方法,重写了 `__call__` 特殊方法。
尽管前向传播的流程需要在此函数内定义,但之后应该调用 `Module` 实例而不是此函数,因为前者会处理前处理和后处理步骤,而后者会静默地忽略它们。
示例
>>> from transformers import AutoImageProcessor, HieraForImageClassification
>>> import torch
>>> from datasets import load_dataset
>>> dataset = load_dataset("huggingface/cats-image")
>>> image = dataset["test"]["image"][0]
>>> image_processor = AutoImageProcessor.from_pretrained("facebook/hiera-base-224")
>>> model = HieraForImageClassification.from_pretrained("facebook/hiera-base-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])
...