Transformers 文档

Hiera

Transformers

加入 Hugging Face 社区

并获取增强文档体验的访问权限

在模型、数据集和 Spaces 上进行协作

使用加速推理加速示例

在文档主题之间切换

开始使用

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”，一种分层视觉转换器，它通过去除不必要的组件来简化现代分层视觉转换器的架构，而不会影响准确性或效率。与传统转换器通过添加复杂的视觉特定组件来提高监督分类性能不同，Hiera 证明了这些添加（通常被称为“花里胡哨”）对于高精度来说并不重要。通过利用强大的视觉预训练任务 (MAE) 进行预训练，Hiera 保持简单性，并在各种图像和视频识别任务中实现更高的准确性和速度，无论是在推理还是训练中。这种方法表明，视觉任务所需的空间偏差可以通过适当的预训练有效地学习，从而消除了对额外架构复杂性的需求。

论文中的摘要如下

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

Hiera 架构。取自原始论文。

此模型是 EduardoPacheco 和 namangarg110 共同贡献的结果。原始代码可在 [此处] (https://github.com/facebookresearch/hiera) 找到。

资源

一组官方 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]) — 图像的格式为 (高度, 宽度)，视频的格式为 (帧数, 高度, 宽度) 的输入大小 (分辨率)。
patch_size (list(int), 可选, 默认为 [7, 7]) — 每个补丁的大小 (分辨率)。
patch_stride (list(int), 可选, 默认为 [4, 4]) — 补丁的步长。
patch_padding (list(int), 可选, 默认为 [3, 3]) — 补丁的填充。
mlp_ratio (float, 可选, 默认为 4.0) — mlp 隐藏维数与嵌入维数的比率。
num_heads (list(int), 可选, 默认值：[1, 2, 4, 8]) — Transformer 编码器每一层的注意力头数。
embed_dim_multiplier (float, 可选, 默认值：2.0) — Transformer 编码器每一层的 patch embedding 维度的乘数。
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) — 丢弃路径率。
num_channels (int, 可选, 默认值：3) — 输入通道的数量。
hidden_act (str, 可选, 默认值："gelu") — 编码器中的非线性激活函数（函数或字符串）。如果是字符串，则支持 "gelu"、"relu"、"selu" 和 "gelu_new"。
initializer_range (float, 可选, 默认值：0.02) — 用于初始化所有权重矩阵的截断正态分布初始化器的标准差，以及用于初始化所有偏置向量的零初始化器。
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() 方法以加载模型权重。

参数

return_dict (bool, 可选) — 是否返回 ModelOutput 而不是简单的元组。
noise (torch.FloatTensor 形状为 (batch_size, num_mask_units), 可选) — 主要用于测试目的，以控制随机性并在 is_mae 设置为 True 时保持可重复性。

返回值

transformers.models.hiera.modeling_hiera.HieraModelOutput 或 tuple(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)) — 表示哪些 patch 被掩码 (0) 以及哪些没有被掩码 (1) 的张量。
ids_restore (torch.LongTensor 形状为 (batch_size, sequence_length)) — 包含 (随机) 掩码 patch 的原始索引的张量。
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 正向方法覆盖了 __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

< source >

( config: HieraConfig )

参数

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

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

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

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

< source >

( pixel_values: Optional = None noise: Optional = None head_mask: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None interpolate_pos_encoding: Optional = None return_dict: Optional = None ) → transformers.models.hiera.modeling_hiera.HieraForPreTrainingOutput 或 tuple(torch.FloatTensor)

参数

pixel_values (torch.FloatTensor 形状为 (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, 可选) — 是否插值预训练的位置编码。
return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。
noise (torch.FloatTensor 形状为 (batch_size, num_mask_units), 可选) — 主要用于测试目的，用于控制随机性并在 is_mae 设置为 True 时保持可重复性。

返回值

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)) — 表示哪些 patch 被掩码 (0) 以及哪些没有被掩码 (1) 的张量。
ids_restore (torch.LongTensor 形状为 (batch_size, sequence_length)) — 包含 (随机) 掩码 patch 的原始索引的张量。
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__ 特殊方法。

示例

>>> 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 模型转换器，在顶部有一个图像分类头（最终隐藏状态上的线性层，带有平均池化），例如用于 ImageNet。

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

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

< 源代码 >

( pixel_values head_mask: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None interpolate_pos_encoding: Optional = None return_dict: Optional = None ) → transformers.models.hiera.modeling_hiera.HieraForImageClassificationOutput 或 tuple(torch.FloatTensor)

参数

pixel_values (torch.FloatTensor 形状为 (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, 可选) — 是否插值预训练的位置编码。
return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
labels (torch.LongTensor 形状为 (batch_size,), 可选) — 用于计算图像分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 中。如果 config.num_labels == 1，则计算回归损失（均方误差损失），如果 config.num_labels > 1，则计算分类损失（交叉熵损失）。

返回值

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 后的注意力权重，用于计算自注意力头中的加权平均。
reshaped_hidden_states (tuple(torch.FloatTensor), 可选) — torch.FloatTensor 的元组（一个用于嵌入的输出 + 一个用于每个阶段的输出）形状为 (batch_size, height, width, hidden_size)。这些是模型的重塑和重新展开隐藏状态。

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

HieraForImageClassification 的正向方法覆盖了 __call__ 特殊方法。

示例

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

< > 在 GitHub 上更新

←GLPN ImageGPT→