Transformers 4.37 中文文档（七十一）（1）

原文：huggingface.co/docs/transformers

SegFormer

原始文本：huggingface.co/docs/transformers/v4.37.2/en/model_doc/segformer

概述

SegFormer 模型是由 Enze Xie、Wenhai Wang、Zhiding Yu、Anima Anandkumar、Jose M. Alvarez、Ping Luo 在SegFormer: Simple and Efficient Design for Semantic Segmentation with Transformers中提出的。该模型由一个分层 Transformer 编码器和一个轻量级的全 MLP 解码头组成，以在 ADE20K 和 Cityscapes 等图像分割基准上取得出色的结果。

论文摘要如下：

我们提出了 SegFormer，这是一个简单、高效但功能强大的语义分割框架，将 Transformer  与轻量级多层感知（MLP）解码器统一起来。SegFormer 具有两个吸引人的特点：1）SegFormer 包括一个新颖的分层结构  Transformer  编码器，输出多尺度特征。它不需要位置编码，因此避免了位置代码的插值，这会导致测试分辨率与训练不同时性能下降。2）SegFormer  避免了复杂的解码器。所提出的 MLP  解码器从不同层中聚合信息，从而结合了局部注意力和全局注意力，以生成强大的表示。我们展示了这种简单且轻量级的设计是实现 Transformer  上高效分割的关键。我们将我们的方法扩展到从 SegFormer-B0 到 SegFormer-B5  的一系列模型，达到了比以前更好的性能和效率。例如，SegFormer-B4 在 ADE20K 上达到了 50.3%的 mIoU，参数为  64M，比以前最佳方法小 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 上一起对模型进行微调，这些是语义分割的重要基准。所有检查点都可以在hub上找到。
  
• 使用 SegFormer 的最快方法是查看示例笔记本（展示了推理和在自定义数据上微调的示例）。也可以查看博客文章介绍 SegFormer 并说明如何在自定义数据上进行微调。
  
• TensorFlow 用户应参考此存储库，展示现成的推理和微调。
  
• 您也可以查看Hugging Face Spaces 上的交互式演示，尝试在自定义图像上使用 SegFormer 模型。
  
• SegFormer 适用于任何输入大小，因为它会填充输入，使其可以被config.patch_sizes整除。
  
• 可以使用 SegformerImageProcessor 为模型准备图像和相应的分割图。请注意，此图像处理器相当基础，不包括原始论文中使用的所有数据增强。原始预处理流程（例如 ADE20k 数据集）可以在这里找到。最重要的预处理步骤是将图像和分割图随机裁剪和填充到相同大小，例如 512x512 或 640x640，然后进行归一化。
  
• 还有一件事要记住的是，可以使用reduce_labels设置为True或False来初始化 SegformerImageProcessor。在一些数据集（如 ADE20k）中，0 索引用于背景的注释分割图。但是，ADE20k 不包括其 150 个标签中的“背景”类。因此，reduce_labels用于减少所有标签 1，并确保不为背景类计算损失（即，它将注释地图中的 0 替换为 255，这是 SegformerForSemanticSegmentation 使用的损失函数的ignore_index）。然而，其他数据集使用 0 索引作为背景类，并将此类包含在所有标签中。在这种情况下，应将reduce_labels设置为False，因为损失也应计算背景类。
  
• 与大多数模型一样，SegFormer 有不同的大小，详情可以在下表中找到（取自原始论文的表 7）。
  

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

资源

一个官方 Hugging Face 和社区（由🌎表示）资源列表，帮助您开始使用 SegFormer。

图像分类

• SegformerForImageClassification 由这个示例脚本和笔记本支持。
  
• 图像分类任务指南
  

语义分割：

• SegformerForSemanticSegmentation 由这个示例脚本支持。
  
• 关于在自定义数据集上微调 SegFormer 的博客可以在这里找到。
  
• 在 SegFormer 上有更多演示笔记本（包括对自定义数据集的推理和微调），可以在这里找到。
  
• TFSegformerForSemanticSegmentation 由这个示例笔记本支持。
  
• 语义分割任务指南
  

如果您有兴趣提交资源以包含在此处，请随时打开 Pull Request，我们将对其进行审查！资源应该展示一些新东西，而不是重复现有资源。

SegformerConfig

class transformers.SegformerConfig

< source >

( 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, optional, defaults to 3) — 输入通道的数量。
  
• num_encoder_blocks (int, optional, defaults to 4) — 编码器块的数量（即 Mix Transformer 编码器中的阶段）。
  
• depths (List[int], optional, defaults to [2, 2, 2, 2]) — 每个编码器块中的层数。
  
• sr_ratios (List[int], optional, defaults to [8, 4, 2, 1]) — 每个编码器块中的序列缩减比率。
  
• hidden_sizes (List[int], optional, defaults to [32, 64, 160, 256]) — 每个编码器块的维度。
  
• patch_sizes (List[int], optional, defaults to [7, 3, 3, 3]) — 每个编码器块之前的补丁大小。
  
• strides (List[int], optional, defaults to [4, 2, 2, 2]) — 每个编码器块之前的步幅。
  
• num_attention_heads (List[int], optional, defaults to [1, 2, 5, 8]) — 每个 Transformer 编码器块中每个注意力层的注意力头数量。
  
• mlp_ratios (List[int], optional, defaults to [4, 4, 4, 4]) — 编码器块中 Mix FFN 的隐藏层大小与输入层大小的比率。
  
• hidden_act (str or function, optional, defaults to "gelu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果是字符串，支持"gelu"、"relu"、"selu"和"gelu_new"。
  
• hidden_dropout_prob (float, optional, defaults to 0.0) — 嵌入层、编码器和池化器中所有全连接层的 dropout 概率。
  
• attention_probs_dropout_prob (float, optional, defaults to 0.0) — 注意力概率的 dropout 比率。
  
• classifier_dropout_prob (float, optional, defaults to 0.1) — 分类头之前的 dropout 概率。
  
• initializer_range (float, optional, defaults to 0.02) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。
  
• drop_path_rate (float, optional, defaults to 0.1) — 随机深度中用于块的 dropout 概率，用于 Transformer 编码器中的块。
  
• layer_norm_eps (float, optional, defaults to 1e-06) — 层归一化层使用的 epsilon。
  
• decoder_hidden_size (int, optional, defaults to 256) — 所有 MLP 解码头的维度。
  
• semantic_loss_ignore_index (int, optional, defaults to 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: List = None ) → export const metadata = 'undefined';semantic_segmentation

参数

• outputs（SegformerForSemanticSegmentation） — 模型的原始输出。
  
• target_sizes（长度为batch_size的List[Tuple]，可选） — 每个预测的请求最终大小（高度，宽度）的元组列表。如果未设置，预测将不会被调整大小。
  

返回

语义分割

长度为batch_size的List[torch.Tensor]，其中每个项目都是形状为（高度，宽度）的语义分割地图，对应于target_sizes条目（如果指定了target_sizes）。每个torch.Tensor的每个条目对应于一个语义类别 id。

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

SegformerImageProcessor

class transformers.SegformerImageProcessor

<来源>

( do_resize: bool = True size: Dict = None resample: Resampling = <Resampling.BILINEAR: 2> do_rescale: bool = True rescale_factor: Union = 0.00392156862745098 do_normalize: bool = True image_mean: Union = None image_std: Union = 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（int或float，可选，默认为1/255） — 是否对图像进行归一化。可以通过preprocess方法中的do_normalize参数进行覆盖。
  
• do_normalize (bool，可选，默认为True) — 是否对图像进行归一化。可以通过preprocess方法中的do_normalize参数进行覆盖。
  
• image_mean (float 或 List[float], 可选, 默认为 IMAGENET_STANDARD_MEAN) — 如果对图像进行归一化，要使用的均值。这是一个浮点数或与图像通道数相同长度的浮点数列表。可以通过 preprocess 方法中的 image_mean 参数覆盖。
  
• image_std (float 或 List[float], 可选, 默认为 IMAGENET_STANDARD_STD) — 如果对图像进行归一化，要使用的标准差。这是一个浮点数或与图像通道数相同长度的浮点数列表。可以通过 preprocess 方法中的 image_std 参数覆盖。
  
• do_reduce_labels (bool, 可选, 默认为 False) — 是否减少分割地图的所有标签值。通常用于数据集中将 0 用于背景，并且背景本身不包含在数据集的所有类中（例如 ADE20k）。背景标签将被替换为 255。可以通过 preprocess 方法中的 do_reduce_labels 参数覆盖。
  

构造一个 Segformer 图像处理器。

preprocess

<来源>

( images: Union segmentation_maps: Union = None do_resize: Optional = None size: Optional = None resample: Resampling = None do_rescale: Optional = None rescale_factor: Optional = None do_normalize: Optional = None image_mean: Union = None image_std: Union = None do_reduce_labels: Optional = None return_tensors: Union = None data_format: ChannelDimension = <ChannelDimension.FIRST: 'channels_first'> input_data_format: Union = None **kwargs )

参数

• 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 (float 或 List[float], 可选, 默认为 self.image_mean) — 图像均值。
  
• image_std (float 或 List[float], 可选, 默认为 self.image_std) — 图像标准差。
  
• do_reduce_labels (bool, 可选, 默认为 self.do_reduce_labels) — 是否减少分割地图的所有标签值。通常用于数据集中将 0 用于背景，并且背景本身不包含在数据集的所有类中（例如 ADE20k）。背景标签将被替换为 255。
  
• return_tensors (str 或 TensorType, 可选) — 要返回的张量类型。可以是以下之一：

• 未设置: 返回一个 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 (ChannelDimension 或 str, 可选, 默认为 ChannelDimension.FIRST) — 输出图像的通道维度格式。可以是以下之一：

• ChannelDimension.FIRST: 图像以 (通道数, 高度, 宽度) 格式。
  
• ChannelDimension.LAST: 图像以 (高度, 宽度, 通道数) 格式。
  

• input_data_format (ChannelDimension 或 str, 可选) — 输入图像的通道维度格式。如果未设置，则从输入图像中推断通道维度格式。可以是以下之一：

• "channels_first" 或 ChannelDimension.FIRST: 图像以 (通道数, 高度, 宽度) 格式。
  
• "channels_last" 或 ChannelDimension.LAST: 图像以 (高度, 宽度, 通道数) 格式。
  
• "none" 或 ChannelDimension.NONE：图像以 (高度，宽度) 格式。
  

预处理图像或图像批处理。

post_process_semantic_segmentation

< source >

( outputs target_sizes: List = None ) → export const metadata = 'undefined';semantic_segmentation

参数

• outputs (SegformerForSemanticSegmentation) — 模型的原始输出。
  
• target_sizes (List[Tuple] of length batch_size, optional) — 每个预测的请求最终大小（高度，宽度）对应的元组列表。如果未设置，预测将不会被调整大小。
  

返回

semantic_segmentation

List[torch.Tensor] of length batch_size，其中每个项目是形状为（高度，宽度）的语义分割地图，对应于 target_sizes 条目（如果指定了 target_sizes）。每个 torch.Tensor 的每个条目对应于一个语义类别 id。

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

PytorchHide Pytorch content

SegformerModel

class transformers.SegformerModel

< source >

( config )

参数

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

裸的 SegFormer 编码器（Mix-Transformer）输出原始隐藏状态，没有特定的头部。这个模型是一个 PyTorch torch.nn.Module 子类。将其用作常规的 PyTorch 模块，并参考 PyTorch 文档以获取有关一般用法和行为的所有相关信息。

forward

< source >

( pixel_values: FloatTensor output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → export const metadata = 'undefined';transformers.modeling_outputs.BaseModelOutput or tuple(torch.FloatTensor)

参数

• pixel_values (torch.FloatTensor，形状为 (batch_size, num_channels, height, width)) — 像素值。默认情况下将忽略填充。可以使用 AutoImageProcessor 获取像素值。有关详细信息，请参阅 SegformerImageProcessor.call()。
  
• output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请查看返回的张量下的 attentions。
  
• output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请查看返回的张量下的 hidden_states。
  
• return_dict (bool, optional) — 是否返回一个 ModelOutput 而不是一个普通元组。
  

返回

transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.BaseModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时）包含根据配置（SegformerConfig）和输入的各种元素。

• last_hidden_state (torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层的隐藏状态序列输出。
  
• hidden_states (tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回） — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（如果模型有嵌入层，则为嵌入输出的一个+每层输出的一个）。
  模型在每一层输出的隐藏状态以及可选的初始嵌入输出。
  
• attentions (tuple(torch.FloatTensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回） — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每层一个）。
  注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
  

SegformerModel 的前向方法，覆盖了__call__特殊方法。

虽然前向传递的步骤需要在此函数内定义，但应该在此之后调用Module实例，而不是在此处调用，因为前者会处理运行前后处理步骤，而后者会默默地忽略它们。

示例：

>>> from transformers import AutoImageProcessor, SegformerModel
>>> import torch
>>> 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 = SegformerModel.from_pretrained("nvidia/mit-b0")
>>> 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, 256, 16, 16]

SegformerDecodeHead

class transformers.SegformerDecodeHead

<来源>

( config )

forward

<来源>

( encoder_hidden_states: FloatTensor )

SegformerForImageClassification

class transformers.SegformerForImageClassification

<来源>

( config )

参数

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

SegFormer 模型变换器，顶部带有图像分类头（最终隐藏状态的线性层），例如用于 ImageNet。

这个模型是 PyTorch torch.nn.Module 的子类。将其用作常规的 PyTorch 模块，并参考 PyTorch 文档以获取与一般用法和行为相关的所有内容。

forward

<来源>

( pixel_values: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → export const metadata = 'undefined';transformers.models.segformer.modeling_segformer.SegFormerImageClassifierOutput or tuple(torch.FloatTensor)

参数

• pixel_values (torch.FloatTensor，形状为(batch_size, num_channels, height, width)) — 像素值。默认情况下将忽略填充。可以使用 AutoImageProcessor 获取像素值。有关详细信息，请参阅 SegformerImageProcessor.call()。
  
• output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的attentions。
  
• output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。
  
• return_dict (bool，可选) — 是否返回一个 ModelOutput 而不是一个普通元组。
  
• labels（形状为(batch_size,)的torch.LongTensor，可选）— 用于计算图像分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels == 1，则计算回归损失（均方损失），如果config.num_labels > 1，则计算分类损失（交叉熵）。
  

返回值

transformers.models.segformer.modeling_segformer.SegFormerImageClassifierOutput或tuple(torch.FloatTensor)

一个transformers.models.segformer.modeling_segformer.SegFormerImageClassifierOutput或一个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)的torch.FloatTensor）— 分类（或回归，如果config.num_labels==1）得分（SoftMax 之前）。
  
• hidden_states（tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回）— 形状为(batch_size, num_channels, height, width)的torch.FloatTensor元组。模型在每个阶段输出的隐藏状态（也称为特征图）。
  
• attentions（tuple(torch.FloatTensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回）— 形状为(batch_size, num_heads, patch_size, sequence_length)的torch.FloatTensor元组（每层一个）。
  在自注意力头中用于计算加权平均值的注意力 softmax 之后的注意力权重。
  

SegformerForImageClassification 的前向方法，覆盖了__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/mit-b0")
>>> model = SegformerForImageClassification.from_pretrained("nvidia/mit-b0")
>>> 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

Transformers 4.37 中文文档（七十一）（2）https://developer.aliyun.com/article/1564222