Transformers 文档
Hiera
并获得增强的文档体验
开始使用
此模型于 2023 年 6 月 1 日在 HF papers 上发布,并于 2024 年 7 月 12 日贡献给 Hugging Face Transformers。
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 证明了这些通常被称为“花哨功能(bells-and-whistles)”的添加内容对于获得高准确性并非必不可少。通过利用强大的视觉预训练任务(MAE)进行预训练,Hiera 保持了简洁性,并在各种图像和视频识别任务的推理和训练中实现了卓越的准确性和速度。该方法表明,视觉任务所需的空间偏差可以通过适当的预训练有效地学习,从而消除了增加架构复杂性的必要。
论文摘要如下:
为了追求监督分类性能,现代层级化视觉 Transformer 增加了许多视觉特定的组件。虽然这些组件带来了有效的准确率和理想的 FLOPs 数,但增加的复杂性实际上使得这些 Transformer 比同类的 vanilla ViT 更慢。在本文中,我们认为这些额外的臃肿是不必要的。通过利用强大的视觉预训练任务(MAE)进行预训练,我们可以在不损失准确性的情况下,从最先进的多阶段视觉 Transformer 中剔除所有“花哨功能”。在此过程中,我们创建了 Hiera,这是一个极其简单的层级化视觉 Transformer,它比之前的模型更准确,同时在推理和训练过程中都明显更快。我们评估了 Hiera 在各种图像和视频识别任务上的表现。我们的代码和模型可在 https://github.com/facebookresearch/hiera 获取。
Hiera 架构。摘自原论文。此模型由 EduardoPacheco 和 namangarg110 共同贡献。原始代码可以在 [此处] (https://github.com/facebookresearch/hiera) 找到。
资源
这是一份官方 Hugging Face 和社区(以 🌎 标记)资源列表,旨在帮助您开始使用 Hiera。如果您有兴趣提交此处未包含的资源,请随时发起 Pull Request,我们将对其进行审查!理想情况下,该资源应展示一些新颖内容,而不是重复现有的资源。
- HieraForImageClassification 由此示例脚本和笔记本支持。
- 另请参阅:图像分类任务指南
HieraConfig
class transformers.HieraConfig
< source >( transformers_version: str | None = None architectures: list[str] | None = None output_hidden_states: bool | None = False return_dict: bool | None = True dtype: typing.Union[str, ForwardRef('torch.dtype'), NoneType] = None chunk_size_feed_forward: int = 0 is_encoder_decoder: bool = False id2label: dict[int, str] | dict[str, str] | None = None label2id: dict[str, int] | dict[str, str] | None = None problem_type: typing.Optional[typing.Literal['regression', 'single_label_classification', 'multi_label_classification']] = None embed_dim: int = 96 image_size: list[int] | tuple[int, ...] = (224, 224) patch_size: list[int] | tuple[int, ...] = (7, 7) patch_stride: list[int] | tuple[int, ...] = (4, 4) patch_padding: list[int] | tuple[int, ...] = (3, 3) mlp_ratio: float = 4.0 depths: list[int] | tuple[int, ...] = (2, 3, 16, 3) num_heads: list[int] | tuple[int, ...] = (1, 2, 4, 8) embed_dim_multiplier: float | int = 2.0 num_query_pool: int = 3 query_stride: list[int] | tuple[int, ...] = (2, 2) masked_unit_size: list[int] | tuple[int, ...] = (8, 8) masked_unit_attention: list[bool] | tuple[bool, ...] = (True, True, False, False) drop_path_rate: float | int = 0.0 num_channels: int = 3 hidden_act: str = 'gelu' initializer_range: float = 0.02 layer_norm_init: float = 1.0 layer_norm_eps: float = 1e-06 decoder_hidden_size: int | None = None decoder_depth: int | None = None decoder_num_heads: int | None = None normalize_pixel_loss: bool | None = True mask_ratio: float = 0.6 _out_features: list[str] | None = None _out_indices: list[int] | None = None )
参数
- embed_dim (
int, 可选, 默认为96) — 嵌入层和隐藏状态的维度。 - image_size (
Union[list[int], tuple[int, ...]], 可选, 默认为(224, 224)) — 每个图像的大小(分辨率)。 - patch_size (
Union[list[int], tuple[int, ...]], 可选, 默认为(7, 7)) — 每个补丁的大小(分辨率)。 - patch_stride (
list(int), 可选, 默认为[4, 4]) — 补丁的步幅。 - patch_padding (
list(int), 可选, 默认为[3, 3]) — 补丁的填充。 - mlp_ratio (
float, 可选, 默认为4.0) — MLP 隐藏维度与嵌入维度的比例。 - depths (
Union[list[int], tuple[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 (
Union[float, int], 可选, 默认为0.0) — 补丁融合的 Drop path 率。 - num_channels (
int, 可选, 默认为3) — 输入通道的数量。 - hidden_act (
str, 可选, 默认为gelu) — 解码器中的非线性激活函数(函数或字符串)。例如,"gelu"、"relu"、"silu"等。 - initializer_range (
float, 可选, 默认为0.02) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。 - layer_norm_init (
float, 可选, 默认为 1.0) — 层归一化层的初始权重值。 - layer_norm_eps (
float, 可选, 默认为1e-06) — 层归一化层使用的 epsilon。 - decoder_hidden_size (
int, 可选) — 隐藏表示的维度。 - decoder_depth (
int, 可选) — MAE 预训练解码器的深度。 - decoder_num_heads (
int, 可选) — Transformer 解码器中每个注意力层的注意力头数。 - normalize_pixel_loss (
bool, 可选, 默认为True) — 是否按像素数量归一化像素损失。 - mask_ratio (
float, 可选, 默认为 0.6) — 输入中遮蔽标记的比例。
这是用于存储 HieraModel 配置的配置类。它用于根据指定的参数实例化 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.configHieraModel
class transformers.HieraModel
< source >( 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 Module 一样使用它,并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( pixel_values: torch.Tensor | None = None noise: torch.FloatTensor | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None interpolate_pos_encoding: bool | None = None return_dict: bool | None = None **kwargs ) → BaseModelOutputWithPooling 或 tuple(torch.FloatTensor)
参数
- pixel_values (形状为
(batch_size, num_channels, image_size, image_size)的torch.Tensor, 可选) — 对应于输入图像的张量。可以使用 BitImageProcessor 获取像素值。有关详细信息,请参阅BitImageProcessor.__call__()(processor_class使用 BitImageProcessor 处理图像)。 - noise (形状为
(batch_size, num_mask_units)的torch.FloatTensor, 可选) — 主要用于测试目的,以控制随机性并保持可重现性。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的hidden_states。 - interpolate_pos_encoding (
bool, 可选) — 是否对预训练的位置编码进行插值。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回
BaseModelOutputWithPooling or tuple(torch.FloatTensor)
BaseModelOutputWithPooling 或 torch.FloatTensor 元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),根据配置(HieraConfig)和输入,包含各种元素。
HieraModel 的 forward 方法,重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义,但你应该在之后调用
Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。
last_hidden_state (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。pooler_output (
torch.FloatTensor,形状为(batch_size, hidden_size)) — 序列第一个 token(分类 token)在进一步通过用于辅助预训练任务的层后的最后一个隐藏状态。例如,对于 BERT 系列模型,这会返回经过线性层和 tanh 激活函数处理后的分类 token。线性层的权重是通过预训练期间的下一句预测(分类)目标来训练的。hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组(一个用于嵌入层的输出,如果模型有嵌入层;+一个用于每个层的输出),形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组(每个层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均值。
HieraForPreTraining
class transformers.HieraForPreTraining
< source >( config: HieraConfig )
参数
- config (HieraConfig) — 模型配置类,包含模型的所有参数。使用配置文件进行初始化不会加载与模型相关的权重,仅加载配置。查看 from_pretrained() 方法以加载模型权重。
顶部带有解码器的 Hiera 模型 Transformer,用于自监督预训练。
请注意,我们在 examples directory 中提供了一个脚本,用于在自定义数据上预训练此模型。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、剪枝头部等)。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它,并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( pixel_values: torch.Tensor | None = None noise: torch.FloatTensor | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None interpolate_pos_encoding: bool | None = None return_dict: bool | None = None **kwargs ) → HieraForPreTrainingOutput 或 tuple(torch.FloatTensor)
参数
- pixel_values (形状为
(batch_size, num_channels, image_size, image_size)的torch.Tensor, 可选) — 对应于输入图像的张量。可以使用 BitImageProcessor 获取像素值。有关详细信息,请参阅BitImageProcessor.__call__()(processor_class使用 BitImageProcessor 处理图像)。 - noise (形状为
(batch_size, num_mask_units)的torch.FloatTensor, 可选) — 主要用于测试目的,以控制随机性并保持可重现性。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的hidden_states。 - interpolate_pos_encoding (
bool, 可选) — 是否对预训练的位置编码进行插值。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回
HieraForPreTrainingOutput 或 tuple(torch.FloatTensor)
一个 HieraForPreTrainingOutput 或 torch.FloatTensor 元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),根据配置(HieraConfig)和输入,包含各种元素。
HieraForPreTraining 的 forward 方法,重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义,但你应该在之后调用
Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。
loss (
torch.FloatTensor,形状为(1,)) — 像素重建损失。logits (形状为
(batch_size, sequence_length, patch_size ** 2 * num_channels)的torch.FloatTensor) — 像素重建 logits。bool_masked_pos (形状为
(batch_size, sequence_length)的torch.BoolTensor) — 指示哪些补丁被遮蔽(0)以及哪些未被遮蔽(1)的张量。ids_restore (形状为
(batch_size, sequence_length)的torch.LongTensor) — 包含(混洗后的)遮蔽补丁原始索引的张量。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)。模型在每一层输出时的隐藏状态,加上重塑以包含空间维度的初始嵌入输出。
示例
>>> from transformers import AutoImageProcessor, HieraForPreTraining
>>> import torch
>>> from PIL import Image
>>> import httpx
>>> from io import BytesIO
>>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
>>> with httpx.stream("GET", url) as response:
... image = Image.open(BytesIO(response.read()))
>>> 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
< 源码 >( config: HieraConfig )
参数
- config (HieraConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载模型相关的权重,仅加载配置。查看 from_pretrained() 方法以加载模型权重。
带有图像分类头的 Hiera 模型(在最终隐藏状态之上有一个线性层,并进行了平均池化),例如用于 ImageNet。
注意:通过在模型的 forward 方法中将
interpolate_pos_encoding设置为True,可以在比训练时分辨率更高的图像上对 Hiera 进行微调。这将把预训练的位置编码插值到更高的分辨率。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、剪枝头部等)。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它,并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源码 >( pixel_values labels: torch.Tensor | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None interpolate_pos_encoding: bool | None = None return_dict: bool | None = None **kwargs ) → HieraForImageClassificationOutput 或 tuple(torch.FloatTensor)
参数
- pixel_values (`
形状为(batch_size, num_channels, image_size, image_size)的张量`) -- 输入图像对应的张量。像素值可以使用 [BitImageProcessor](/docs/transformers/v5.10.2/en/model_doc/bit#transformers.BitImageProcessor) 获取。详情请参阅BitImageProcessor.call()`(`processor_class` 使用 BitImageProcessor 处理图像)。 - 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 而不是普通元组。
返回
HieraForImageClassificationOutput 或 tuple(torch.FloatTensor)
HieraForImageClassificationOutput 或 torch.FloatTensor 元组(如果传入 return_dict=False 或 config.return_dict=False 时),根据配置 (HieraConfig) 和输入包含各种元素。
HieraForImageClassification 的 forward 方法,覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义,但你应该在之后调用
Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。
loss (
torch.FloatTensor,形状为(1,),可选) — 训练任务的损失值。logits (
torch.FloatTensor,形状为(batch_size, num_labels)) — 分类头的预测分数(输出层的逻辑值)。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)。这是模型重塑和重新展开后的隐藏状态。模型在每层输出处的隐藏状态,以及重新调整以包含空间维度的初始嵌入输出。
示例
>>> 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])
...