Transformers 文档
Swin2SR
并获得增强的文档体验
开始使用
Swin2SR
概述
Swin2SR 模型由 Marcos V. Conde、Ui-Jin Choi、Maxime Burchi 和 Radu Timofte 在 Swin2SR: SwinV2 Transformer for Compressed Image Super-Resolution and Restoration 一文中提出。Swin2SR 通过整合 Swin Transformer v2 层来改进 SwinIR 模型,这缓解了训练不稳定、预训练和微调之间的分辨率差距以及数据依赖性强等问题。
论文摘要如下:
摘要:压缩在通过带宽受限的系统(如流媒体服务、虚拟现实或视频游戏)高效传输和存储图像和视频方面起着重要作用。然而,压缩不可避免地会导致伪影和原始信息的丢失,这可能会严重降低视觉质量。因此,压缩图像的质量增强已成为一个热门研究课题。虽然大多数最先进的图像恢复方法都基于卷积神经网络,但其他基于 Transformer 的方法(如 SwinIR)在这些任务上也表现出色。在本文中,我们探索了新颖的 Swin Transformer V2,以改进用于图像超分辨率的 SwinIR,特别是在压缩输入场景中。使用这种方法,我们可以解决训练 Transformer 视觉模型中的主要问题,例如训练不稳定、预训练和微调之间的分辨率差距以及对数据的强烈依赖。我们在三个代表性任务上进行了实验:JPEG 压缩伪影去除、图像超分辨率(经典和轻量级)以及压缩图像超分辨率。实验结果表明,我们的方法 Swin2SR 能够改善 SwinIR 的训练收敛性和性能,并且是“AIM 2022 压缩图像和视频超分辨率挑战赛”的前五名解决方案。

资源
Swin2SR 的演示笔记本可以在这里找到。
使用 SwinSR 进行图像超分辨率的演示空间可以在这里找到。
Swin2SRImageProcessor
class transformers.Swin2SRImageProcessor
< 源 >( do_rescale: bool = True rescale_factor: typing.Union[int, float] = 0.00392156862745098 do_pad: bool = True pad_size: int = 8 **kwargs )
构建一个 Swin2SR 图像处理器。
preprocess
< 源 >( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']] do_rescale: typing.Optional[bool] = None rescale_factor: typing.Optional[float] = None do_pad: typing.Optional[bool] = None pad_size: typing.Optional[int] = None return_tensors: typing.Union[str, transformers.utils.generic.TensorType, NoneType] = None data_format: typing.Union[str, transformers.image_utils.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
。 - do_rescale (
bool
, optional, 默认为self.do_rescale
) — 是否将图像值重新缩放到 [0 - 1] 之间。 - rescale_factor (
float
, optional, 默认为self.rescale_factor
) — 如果设置do_rescale
为True
,则用于缩放图像的缩放因子。 - do_pad (
bool
, optional, 默认为True
) — 是否填充图像,使其高度和宽度能被window_size
整除。 - pad_size (
int
, optional, 默认为 32) — 局部注意力滑动窗口的大小。 - return_tensors (
str
或TensorType
, optional) — 返回张量的类型。可以是以下之一:- 未设置:返回一个
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
, optional, 默认为ChannelDimension.FIRST
) — 输出图像的通道维度格式。可以是以下之一:"channels_first"
或ChannelDimension.FIRST
: 图像格式为 (num_channels, height, width)。"channels_last"
或ChannelDimension.LAST
: 图像格式为 (height, width, num_channels)。- 未设置:使用输入图像的通道维度格式。
- input_data_format (
ChannelDimension
或str
, optional) — 输入图像的通道维度格式。如果未设置,则从输入图像中推断通道维度格式。可以是以下之一:"channels_first"
或ChannelDimension.FIRST
: 图像格式为 (num_channels, height, width)。"channels_last"
或ChannelDimension.LAST
: 图像格式为 (height, width, num_channels)。"none"
或ChannelDimension.NONE
: 图像格式为 (height, width)。
预处理一张或一批图像。
Swin2SRImageProcessorFast
class transformers.Swin2SRImageProcessorFast
< 源 >( **kwargs: typing_extensions.Unpack[transformers.models.swin2sr.image_processing_swin2sr_fast.Swin2SRFastImageProcessorKwargs] )
构建一个快速的 Swin2SR 图像处理器。
preprocess
< 源 >( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']] **kwargs: typing_extensions.Unpack[transformers.models.swin2sr.image_processing_swin2sr_fast.Swin2SRFastImageProcessorKwargs] )
Swin2SRConfig
class transformers.Swin2SRConfig
< 源 >( image_size = 64 patch_size = 1 num_channels = 3 num_channels_out = None embed_dim = 180 depths = [6, 6, 6, 6, 6, 6] num_heads = [6, 6, 6, 6, 6, 6] window_size = 8 mlp_ratio = 2.0 qkv_bias = True hidden_dropout_prob = 0.0 attention_probs_dropout_prob = 0.0 drop_path_rate = 0.1 hidden_act = 'gelu' use_absolute_embeddings = False initializer_range = 0.02 layer_norm_eps = 1e-05 upscale = 2 img_range = 1.0 resi_connection = '1conv' upsampler = 'pixelshuffle' **kwargs )
参数
- image_size (
int
, optional, 默认为 64) — 每张图像的大小(分辨率)。 - patch_size (
int
, optional, 默认为 1) — 每个图块的大小(分辨率)。 - num_channels (
int
, optional, 默认为 3) — 输入通道的数量。 - num_channels_out (
int
, optional, 默认为num_channels
) — 输出通道的数量。如果未设置,将被设置为num_channels
。 - embed_dim (
int
, optional, 默认为 180) — 图块嵌入的维度。 - depths (
list(int)
, optional, 默认为[6, 6, 6, 6, 6, 6]
) — Transformer 编码器中每层的深度。 - num_heads (
list(int)
, optional, 默认为[6, 6, 6, 6, 6, 6]
) — Transformer 编码器每层中注意力头的数量。 - window_size (
int
, optional, 默认为 8) — 窗口大小。 - mlp_ratio (
float
, optional, 默认为 2.0) — MLP 隐藏维度与嵌入维度的比率。 - qkv_bias (
bool
, optional, 默认为True
) — 是否为查询、键和值添加可学习的偏置。 - hidden_dropout_prob (
float
, optional, 默认为 0.0) — 嵌入和编码器中所有全连接层的丢弃概率。 - attention_probs_dropout_prob (
float
, optional, 默认为 0.0) — 注意力概率的丢弃率。 - drop_path_rate (
float
, optional, 默认为 0.1) — 随机深度率。 - hidden_act (
str
或function
, optional, 默认为"gelu"
) — 编码器中的非线性激活函数(函数或字符串)。如果为字符串,支持"gelu"
、"relu"
、"selu"
和"gelu_new"
。 - use_absolute_embeddings (
bool
, optional, 默认为False
) — 是否向图块嵌入添加绝对位置嵌入。 - initializer_range (
float
, optional, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float
, optional, 默认为 1e-05) — 层归一化层使用的 epsilon 值。 - upscale (
int
, 可选, 默认为 2) — 图像的上采样因子。对于图像超分辨率,可取 2/3/4/8;对于去噪和压缩伪影减少,可取 1。 - img_range (
float
, 可选, 默认为 1.0) — 输入图像的值范围。 - resi_connection (
str
, 可选, 默认为"1conv"
) — 每个阶段残差连接前使用的卷积块。 - upsampler (
str
, 可选, 默认为"pixelshuffle"
) — 重建模块。可以是 ‘pixelshuffle’/‘pixelshuffledirect’/‘nearest+conv’/None。
这是用于存储 Swin2SRModel 配置的配置类。它用于根据指定的参数实例化一个 Swin Transformer v2 模型,定义模型架构。使用默认值实例化配置将产生与 Swin Transformer v2 caidas/swin2sr-classicalsr-x2-64 架构类似的配置。
配置对象继承自 PretrainedConfig,可用于控制模型输出。更多信息请阅读 PretrainedConfig 的文档。
示例
>>> from transformers import Swin2SRConfig, Swin2SRModel
>>> # Initializing a Swin2SR caidas/swin2sr-classicalsr-x2-64 style configuration
>>> configuration = Swin2SRConfig()
>>> # Initializing a model (with random weights) from the caidas/swin2sr-classicalsr-x2-64 style configuration
>>> model = Swin2SRModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config
Swin2SRModel
class transformers.Swin2SRModel
< source >( config )
参数
- config (Swin2SRModel) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重,只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
基础的 Swin2Sr 模型,输出原始的隐藏状态,顶部没有任何特定的头。
该模型继承自 PreTrainedModel。请查看超类的文档,了解库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。
该模型也是 PyTorch torch.nn.Module 的子类。可以像常规的 PyTorch 模块一样使用它,并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( pixel_values: FloatTensor head_mask: typing.Optional[torch.FloatTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
参数
- pixel_values (
torch.FloatTensor
,形状为(batch_size, num_channels, image_size, image_size)
) — 对应于输入图像的张量。像素值可以使用{image_processor_class}
获得。有关详细信息,请参阅{image_processor_class}.__call__
({processor_class}
使用{image_processor_class}
处理图像)。 - head_mask (
torch.FloatTensor
,形状为(num_heads,)
或(num_layers, num_heads)
, 可选) — 用于使自注意力模块的选定头无效的掩码。掩码值在[0, 1]
中选择:- 1 表示头未被掩码,
- 0 表示头被掩码。
- output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutput 或一个 torch.FloatTensor
元组(如果传递 return_dict=False
或当 config.return_dict=False
时),根据配置(Swin2SRConfig)和输入,包含各种元素。
-
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
时返回) —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 后的注意力权重,用于计算自注意力头中的加权平均值。
Swin2SRModel 的 forward 方法,覆盖了 __call__
特殊方法。
尽管前向传播的流程需要在此函数中定义,但之后应该调用 Module
实例而不是此函数,因为前者会处理前处理和后处理步骤,而后者会静默地忽略它们。
Swin2SRForImageSuperResolution
class transformers.Swin2SRForImageSuperResolution
< source >( config )
参数
- config (Swin2SRForImageSuperResolution) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重,只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
Swin2SR 模型 Transformer,顶部带有一个上采样器头,用于图像超分辨率和恢复。
该模型继承自 PreTrainedModel。请查看超类的文档,了解库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。
该模型也是 PyTorch torch.nn.Module 的子类。可以像常规的 PyTorch 模块一样使用它,并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( pixel_values: typing.Optional[torch.FloatTensor] = None head_mask: 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.modeling_outputs.ImageSuperResolutionOutput
或 tuple(torch.FloatTensor)
参数
- pixel_values (
torch.FloatTensor
,形状为(batch_size, num_channels, image_size, image_size)
, 可选) — 对应于输入图像的张量。像素值可以使用{image_processor_class}
获得。有关详细信息,请参阅{image_processor_class}.__call__
({processor_class}
使用{image_processor_class}
处理图像)。 - head_mask (
torch.FloatTensor
,形状为(num_heads,)
或(num_layers, num_heads)
, 可选) — 用于使自注意力模块的选定头无效的掩码。掩码值在[0, 1]
中选择:- 1 表示头未被掩码,
- 0 表示头被掩码。
- labels (
torch.LongTensor
,形状为(batch_size, sequence_length)
, 可选) — 用于计算掩码语言建模损失的标签。索引应在[0, ..., config.vocab_size]
或 -100 中(参见input_ids
文档字符串)。索引设置为-100
的标记将被忽略(掩码),损失仅针对标签在[0, ..., config.vocab_size]
中的标记计算。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.modeling_outputs.ImageSuperResolutionOutput
或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.ImageSuperResolutionOutput
或一个 torch.FloatTensor
元组(如果传递 return_dict=False
或当 config.return_dict=False
时),根据配置(Swin2SRConfig)和输入,包含各种元素。
-
loss (
torch.FloatTensor
,形状为(1,)
, 可选, 在提供labels
时返回) — 重建损失。 -
reconstruction (
torch.FloatTensor
,形状为(batch_size, num_channels, height, width)
) — 重建的图像,可能已上采样。 -
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, patch_size, sequence_length)
。注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均值。
Swin2SRForImageSuperResolution 的 forward 方法,覆盖了 __call__
特殊方法。
尽管前向传播的流程需要在此函数中定义,但之后应该调用 Module
实例而不是此函数,因为前者会处理前处理和后处理步骤,而后者会静默地忽略它们。
示例
>>> import torch
>>> import numpy as np
>>> from PIL import Image
>>> import requests
>>> from transformers import AutoImageProcessor, Swin2SRForImageSuperResolution
>>> processor = AutoImageProcessor.from_pretrained("caidas/swin2SR-classical-sr-x2-64")
>>> model = Swin2SRForImageSuperResolution.from_pretrained("caidas/swin2SR-classical-sr-x2-64")
>>> url = "https://huggingface.co/spaces/jjourney1125/swin2sr/resolve/main/samples/butterfly.jpg"
>>> image = Image.open(requests.get(url, stream=True).raw)
>>> # prepare image for the model
>>> inputs = processor(image, return_tensors="pt")
>>> # forward pass
>>> with torch.no_grad():
... outputs = model(**inputs)
>>> output = outputs.reconstruction.data.squeeze().float().cpu().clamp_(0, 1).numpy()
>>> output = np.moveaxis(output, source=0, destination=-1)
>>> output = (output * 255.0).round().astype(np.uint8) # float32 to uint8
>>> # you can visualize `output` with `Image.fromarray`