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 上以 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 上的模型进行了整体微调，这些都是语义分割的重要基准。所有检查点都可以在 hub 上找到。
- 开始使用 SegFormer 的最快方法是查看示例 notebook（其中展示了推理和在自定义数据上进行微调）。您还可以查看博客文章，其中介绍了 SegFormer 并说明了如何在自定义数据上对其进行微调。
- TensorFlow 用户应参考此存储库，其中展示了现成的推理和微调。
- 您还可以查看 Hugging Face Spaces 上的这个交互式演示，以在自定义图像上试用 SegFormer 模型。
- SegFormer 适用于任何输入大小，因为它会填充输入，使其可被
config.patch_sizes整除。 - 您可以使用 SegformerImageProcessor 来准备图像和相应的分割图以供模型使用。请注意，此图像处理器相当基础，不包括原始论文中使用的所有数据增强。原始预处理管道（例如，对于 ADE20k 数据集）可以在此处找到。最重要的预处理步骤是，图像和分割图在随机裁剪和填充到相同大小（例如 512x512 或 640x640）后进行归一化。
- 需要记住的另一件事是，可以使用设置为
True或False的do_reduce_labels初始化 SegformerImageProcessor。在某些数据集（如 ADE20k）中，索引 0 用于注释分割图中的背景。但是，ADE20k 的 150 个标签中不包含“背景”类。因此，do_reduce_labels用于将所有标签减少 1，并确保不计算背景类的损失（即，它将注释图中的 0 替换为 255，这是 SegformerForSemanticSegmentation 使用的损失函数的忽略索引）。但是，其他数据集使用索引 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。
语义分割
- SegformerForSemanticSegmentation 由此示例脚本 提供支持。
- 有关在自定义数据集上微调 SegFormer 的博客可以在此处找到。
- 有关 SegFormer 的更多演示 notebook（推理 + 在自定义数据集上进行微调）可以在此处找到。
- TFSegformerForSemanticSegmentation 由此示例 notebook 提供支持。
- 语义分割任务指南
如果您有兴趣提交资源以包含在此处，请随时打开 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, 可选, 默认为 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]) — 每个编码器块之前的 Patch 大小。 - 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 FFN 的隐藏层大小与输入层大小之比。 - hidden_act (
str或function, 可选, 默认为"gelu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果为字符串，则支持"gelu"、"relu"、"selu"和"gelu_new"。 - hidden_dropout_prob (
float, 可选, 默认为 0.0) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。 - attention_probs_dropout_prob (
float, 可选, 默认为 0.0) — 注意力概率的 dropout 比率。 - classifier_dropout_prob (
float, 可选, 默认为 0.1) — 分类头之前的 dropout 概率。 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - drop_path_rate (
float, optional, defaults to 0.1) — Transformer 编码器块中使用的随机深度 dropout 概率。 - 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.configSegformerFeatureExtractor
预处理一批图像，并可选择性地预处理分割图。
覆盖 Preprocessor 类的 __call__ 方法，以便可以将图像和分割图作为位置参数传入。
post_process_semantic_segmentation
< source >( outputs target_sizes: List = None ) → semantic_segmentation
参数
- outputs (SegformerForSemanticSegmentation) — 模型的原始输出。
- target_sizes (
List[Tuple]of lengthbatch_size, optional) — 对应于每个预测请求的最终大小（高度，宽度）的元组列表。如果未设置，则不会调整预测大小。
返回值
semantic_segmentation
长度为 batch_size 的 List[torch.Tensor]，其中每个项目是形状为 (height, width) 的语义分割图，对应于 target_sizes 条目（如果指定了 target_sizes）。每个 torch.Tensor 的每个条目对应于一个语义类别 ID。
将 SegformerForSemanticSegmentation 的输出转换为语义分割图。仅支持 PyTorch。
SegformerImageProcessor
class transformers.SegformerImageProcessor
< source >( 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, optional, defaults toTrue) — 是否将图像的（高度，宽度）尺寸调整为指定的(size["height"], size["width"])。可以被preprocess方法中的do_resize参数覆盖。 - size (
Dict[str, int]optional, defaults to{"height" -- 512, "width": 512}): 调整大小后输出图像的大小。可以被preprocess方法中的size参数覆盖。 - resample (
PILImageResampling, optional, defaults toResampling.BILINEAR) — 如果调整图像大小，则使用的重采样过滤器。可以被preprocess方法中的resample参数覆盖。 - do_rescale (
bool, optional, defaults toTrue) — 是否按指定的比例rescale_factor缩放图像。可以被preprocess方法中的do_rescale参数覆盖。 - rescale_factor (
intorfloat, optional, defaults to1/255) — 是否归一化图像。可以被preprocess方法中的do_normalize参数覆盖。 - do_normalize (
bool, optional, defaults toTrue) — 是否归一化图像。可以被preprocess方法中的do_normalize参数覆盖。 - image_mean (
floatorList[float], optional, defaults toIMAGENET_STANDARD_MEAN) — 如果归一化图像，则使用的均值。这是一个浮点数或浮点数列表，其长度是图像中通道数。可以被preprocess方法中的image_mean参数覆盖。 - image_std (
floatorList[float], optional, defaults toIMAGENET_STANDARD_STD) — 如果归一化图像，则使用的标准差。这是一个浮点数或浮点数列表，其长度是图像中通道数。可以被preprocess方法中的image_std参数覆盖。 - do_reduce_labels (
bool, optional, defaults toFalse) — 是否将分割图的所有标签值减 1。通常用于数据集，其中 0 用于背景，而背景本身不包含在数据集的所有类别中（例如 ADE20k）。背景标签将被替换为 255。可以被preprocess方法中的do_reduce_labels参数覆盖。
构造 Segformer 图像处理器。
preprocess
< source >( 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 )
参数
- images (
ImageInput) — 要预处理的图像。期望像素值范围为 0 到 255 的单个或一批图像。如果传入像素值介于 0 和 1 之间的图像，请设置do_rescale=False。 - segmentation_maps (
ImageInput, optional) — 要预处理的分割图。 - do_resize (
bool, optional, defaults toself.do_resize) — 是否调整图像大小。 - size (
Dict[str, int], optional, defaults toself.size) — 应用resize后图像的大小。 - resample (
int, optional, defaults toself.resample) — 如果调整图像大小，则使用的重采样滤波器。这可以是枚举PILImageResampling之一。仅当do_resize设置为True时才有效。 - do_rescale (
bool, optional, defaults toself.do_rescale) — 是否将图像值重新缩放到 [0 - 1] 之间。 - rescale_factor (
float, optional, defaults toself.rescale_factor) — 如果do_rescale设置为True，则通过此缩放因子来重新缩放图像。 - do_normalize (
bool, optional, defaults toself.do_normalize) — 是否标准化图像。 - image_mean (
floatorList[float], optional, defaults toself.image_mean) — 图像均值。 - image_std (
floatorList[float], optional, defaults toself.image_std) — 图像标准差。 - do_reduce_labels (
bool, optional, defaults toself.do_reduce_labels) — 是否将分割图的所有标签值减 1。通常用于数据集，其中 0 用于背景，而背景本身不包含在数据集的所有类别中（例如 ADE20k）。背景标签将被替换为 255。 - return_tensors (
strorTensorType, optional) — 要返回的张量类型。可以是以下之一：- Unset: 返回
np.ndarray列表。 TensorType.TENSORFLOW或'tf': 返回tf.Tensor类型的批次。TensorType.PYTORCH或'pt': 返回torch.Tensor类型的批次。TensorType.NUMPY或'np': 返回np.ndarray类型的批次。TensorType.JAX或'jax': 返回jax.numpy.ndarray类型的批次。
- Unset: 返回
- data_format (
ChannelDimensionorstr, optional, defaults toChannelDimension.FIRST) — 输出图像的通道维度格式。可以是以下之一：ChannelDimension.FIRST: 格式为 (num_channels, height, width) 的图像。ChannelDimension.LAST: 格式为 (height, width, num_channels) 的图像。
- input_data_format (
ChannelDimensionorstr, optional) — 输入图像的通道维度格式。如果未设置，则通道维度格式将从输入图像中推断。可以是以下之一："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
< source >( outputs target_sizes: List = None ) → semantic_segmentation
参数
- outputs (SegformerForSemanticSegmentation) — 模型的原始输出。
- target_sizes (
List[Tuple]of lengthbatch_size, optional) — 与每个预测的请求最终尺寸（高度，宽度）相对应的元组列表。如果未设置，则不会调整预测大小。
返回值
semantic_segmentation
长度为 batch_size 的 List[torch.Tensor]，其中每个项目是形状为 (height, width) 的语义分割图，对应于 target_sizes 条目（如果指定了 target_sizes）。每个 torch.Tensor 的每个条目对应于一个语义类别 ID。
将 SegformerForSemanticSegmentation 的输出转换为语义分割图。仅支持 PyTorch。
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 ) → transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
参数
- pixel_values (
torch.FloatTensorof shape(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.FloatTensorof shape(batch_size, sequence_length, hidden_size)) — 模型最后一层的输出处的隐藏状态序列。 -
hidden_states (
tuple(torch.FloatTensor), optional, returned whenoutput_hidden_states=Trueis passed or whenconfig.output_hidden_states=True) —torch.FloatTensor元组（如果模型具有嵌入层，则为嵌入的输出一个，以及每层输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每层输出处的隐藏状态，加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, returned whenoutput_attentions=Trueis passed or whenconfig.output_attentions=True) —torch.FloatTensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
SegformerModel 的 forward 方法覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数内定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoImageProcessor, SegformerModel
>>> 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("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
SegformerForImageClassification
class transformers.SegformerForImageClassification
< source >( config )
参数
- config (SegformerConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
SegFormer 模型转换器，顶部带有一个图像分类头（最终隐藏状态顶部的线性层），例如用于 ImageNet。
此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档以了解与常规用法和行为相关的所有事项。
forward
< source >( pixel_values: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.models.segformer.modeling_segformer.SegFormerImageClassifierOutput 或 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 (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算图像分类/回归损失的标签。索引应在[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 (
torch.FloatTensor，形状为(1,)，可选，当提供labels时返回) — 分类损失（或回归损失，如果 config.num_labels==1）。 -
logits (
torch.FloatTensor，形状为(batch_size, config.num_labels)) — 分类（或回归，如果 config.num_labels==1）得分（在 SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor元组（如果模型具有嵌入层，则为嵌入层的输出 + 每个阶段的输出各一个），形状为(batch_size, num_channels, height, width)。 模型在每个阶段输出的隐藏状态（也称为特征图）。 -
attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每层一个），形状为(batch_size, num_heads, patch_size, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
SegformerForImageClassification 前向方法覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数内定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoImageProcessor, SegformerForImageClassification
>>> 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("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 catSegformerForSemanticSegmentation
class transformers.SegformerForSemanticSegmentation
< source >( config )
参数
- config (SegformerConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
SegFormer 模型转换器，顶部带有全 MLP 解码头，例如用于 ADE20k、CityScapes。此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档以了解与常规用法和行为相关的所有事项。
forward
< source >( pixel_values: FloatTensor labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.SemanticSegmenterOutput 或 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 (
torch.LongTensor，形状为(batch_size, height, width)，可选) — 用于计算损失的语义分割图真实标签。索引应在[0, ..., config.num_labels - 1]中。如果config.num_labels > 1，则计算分类损失（交叉熵损失）。
返回值
transformers.modeling_outputs.SemanticSegmenterOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.SemanticSegmenterOutput 或 torch.FloatTensor 元组（如果传递 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (SegformerConfig) 和输入。
-
loss (
torch.FloatTensor，形状为(1,)，可选，当提供labels时返回) — 分类损失（或回归损失，如果 config.num_labels==1）。 -
logits (
torch.FloatTensor，形状为(batch_size, config.num_labels, logits_height, logits_width)) — 每个像素的分类得分。返回的 logits 不一定与作为输入传递的
pixel_values具有相同的大小。这是为了避免执行两次插值，并在用户需要将 logits 调整为原始图像大小时丢失一些质量作为后处理。您应始终检查 logits 形状并根据需要调整大小。 -
hidden_states (
tuple(torch.FloatTensor), 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor元组（如果模型具有嵌入层，则为嵌入层的输出 + 每层输出各一个），形状为(batch_size, patch_size, hidden_size)。模型在每层输出处的隐藏状态，加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每层一个），形状为(batch_size, num_heads, patch_size, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
SegformerForSemanticSegmentation 前向方法覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数内定义，但之后应该调用 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]TFSegformerDecodeHead
TFSegformerModel
class transformers.TFSegformerModel
< source >( config: SegformerConfig *inputs **kwargs )
参数
- config (SegformerConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法来加载模型权重。
裸 SegFormer 编码器 (Mix-Transformer)，输出原始隐藏状态，顶部没有任何特定的 head。此模型继承自 TFPreTrainedModel。请查看父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 keras.Model 子类。可将其用作常规 TF 2.0 Keras 模型，并参考 TF 2.0 文档，了解与一般用法和行为相关的所有事项。
call
< source >( 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.TFBaseModelOutput 或 tuple(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。此参数只能在立即模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在立即模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是纯元组。此参数可以在立即模式下使用，在图模式下该值将始终设置为 True。 - training (
bool, 可选, 默认为 `False`) — 是否在训练模式下使用模型（某些模块（如 dropout 模块）在训练和评估之间具有不同的行为）。
返回值
transformers.modeling_tf_outputs.TFBaseModelOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFBaseModelOutput 或一个 tf.Tensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），其中包含各种元素，具体取决于配置 (SegformerConfig) 和输入。
-
last_hidden_state (形状为
(batch_size, sequence_length, hidden_size)的tf.Tensor) — 模型最后一层的输出处的隐藏状态序列。 -
hidden_states (
tuple(tf.FloatTensor), 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的tf.Tensor元组（embeddings 的输出一个，每层的输出一个）。模型在每一层输出以及初始嵌入输出处的隐藏状态。
-
attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor元组（每层一个）。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
TFSegformerModel 前向传播方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数内定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoImageProcessor, TFSegformerModel
>>> 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("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
< source >( config: SegformerConfig *inputs **kwargs )
参数
- config (SegformerConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法来加载模型权重。
SegFormer 模型转换器，顶部带有一个图像分类头（最终隐藏状态顶部的线性层），例如用于 ImageNet。
此模型继承自 TFPreTrainedModel。请查看父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 keras.Model 子类。可将其用作常规 TF 2.0 Keras 模型，并参考 TF 2.0 文档，了解与一般用法和行为相关的所有事项。
call
< source >( 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.TFSequenceClassifierOutput 或 tuple(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。此参数只能在立即模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在立即模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是纯元组。此参数可以在立即模式下使用，在图模式下该值将始终设置为 True。 - training (
bool, 可选, 默认为 `False`) — 是否在训练模式下使用模型（某些模块（如 dropout 模块）在训练和评估之间具有不同的行为）。
返回值
transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或一个 tf.Tensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），其中包含各种元素，具体取决于配置 (SegformerConfig) 和输入。
-
loss (形状为
(batch_size, )的tf.Tensor, 可选, 当提供labels时返回) — 分类（或回归，如果 config.num_labels==1）损失。 -
logits (形状为
(batch_size, config.num_labels)的tf.Tensor) — 分类（或回归，如果 config.num_labels==1）得分（SoftMax 之前）。 -
hidden_states (
tuple(tf.Tensor), 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的tf.Tensor元组（embeddings 的输出一个，每层的输出一个）。模型在每一层输出以及初始嵌入输出处的隐藏状态。
-
attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor元组（每层一个）。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
TFSegformerForImageClassification 前向传播方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数内定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoImageProcessor, TFSegformerForImageClassification
>>> import tensorflow as tf
>>> 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("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 catTFSegformerForSemanticSegmentation
class transformers.TFSegformerForSemanticSegmentation
< source >( config: SegformerConfig **kwargs )
参数
- config (SegformerConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有顶部全 MLP 解码头（例如，用于 ADE20k、CityScapes）的 SegFormer 模型转换器。此模型继承自 TFPreTrainedModel。请查看父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 keras.Model 子类。可将其用作常规 TF 2.0 Keras 模型，并参考 TF 2.0 文档，了解与一般用法和行为相关的所有事项。
call
< source >( 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.TFSemanticSegmenterOutput 或 tuple(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, optional) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参见返回的张量下的attentions。 此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参见返回的张量下的hidden_states。 此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是纯元组。 此参数可以在 eager 模式下使用，在 graph 模式下，该值将始终设置为 True。 - training (
bool, optional, 默认为 `False`) — 是否在训练模式下使用模型（某些模块，如 dropout 模块，在训练和评估之间具有不同的行为）。 - labels (形状为
(batch_size, height, width)的tf.Tensor, optional) — 用于计算损失的真实语义分割图。 索引应在[0, ..., config.num_labels - 1]中。 如果config.num_labels > 1，则计算（逐像素）分类损失（交叉熵）。
返回值
transformers.modeling_tf_outputs.TFSemanticSegmenterOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFSemanticSegmenterOutput 或 tf.Tensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (SegformerConfig) 和输入。
-
loss (形状为
(1,)的tf.Tensor, optional, 当提供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), optional, 当传递了output_hidden_states=True或当config.output_hidden_states=True时返回) —tf.Tensor的元组（如果模型具有嵌入层，则为嵌入的输出，+ 每层输出一个），形状为(batch_size, patch_size, hidden_size)。模型在每层输出处的隐藏状态，加上可选的初始嵌入输出。
-
attentions (
tuple(tf.Tensor), optional, 当传递了output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor的元组（每层一个），形状为(batch_size, num_heads, patch_size, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
TFSegformerForSemanticSegmentation 前向方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数内定义，但之后应该调用 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]