Transformers 文档

SegFormer

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

SegFormer

PyTorch TensorFlow

概述

SegFormer 模型由 Enze Xie、Wenhai Wang、Zhiding Yu、Anima Anandkumar、Jose M. Alvarez 和 Ping Luo 在论文《SegFormer:简单高效的Transformer语义分割设计》中提出。该模型由一个分层 Transformer 编码器和一个轻量级的全 MLP 解码头组成,在 ADE20K 和 Cityscapes 等图像分割基准测试中取得了优异的成果。

论文摘要如下:

我们提出了 SegFormer,一个简单、高效且强大的语义分割框架,它将 Transformer 与轻量级多层感知器(MLP)解码器统一起来。SegFormer 有两个吸引人的特点:1) SegFormer 包含一个新颖的分层结构 Transformer 编码器,可输出多尺度特征。它不需要位置编码,从而避免了位置编码的插值,当测试分辨率与训练分辨率不同时,这会导致性能下降。2) SegFormer 避免了复杂的解码器。所提出的 MLP 解码器聚合来自不同层的信息,从而结合局部注意力和全局注意力来呈现强大的表示。我们表明,这种简单轻量化的设计是在 Transformer 上实现高效分割的关键。我们扩展我们的方法,得到从 SegFormer-B0 到 SegFormer-B5 的一系列模型,达到了比以往同类模型显著更好的性能和效率。例如,SegFormer-B4 在 ADE20K 上以 64M 参数实现了 50.3% 的 mIoU,比之前最好的方法小 5 倍,性能好 2.2%。我们最好的模型 SegFormer-B5 在 Cityscapes 验证集上达到了 84.0% 的 mIoU,并在 Cityscapes-C 上展现了出色的零样本鲁棒性。

下图说明了 SegFormer 的架构。摘自原始论文

此模型由 nielsr 贡献。模型的 TensorFlow 版本由 sayakpaul 贡献。原始代码可以在这里找到。

使用技巧

  • SegFormer 由一个分层 Transformer 编码器和一个轻量级的全 MLP 解码头组成。`SegformerModel` 是分层 Transformer 编码器(在论文中也称为 Mix Transformer 或 MiT)。`SegformerForSemanticSegmentation` 在其之上添加了全 MLP 解码头以执行图像的语义分割。此外,还有 `SegformerForImageClassification`,可用于——你猜对了——对图像进行分类。SegFormer 的作者首先在 ImageNet-1k 上对 Transformer 编码器进行预训练以对图像进行分类。接下来,他们扔掉分类头,并用全 MLP 解码头取而代之。然后,他们将整个模型在 ADE20K、Cityscapes 和 COCO-stuff 上进行微调,这些都是语义分割的重要基准。所有检查点都可以在模型中心上找到。
  • 开始使用 SegFormer 的最快方法是查看示例笔记本(其中展示了推理和在自定义数据上进行微调)。也可以查看介绍 SegFormer 并说明如何在自定义数据上进行微调的博文
  • TensorFlow 用户应参考此仓库,其中展示了开箱即用的推理和微调。
  • 您也可以在Hugging Face Spaces 上的这个交互式演示中尝试在自定义图像上使用 SegFormer 模型。
  • SegFormer 适用于任何输入尺寸,因为它会将输入填充为 `config.patch_sizes` 的倍数。
  • 可以使用 `SegformerImageProcessor` 为模型准备图像和相应的分割图。请注意,这个图像处理器相当基础,不包括原始论文中使用的所有数据增强。原始的预处理流程(例如,用于 ADE20k 数据集)可以在这里找到。最重要的预处理步骤是,图像和分割图被随机裁剪和填充到相同的大小,例如 512x512 或 640x640,然后进行归一化。
  • 另外需要记住的一点是,在初始化 `SegformerImageProcessor` 时,可以将 `do_reduce_labels` 设置为 `True` 或 `False`。在某些数据集中(如 ADE20k),标注的分割图中索引 0 用于背景。然而,ADE20k 在其 150 个标签中不包括“背景”类。因此,`do_reduce_labels` 用于将所有标签减 1,并确保不为背景类计算损失(即,它将标注图中的 0 替换为 255,这是 `SegformerForSemanticSegmentation` 使用的损失函数的 *ignore_index*)。然而,其他数据集使用索引 0 作为背景类,并将此类作为所有标签的一部分。在这种情况下,`do_reduce_labels` 应设置为 `False`,因为也应该为背景类计算损失。
  • 与大多数模型一样,SegFormer 有不同的尺寸,其详细信息可在下表中找到(摘自原始论文的表7)。
模型变体 深度 隐藏层大小 解码器隐藏层大小 参数 (M) ImageNet-1k Top 1 准确率
MiT-b0 [2, 2, 2, 2] [32, 64, 160, 256] 256 3.7 70.5
MiT-b1 [2, 2, 2, 2] [64, 128, 320, 512] 256 14.0 78.7
MiT-b2 [3, 4, 6, 3] [64, 128, 320, 512] 768 25.4 81.6
MiT-b3 [3, 4, 18, 3] [64, 128, 320, 512] 768 45.2 83.1
MiT-b4 [3, 8, 27, 3] [64, 128, 320, 512] 768 62.6 83.6
MiT-b5 [3, 6, 40, 3] [64, 128, 320, 512] 768 82.0 83.8

请注意,上表中的 MiT 指的是 SegFormer 中引入的 Mix Transformer 编码器主干。关于 SegFormer 在 ADE20k 等分割数据集上的结果,请参阅论文

资源

一系列官方 Hugging Face 和社区(由 🌎 标志)资源,帮助您开始使用 SegFormer。

图像分类

语义分割

如果您有兴趣在此处提交资源,请随时开启 Pull Request,我们将对其进行审查!该资源最好能展示一些新内容,而不是重复现有资源。

SegformerConfig

class transformers.SegformerConfig

< >

( num_channels = 3 num_encoder_blocks = 4 depths = [2, 2, 2, 2] sr_ratios = [8, 4, 2, 1] hidden_sizes = [32, 64, 160, 256] patch_sizes = [7, 3, 3, 3] strides = [4, 2, 2, 2] num_attention_heads = [1, 2, 5, 8] mlp_ratios = [4, 4, 4, 4] hidden_act = 'gelu' hidden_dropout_prob = 0.0 attention_probs_dropout_prob = 0.0 classifier_dropout_prob = 0.1 initializer_range = 0.02 drop_path_rate = 0.1 layer_norm_eps = 1e-06 decoder_hidden_size = 256 semantic_loss_ignore_index = 255 **kwargs )

参数

  • num_channels (int, 可选, 默认为 3) — 输入通道的数量。
  • num_encoder_blocks (int, 可选, 默认为 4) — 编码器块的数量(即 Mix Transformer 编码器中的阶段数)。
  • depths (list[int], 可选, 默认为 [2, 2, 2, 2]) — 每个编码器块中的层数。
  • sr_ratios (list[int], 可选, 默认为 [8, 4, 2, 1]) — 每个编码器块中的序列缩减比率。
  • hidden_sizes (list[int], 可选, 默认为 [32, 64, 160, 256]) — 每个编码器块的维度。
  • patch_sizes (list[int], 可选, 默认为 [7, 3, 3, 3]) — 每个编码器块之前的补丁大小。
  • strides (list[int], 可选, 默认为 [4, 2, 2, 2]) — 每个编码器块之前的步幅。
  • num_attention_heads (list[int], 可选, 默认为 [1, 2, 5, 8]) — Transformer 编码器中每个块的每个注意力层的注意力头数量。
  • mlp_ratios (list[int], 可选, 默认为 [4, 4, 4, 4]) — 编码器块中 Mix FFNs 的隐藏层大小与输入层大小的比率。
  • hidden_act (strfunction, 可选, 默认为 "gelu") — 编码器和池化器中的非线性激活函数(函数或字符串)。如果为字符串,支持 "gelu""relu""selu""gelu_new"
  • hidden_dropout_prob (float, 可选, 默认为 0.0) — 嵌入层、编码器和池化器中所有全连接层的丢弃概率。
  • attention_probs_dropout_prob (float, 可选, 默认为 0.0) — 注意力概率的丢弃率。
  • classifier_dropout_prob (float, 可选, 默认为 0.1) — 分类头之前的丢弃概率。
  • initializer_range (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
  • drop_path_rate (float, 可选, 默认为 0.1) — 随机深度的丢弃概率,用于 Transformer 编码器的块中。
  • layer_norm_eps (float, 可选, 默认为 1e-06) — 层归一化层使用的 epsilon 值。
  • decoder_hidden_size (int, 可选, 默认为 256) — 全 MLP 解码头的维度。
  • semantic_loss_ignore_index (int, 可选, 默认为 255) — 语义分割模型的损失函数忽略的索引。

这是用于存储 `SegformerModel` 配置的配置类。它用于根据指定的参数实例化 SegFormer 模型,定义模型架构。使用默认值实例化配置将产生与 SegFormer nvidia/segformer-b0-finetuned-ade-512-512 架构类似的配置。

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

示例

>>> from transformers import SegformerModel, SegformerConfig

>>> # Initializing a SegFormer nvidia/segformer-b0-finetuned-ade-512-512 style configuration
>>> configuration = SegformerConfig()

>>> # Initializing a model from the nvidia/segformer-b0-finetuned-ade-512-512 style configuration
>>> model = SegformerModel(configuration)

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

SegformerFeatureExtractor

class transformers.SegformerFeatureExtractor

< >

( *args **kwargs )

__call__

< >

( images segmentation_maps = None **kwargs )

预处理一批图像和可选的分割图。

重写 `Preprocessor` 类的 `__call__` 方法,以便图像和分割图都可以作为位置参数传入。

post_process_semantic_segmentation

< >

( outputs target_sizes: typing.Optional[list[tuple]] = None ) semantic_segmentation

参数

  • outputs (`SegformerForSemanticSegmentation`) — 模型的原始输出。
  • target_sizes (list[Tuple], 长度为 batch_size, 可选) — 对应于每个预测请求的最终尺寸(高、宽)的元组列表。如果未设置,预测将不会被调整大小。

返回

语义分割

长度为 `batch_size` 的 `list[torch.Tensor]`,其中每个元素是形状为(高,宽)的语义分割图,对应于 `target_sizes` 条目(如果指定了 `target_sizes`)。每个 `torch.Tensor` 的每个条目对应一个语义类别 ID。

`SegformerForSemanticSegmentation` 的输出转换为语义分割图。仅支持 PyTorch。

SegformerImageProcessor

class transformers.SegformerImageProcessor

< >

( do_resize: bool = True size: typing.Optional[dict[str, int]] = None resample: Resampling = <Resampling.BILINEAR: 2> do_rescale: bool = True rescale_factor: typing.Union[int, float] = 0.00392156862745098 do_normalize: bool = True image_mean: typing.Union[float, list[float], NoneType] = None image_std: typing.Union[float, list[float], NoneType] = None do_reduce_labels: bool = False **kwargs )

参数

  • do_resize (bool, 可选, 默认为 True) — 是否将图像的(高,宽)尺寸调整为指定的 `(size["height"], size["width"])`。可在 `preprocess` 方法中通过 `do_resize` 参数覆盖。
  • size (dict[str, int] 可选, 默认为 {"height": 512, "width": 512}): 调整大小后输出图像的尺寸。可在 `preprocess` 方法中通过 `size` 参数覆盖。
  • resample (PILImageResampling, 可选, 默认为 Resampling.BILINEAR) — 调整图像大小时使用的重采样滤波器。可在 `preprocess` 方法中通过 `resample` 参数覆盖。
  • do_rescale (bool, 可选, 默认为 True) — 是否通过指定的缩放因子 `rescale_factor` 来缩放图像。可在 `preprocess` 方法中通过 `do_rescale` 参数覆盖。
  • rescale_factor (intfloat, 可选, 默认为 1/255) — 是否对图像进行归一化。可在 `preprocess` 方法中通过 `do_normalize` 参数覆盖。
  • do_normalize (bool, 可选, 默认为 True) — 是否对图像进行归一化。可在 `preprocess` 方法中通过 `do_normalize` 参数覆盖。
  • image_mean (floatlist[float], 可选, 默认为 IMAGENET_STANDARD_MEAN) — 如果对图像进行归一化,则使用的均值。这是一个浮点数或浮点数列表,其长度等于图像中的通道数。可以在 preprocess 方法中使用 image_mean 参数覆盖此值。
  • image_std (floatlist[float], 可选, 默认为 IMAGENET_STANDARD_STD) — 如果对图像进行归一化,则使用的标准差。这是一个浮点数或浮点数列表,其长度等于图像中的通道数。可以在 preprocess 方法中使用 image_std 参数覆盖此值。
  • do_reduce_labels (bool, 可选, 默认为 False) — 是否将分割图的所有标签值减 1。通常用于背景标签为 0,且背景本身不包含在数据集的所有类别中的数据集(例如 ADE20k)。背景标签将被替换为 255。可以在 preprocess 方法中使用 do_reduce_labels 参数覆盖此值。

构造一个 Segformer 图像处理器。

preprocess

< >

( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']] segmentation_maps: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor'], NoneType] = None do_resize: typing.Optional[bool] = None size: typing.Optional[dict[str, int]] = None resample: Resampling = None do_rescale: typing.Optional[bool] = None rescale_factor: typing.Optional[float] = None do_normalize: typing.Optional[bool] = None image_mean: typing.Union[float, list[float], NoneType] = None image_std: typing.Union[float, list[float], NoneType] = None do_reduce_labels: typing.Optional[bool] = None return_tensors: typing.Union[str, transformers.utils.generic.TensorType, NoneType] = None data_format: ChannelDimension = <ChannelDimension.FIRST: 'channels_first'> input_data_format: typing.Union[str, transformers.image_utils.ChannelDimension, NoneType] = None )

参数

  • images (ImageInput) — 待预处理的图像。需要单个或一批像素值在 0 到 255 范围内的图像。如果传入像素值在 0 到 1 之间的图像,请设置 do_rescale=False
  • segmentation_maps (ImageInput, 可选) — 待预处理的分割图。
  • do_resize (bool, 可选, 默认为 self.do_resize) — 是否调整图像大小。
  • size (dict[str, int], 可选, 默认为 self.size) — 应用 resize 后的图像尺寸。
  • resample (int, 可选, 默认为 self.resample) — 调整图像大小时使用的重采样过滤器。可以是 PILImageResampling 枚举之一。仅当 do_resize 设置为 True 时有效。
  • do_rescale (bool, 可选, 默认为 self.do_rescale) — 是否将图像像素值缩放到 [0 - 1] 之间。
  • rescale_factor (float, 可选, 默认为 self.rescale_factor) — 如果 do_rescale 设置为 True,则用于缩放图像的比例因子。
  • do_normalize (bool, 可选, 默认为 self.do_normalize) — 是否对图像进行归一化。
  • image_mean (floatlist[float], 可选, 默认为 self.image_mean) — 图像均值。
  • image_std (floatlist[float], 可选, 默认为 self.image_std) — 图像标准差。
  • do_reduce_labels (bool, 可选, 默认为 self.do_reduce_labels) — 是否将分割图的所有标签值减 1。通常用于背景标签为 0,且背景本身不包含在数据集的所有类别中的数据集(例如 ADE20k)。背景标签将被替换为 255。
  • return_tensors (strTensorType, 可选) — 返回的张量类型。可以是以下之一:
    • 未设置:返回一个 np.ndarray 列表。
    • TensorType.TENSORFLOW'tf':返回一个 tf.Tensor 类型的批次。
    • TensorType.PYTORCH'pt':返回一个 torch.Tensor 类型的批次。
    • TensorType.NUMPY'np':返回一个 np.ndarray 类型的批次。
    • TensorType.JAX'jax':返回一个 jax.numpy.ndarray 类型的批次。
  • data_format (ChannelDimensionstr, 可选, 默认为 ChannelDimension.FIRST) — 输出图像的通道维度格式。可以是以下之一:
    • ChannelDimension.FIRST:图像格式为 (num_channels, height, width)。
    • ChannelDimension.LAST:图像格式为 (height, width, num_channels)。
  • input_data_format (ChannelDimensionstr, 可选) — 输入图像的通道维度格式。如果未设置,则从输入图像中推断通道维度格式。可以是以下之一:
    • "channels_first"ChannelDimension.FIRST:图像格式为 (num_channels, height, width)。
    • "channels_last"ChannelDimension.LAST:图像格式为 (height, width, num_channels)。
    • "none"ChannelDimension.NONE:图像格式为 (height, width)。

预处理一张或一批图像。

post_process_semantic_segmentation

< >

( outputs target_sizes: typing.Optional[list[tuple]] = None ) semantic_segmentation

参数

  • outputs (SegformerForSemanticSegmentation) — 模型的原始输出。
  • target_sizes (长度为 batch_sizelist[Tuple], 可选) — 对应于每个预测所需的最终尺寸 (height, width) 的元组列表。如果未设置,预测将不会被调整大小。

返回

语义分割

长度为 `batch_size` 的 `list[torch.Tensor]`,其中每个元素是形状为(高,宽)的语义分割图,对应于 `target_sizes` 条目(如果指定了 `target_sizes`)。每个 `torch.Tensor` 的每个条目对应一个语义类别 ID。

`SegformerForSemanticSegmentation` 的输出转换为语义分割图。仅支持 PyTorch。

Pytorch
隐藏 Pytorch 内容

SegformerModel

class transformers.SegformerModel

< >

( config )

参数

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

原始的 Segformer 模型,输出原始的隐藏状态,顶部没有任何特定的头部。

该模型继承自 PreTrainedModel。有关该库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头部等),请查看超类文档。

该模型也是一个 PyTorch torch.nn.Module 子类。可以像常规 PyTorch 模块一样使用它,并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。

forward

< >

( pixel_values: FloatTensor output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) transformers.modeling_outputs.BaseModelOutputtuple(torch.FloatTensor)

参数

  • pixel_values (形状为 (batch_size, num_channels, image_size, image_size)torch.FloatTensor) — 对应于输入图像的张量。可以使用 {image_processor_class} 获取像素值。有关详细信息,请参见 {image_processor_class}.__call__{processor_class} 使用 {image_processor_class} 处理图像)。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息,请参见返回张量下的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息,请参见返回张量下的 hidden_states
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。

返回

transformers.modeling_outputs.BaseModelOutputtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.BaseModelOutput 或一个 torch.FloatTensor 元组(如果传递 return_dict=Falseconfig.return_dict=False),包含根据配置(SegformerConfig)和输入的不同元素。

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

  • hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(如果模型有嵌入层,则第一个是嵌入层的输出,然后是每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每个层输出的隐藏状态以及可选的初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — torch.FloatTensor 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

SegformerModel 的 forward 方法覆盖了 __call__ 特殊方法。

虽然前向传播的流程需要在此函数内定义,但之后应调用 Module 实例而不是此函数,因为前者会处理预处理和后处理步骤,而后者会静默忽略它们。

示例

SegformerDecodeHead

class transformers.SegformerDecodeHead

< >

( config )

forward

< >

( encoder_hidden_states: FloatTensor )

SegformerForImageClassification

class transformers.SegformerForImageClassification

< >

( config )

参数

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

SegFormer 模型,顶部带有一个图像分类头(在最终隐藏状态之上加一个线性层),例如用于 ImageNet。

该模型继承自 PreTrainedModel。有关该库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头部等),请查看超类文档。

该模型也是一个 PyTorch torch.nn.Module 子类。可以像常规 PyTorch 模块一样使用它,并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。

forward

< >

( pixel_values: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) transformers.models.segformer.modeling_segformer.SegFormerImageClassifierOutputtuple(torch.FloatTensor)

参数

  • pixel_values (形状为 (batch_size, num_channels, image_size, image_size)torch.FloatTensor, 可选) — 对应于输入图像的张量。可以使用 {image_processor_class} 获取像素值。有关详细信息,请参见 {image_processor_class}.__call__{processor_class} 使用 {image_processor_class} 处理图像)。
  • labels (形状为 (batch_size,)torch.LongTensor, 可选) — 用于计算图像分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 范围内。如果 config.num_labels == 1,则计算回归损失(均方损失),如果 config.num_labels > 1,则计算分类损失(交叉熵)。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息,请参见返回张量下的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息,请参见返回张量下的 hidden_states
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。

返回

transformers.models.segformer.modeling_segformer.SegFormerImageClassifierOutputtuple(torch.FloatTensor)

一个 transformers.models.segformer.modeling_segformer.SegFormerImageClassifierOutput 或一个 torch.FloatTensor 元组(如果传递 return_dict=Falseconfig.return_dict=False),包含根据配置(SegformerConfig)和输入的不同元素。

  • loss (形状为 (1,)torch.FloatTensor可选,当提供 labels 时返回) — 分类损失(如果 config.num_labels==1,则为回归损失)。

  • logits (形状为 (batch_size, config.num_labels)torch.FloatTensor) — 分类(如果 config.num_labels==1,则为回归)分数(SoftMax 之前)。

  • hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(如果模型有嵌入层,则第一个是嵌入层的输出,然后是每个阶段的输出),形状为 (batch_size, num_channels, height, width)。模型在每个阶段输出的隐藏状态(也称为特征图)。

  • attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — torch.FloatTensor 的元组(每一层一个),形状为 (batch_size, num_heads, patch_size, sequence_length)

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

SegformerForImageClassification 的 forward 方法覆盖了 __call__ 特殊方法。

虽然前向传播的流程需要在此函数内定义,但之后应调用 Module 实例而不是此函数,因为前者会处理预处理和后处理步骤,而后者会静默忽略它们。

示例

>>> from transformers import AutoImageProcessor, SegformerForImageClassification
>>> import torch
>>> from datasets import load_dataset

>>> dataset = load_dataset("huggingface/cats-image")
>>> image = dataset["test"]["image"][0]

>>> image_processor = AutoImageProcessor.from_pretrained("nvidia/segformer-b0-finetuned-ade-512-512")
>>> model = SegformerForImageClassification.from_pretrained("nvidia/segformer-b0-finetuned-ade-512-512")

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

SegformerForSemanticSegmentation

class transformers.SegformerForSemanticSegmentation

< >

( config )

参数

SegFormer 模型,顶部带有一个全 MLP 解码头,例如用于 ADE20k、CityScapes。

该模型继承自 PreTrainedModel。有关该库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头部等),请查看超类文档。

该模型也是一个 PyTorch torch.nn.Module 子类。可以像常规 PyTorch 模块一样使用它,并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。

forward

< >

( pixel_values: FloatTensor labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) transformers.modeling_outputs.SemanticSegmenterOutputtuple(torch.FloatTensor)

参数

  • pixel_values (形状为 (batch_size, num_channels, image_size, image_size)torch.FloatTensor) — 对应于输入图像的张量。可以使用 {image_processor_class} 获取像素值。有关详细信息,请参见 {image_processor_class}.__call__{processor_class} 使用 {image_processor_class} 处理图像)。
  • labels (形状为 (batch_size, height, width)torch.LongTensor, 可选) — 用于计算损失的真实语义分割图。索引应在 [0, ..., config.num_labels - 1] 范围内。如果 config.num_labels > 1,则计算分类损失(交叉熵)。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的 hidden_states
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。

返回

transformers.modeling_outputs.SemanticSegmenterOutputtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.SemanticSegmenterOutput 或一个 torch.FloatTensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),根据配置(SegformerConfig)和输入,包含不同的元素。

  • loss (形状为 (1,)torch.FloatTensor可选,当提供 labels 时返回) — 分类损失(如果 config.num_labels==1,则为回归损失)。

  • logits (形状为 (batch_size, config.num_labels, logits_height, logits_width)torch.FloatTensor) — 每个像素的分类分数。

    返回的 logits 不一定与作为输入传递的 pixel_values 具有相同的大小。这是为了避免当用户需要将 logits 调整到原始图像大小作为后处理时,进行两次插值并损失一些质量。您应始终检查 logits 的形状并根据需要进行调整。

  • hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(一个用于嵌入层的输出,如果模型有嵌入层,+ 一个用于每层的输出),形状为 (batch_size, patch_size, hidden_size)

    模型在每个层输出的隐藏状态以及可选的初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — torch.FloatTensor 的元组(每一层一个),形状为 (batch_size, num_heads, patch_size, sequence_length)

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

SegformerForSemanticSegmentation 的 forward 方法覆盖了 __call__ 特殊方法。

虽然前向传播的流程需要在此函数内定义,但之后应调用 Module 实例而不是此函数,因为前者会处理预处理和后处理步骤,而后者会静默忽略它们。

示例

>>> from transformers import AutoImageProcessor, SegformerForSemanticSegmentation
>>> from PIL import Image
>>> import requests

>>> image_processor = AutoImageProcessor.from_pretrained("nvidia/segformer-b0-finetuned-ade-512-512")
>>> model = SegformerForSemanticSegmentation.from_pretrained("nvidia/segformer-b0-finetuned-ade-512-512")

>>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
>>> image = Image.open(requests.get(url, stream=True).raw)

>>> inputs = image_processor(images=image, return_tensors="pt")
>>> outputs = model(**inputs)
>>> logits = outputs.logits  # shape (batch_size, num_labels, height/4, width/4)
>>> list(logits.shape)
[1, 150, 128, 128]
TensorFlow
隐藏 TensorFlow 内容

TFSegformerDecodeHead

class transformers.TFSegformerDecodeHead

< >

( config: SegformerConfig **kwargs )

调用

< >

( encoder_hidden_states: tf.Tensor training: bool = False )

TFSegformerModel

class transformers.TFSegformerModel

< >

( config: SegformerConfig *inputs **kwargs )

参数

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

裸 SegFormer 编码器(Mix-Transformer),输出原始的隐藏状态,顶部没有任何特定的头。此模型继承自 TFPreTrainedModel。请查阅超类文档,了解库为所有模型实现的通用方法(如下载或保存、调整输入嵌入大小、修剪头等)。

此模型也是一个 keras.Model 的子类。可以像常规 TF 2.0 Keras 模型一样使用它,并参考 TF 2.0 文档了解所有与常规用法和行为相关的事项。

调用

< >

( pixel_values: tf.Tensor output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: bool = False ) transformers.modeling_tf_outputs.TFBaseModelOutputtuple(tf.Tensor)

参数

  • pixel_values (np.ndarray, tf.Tensor, list[tf.Tensor]dict[str, tf.Tensor]dict[str, np.ndarray],并且每个示例的形状必须为 (batch_size, num_channels, height, width)) — 像素值。可以使用 AutoImageProcessor 获取像素值。有关详细信息,请参阅 SegformerImageProcessor.call()
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的 attentions。此参数只能在 eager 模式下使用,在 graph 模式下将使用配置中的值。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的 hidden_states。此参数只能在 eager 模式下使用,在 graph 模式下将使用配置中的值。
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。此参数可以在 eager 模式下使用,在 graph 模式下该值将始终设置为 True。
  • training (bool, 可选, 默认为 `False“) — 是否将模型用于训练模式(某些模块如 dropout 模块在训练和评估之间有不同的行为)。

返回

transformers.modeling_tf_outputs.TFBaseModelOutputtuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFBaseModelOutput 或一个 tf.Tensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),根据配置(SegformerConfig)和输入,包含不同的元素。

  • last_hidden_state (tf.Tensor of shape (batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。

  • hidden_states (tuple(tf.FloatTensor), 可选, 当传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — tf.Tensor 的元组(一个用于嵌入层的输出 + 一个用于每层的输出),形状为 (batch_size, sequence_length, hidden_size)

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

  • attentions (tuple(tf.Tensor), 可选, 当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — tf.Tensor 的元组(每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

TFSegformerModel 的 forward 方法覆盖了 __call__ 特殊方法。

虽然前向传播的流程需要在此函数内定义,但之后应调用 Module 实例而不是此函数,因为前者会处理预处理和后处理步骤,而后者会静默忽略它们。

示例

>>> from transformers import AutoImageProcessor, TFSegformerModel
>>> from datasets import load_dataset

>>> dataset = load_dataset("huggingface/cats-image")
>>> image = dataset["test"]["image"][0]

>>> image_processor = AutoImageProcessor.from_pretrained("nvidia/mit-b0")
>>> model = TFSegformerModel.from_pretrained("nvidia/mit-b0")

>>> inputs = image_processor(image, return_tensors="tf")
>>> outputs = model(**inputs)

>>> last_hidden_states = outputs.last_hidden_state
>>> list(last_hidden_states.shape)
[1, 256, 16, 16]

TFSegformerForImageClassification

class transformers.TFSegformerForImageClassification

< >

( config: SegformerConfig *inputs **kwargs )

参数

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

SegFormer 模型,顶部带有一个图像分类头(在最终隐藏状态之上加一个线性层),例如用于 ImageNet。

此模型继承自 TFPreTrainedModel。请查阅超类文档,了解库为所有模型实现的通用方法(如下载或保存、调整输入嵌入大小、修剪头等)。

此模型也是一个 keras.Model 的子类。可以像常规 TF 2.0 Keras 模型一样使用它,并参考 TF 2.0 文档了解所有与常规用法和行为相关的事项。

调用

< >

( pixel_values: tf.Tensor | None = None labels: tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None ) transformers.modeling_tf_outputs.TFSequenceClassifierOutputtuple(tf.Tensor)

参数

  • pixel_values (np.ndarray, tf.Tensor, list[tf.Tensor]dict[str, tf.Tensor]dict[str, np.ndarray],并且每个示例的形状必须为 (batch_size, num_channels, height, width)) — 像素值。可以使用 AutoImageProcessor 获取像素值。有关详细信息,请参阅 SegformerImageProcessor.call()
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的 attentions。此参数只能在 eager 模式下使用,在 graph 模式下将使用配置中的值。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的 hidden_states。此参数只能在 eager 模式下使用,在 graph 模式下将使用配置中的值。
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。此参数可以在 eager 模式下使用,在 graph 模式下该值将始终设置为 True。
  • training (bool, 可选, 默认为 `False“) — 是否将模型用于训练模式(某些模块如 dropout 模块在训练和评估之间有不同的行为)。

返回

transformers.modeling_tf_outputs.TFSequenceClassifierOutputtuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或一个 tf.Tensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),根据配置(SegformerConfig)和输入,包含不同的元素。

  • loss (tf.Tensor,形状为 (batch_size, )可选,当提供 labels 时返回) — 分类损失(如果 config.num_labels==1,则为回归损失)。

  • logits (tf.Tensor,形状为 (batch_size, config.num_labels)) — 分类(或回归,如果 config.num_labels==1)分数(SoftMax 之前)。

  • hidden_states (tuple(tf.Tensor), 可选, 当传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — tf.Tensor 的元组(一个用于嵌入层的输出 + 一个用于每层的输出),形状为 (batch_size, sequence_length, hidden_size)

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

  • attentions (tuple(tf.Tensor), 可选, 当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — tf.Tensor 的元组(每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

TFSegformerForImageClassification 的 forward 方法覆盖了 __call__ 特殊方法。

虽然前向传播的流程需要在此函数内定义,但之后应调用 Module 实例而不是此函数,因为前者会处理预处理和后处理步骤,而后者会静默忽略它们。

示例

>>> from transformers import AutoImageProcessor, TFSegformerForImageClassification
>>> import tensorflow as tf
>>> from datasets import load_dataset

>>> dataset = load_dataset("huggingface/cats-image"))
>>> image = dataset["test"]["image"][0]

>>> image_processor = AutoImageProcessor.from_pretrained("nvidia/mit-b0")
>>> model = TFSegformerForImageClassification.from_pretrained("nvidia/mit-b0")

>>> inputs = image_processor(image, return_tensors="tf")
>>> logits = model(**inputs).logits

>>> # model predicts one of the 1000 ImageNet classes
>>> predicted_label = int(tf.math.argmax(logits, axis=-1))
>>> print(model.config.id2label[predicted_label])
tabby, tabby cat

TFSegformerForSemanticSegmentation

class transformers.TFSegformerForSemanticSegmentation

< >

( config: SegformerConfig **kwargs )

参数

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

SegFormer 模型转换器,顶部带有一个全 MLP 解码头,例如用于 ADE20k、CityScapes。此模型继承自 TFPreTrainedModel。请查阅超类文档,了解库为所有模型实现的通用方法(如下载或保存、调整输入嵌入大小、修剪头等)。

此模型也是一个 keras.Model 的子类。可以像常规 TF 2.0 Keras 模型一样使用它,并参考 TF 2.0 文档了解所有与常规用法和行为相关的事项。

调用

< >

( pixel_values: tf.Tensor labels: tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None ) transformers.modeling_tf_outputs.TFSemanticSegmenterOutputtuple(tf.Tensor)

参数

  • pixel_values (np.ndarray, tf.Tensor, list[tf.Tensor]dict[str, tf.Tensor]dict[str, np.ndarray],并且每个示例的形状必须为 (batch_size, num_channels, height, width)) — 像素值。可以使用 AutoImageProcessor 获取像素值。有关详细信息,请参阅 SegformerImageProcessor.call()
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的 attentions。此参数只能在 eager 模式下使用,在 graph 模式下将使用配置中的值。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的 hidden_states。此参数只能在 eager 模式下使用,在 graph 模式下将使用配置中的值。
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。此参数可以在 eager 模式下使用,在 graph 模式下该值将始终设置为 True。
  • training (bool, 可选, 默认为 `False“) — 是否将模型用于训练模式(某些模块如 dropout 模块在训练和评估之间有不同的行为)。
  • labels (tf.Tensor,形状为 (batch_size, height, width)可选) — 用于计算损失的真实语义分割图。索引应在 [0, ..., config.num_labels - 1] 范围内。如果 config.num_labels > 1,则会计算(逐像素)分类损失(交叉熵)。

返回

transformers.modeling_tf_outputs.TFSemanticSegmenterOutputtuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFSemanticSegmenterOutput 或一个 tf.Tensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),根据配置(SegformerConfig)和输入,包含不同的元素。

  • loss (形状为 (1,)tf.Tensor可选,当提供 labels 时返回) — 分类(如果 config.num_labels==1,则为回归)损失。

  • logits (形状为 (batch_size, config.num_labels, logits_height, logits_width)tf.Tensor) — 每个像素的分类分数。

    返回的 logits 不一定与作为输入传递的 pixel_values 具有相同的大小。这是为了避免当用户需要将 logits 调整到原始图像大小作为后处理时,进行两次插值并损失一些质量。您应始终检查 logits 的形状并根据需要进行调整。

  • hidden_states (tuple(tf.Tensor), 可选, 当传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — tf.Tensor 的元组(一个用于嵌入层的输出,如果模型有嵌入层,+ 一个用于每层的输出),形状为 (batch_size, patch_size, hidden_size)

    模型在每个层输出的隐藏状态以及可选的初始嵌入输出。

  • attentions (tuple(tf.Tensor), 可选, 当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — tf.Tensor 的元组(每层一个),形状为 (batch_size, num_heads, patch_size, sequence_length)

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

TFSegformerForSemanticSegmentation 的 forward 方法覆盖了 __call__ 特殊方法。

虽然前向传播的流程需要在此函数内定义,但之后应调用 Module 实例而不是此函数,因为前者会处理预处理和后处理步骤,而后者会静默忽略它们。

示例

>>> from transformers import AutoImageProcessor, TFSegformerForSemanticSegmentation
>>> 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("nvidia/segformer-b0-finetuned-ade-512-512")
>>> model = TFSegformerForSemanticSegmentation.from_pretrained("nvidia/segformer-b0-finetuned-ade-512-512")

>>> inputs = image_processor(images=image, return_tensors="tf")
>>> outputs = model(**inputs, training=False)
>>> # logits are of shape (batch_size, num_labels, height/4, width/4)
>>> logits = outputs.logits
>>> list(logits.shape)
[1, 150, 128, 128]
< > 在 GitHub 上更新