Transformers 文档

Swin2SR

Hugging Face's logo
加入Hugging Face社区

并获得增强文档体验

开始使用

Swin2SR

概述

Swin2SR 模型在 Marcos V. Conde、Ui-Jin Choi、Maxime Burchi 和 Radu Timofte 的论文 Swin2SR: 用于压缩图像超分辨率和恢复的 SwinV2 变换器 中提出。Swin2SR 通过整合 Swin 变换器 v2 层来改进 SwinIR 模型,从而缓解了训练不稳定、预训练和微调之间分辨率差距以及对数据依赖性等问题。

论文的摘要如下:

压缩在通过带宽受限系统(例如流媒体服务、虚拟现实或电子游戏)高效传输和存储图像和视频方面发挥着重要作用。然而,压缩不可避免地会导致伪影和原始信息的丢失,这可能会严重降低视觉质量。出于这些原因,压缩图像的质量增强已成为一个热门的研究课题。虽然大多数最先进的图像恢复方法都基于卷积神经网络,但其他基于变换器的方法,例如 SwinIR,在这些任务上表现出了令人印象深刻的性能。在本文中,我们探索了新颖的 Swin 变换器 V2,以改进 SwinIR 用于图像超分辨率,特别是压缩输入场景。使用这种方法,我们可以解决训练变换器视觉模型的主要问题,例如训练不稳定性、预训练和微调之间分辨率差距以及对数据依赖性。我们对三个代表性任务进行了实验:JPEG 压缩伪影去除、图像超分辨率(经典和轻量级)以及压缩图像超分辨率。实验结果表明,我们的方法 Swin2SR 可以提高 SwinIR 的训练收敛性和性能,并且是“2022 年 AIM 压缩图像和视频超分辨率挑战赛”的五强解决方案之一。

示意图 Swin2SR 架构。摘自 原始论文。

该模型由 nielsr 贡献。原始代码可以在这里找到 这里

资源

Swin2SR 的演示笔记本可以在这里找到 这里

使用 SwinSR 进行图像超分辨率的演示空间可以在这里找到 这里

Swin2SRImageProcessor

transformers.Swin2SRImageProcessor

< >

( do_rescale: bool = True rescale_factor: Union = 0.00392156862745098 do_pad: bool = True pad_size: int = 8 **kwargs )

参数

  • do_rescale (bool, 可选, 默认为 True) — 是否根据指定的缩放比例 rescale_factor 重新缩放图像。可以在 preprocess 方法中的 do_rescale 参数中覆盖。
  • rescale_factor (intfloat, 可选, 默认为 1/255) — 如果重新缩放图像,则使用的缩放比例。可以在 preprocess 方法中的 rescale_factor 参数中覆盖。

构建 Swin2SR 图像处理器。

preprocess

< >

( images: Union do_rescale: Optional = None rescale_factor: Optional = None do_pad: Optional = None pad_size: Optional = None return_tensors: Union = None data_format: Union = <ChannelDimension.FIRST: 'channels_first'> input_data_format: Union = None )

参数

  • images (ImageInput) — 要预处理的图像。需要单个或批量的图像,像素值范围为 0 到 255。如果传入像素值介于 0 和 1 之间的图像,请设置 do_rescale=False
  • do_rescale (bool, 可选, 默认为 self.do_rescale) — 是否将图像值重新缩放至 [0 - 1] 之间。
  • rescale_factor (float可选,默认为 self.rescale_factor) — 如果 do_rescale 设置为 True,则用于重新缩放图像的缩放因子。
  • do_pad (bool可选,默认为 True) — 是否对图像进行填充,以使高度和宽度可以被 window_size 整除。
  • pad_size (int可选,默认为 32) — 用于局部注意力滑动窗口的大小。
  • 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) — 输出图像的通道维度格式。可以是以下之一:
    • "channels_first"ChannelDimension.FIRST:图像格式为 (num_channels, height, width)。
    • "channels_last"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)。

预处理图像或图像批次。

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, 可选, 默认为 64) — 每个图像的大小(分辨率)。
  • patch_size (int, 可选, 默认为 1) — 每个补丁的大小(分辨率)。
  • num_channels (int, 可选, 默认为 3) — 输入通道的数量。
  • num_channels_out (int, 可选, 默认为 num_channels) — 输出通道的数量。如果未设置,则将其设置为 num_channels
  • embed_dim (int, 可选, 默认为 180) — 补丁嵌入的维度。
  • depths (list(int), 可选, 默认为 [6, 6, 6, 6, 6, 6]) — Transformer 编码器中每一层的深度。
  • num_heads (list(int), 可选, 默认为 [6, 6, 6, 6, 6, 6]) — Transformer 编码器中每一层中的注意力头的数量。
  • window_size (int, 可选, 默认为 8) — 窗口的大小。

  • mlp_ratio (float可选,默认为 2.0) — MLP 隐藏层维度与嵌入维度之比。
  • qkv_bias (bool可选,默认为 True) — 是否向查询、键和值添加可学习的偏置。
  • hidden_dropout_prob (float可选,默认为 0.0) — 嵌入和编码器中所有全连接层的 dropout 概率。
  • attention_probs_dropout_prob (float可选,默认为 0.0) — 注意力概率的 dropout 比率。
  • drop_path_rate (float可选,默认为 0.1) — 随机深度率。
  • hidden_act (strfunction可选,默认为 "gelu") — 编码器中的非线性激活函数(函数或字符串)。如果为字符串,则支持 "gelu""relu""selu""gelu_new"
  • use_absolute_embeddings (bool可选,默认为 False) — 是否向 patch 嵌入添加绝对位置嵌入。
  • initializer_range (float可选,默认为 0.02) — 初始化所有权重矩阵的截断正态分布初始化器的标准差。
  • layer_norm_eps (float可选,默认为 1e-05) — 层归一化层使用的 epsilon。
  • upscale (int可选,默认为 2) — 图像的上采样因子。图像超分辨率为 2/3/4/8,降噪和压缩伪影减少为 1
  • 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

transformers.Swin2SRModel

< >

( config )

参数

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

基本的 Swin2SR 模型转换器,输出原始隐藏状态,顶部没有任何特定头部。此模型是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档以了解与一般用法和行为相关的所有事项。

前向传播

< >

( pixel_values: FloatTensor head_mask: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) transformers.modeling_outputs.BaseModelOutputtuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor 形状为 (batch_size, num_channels, height, width)) — 像素值。可以使用 AutoImageProcessor 获取像素值。有关详细信息,请参阅 Swin2SRImageProcessor.call()
  • 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.BaseModelOutputtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.BaseModelOutputtorch.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 之后的注意力权重,用于计算自注意力头中的加权平均值。

The Swin2SRModel 正向方法,覆盖了 __call__ 特殊方法。

虽然正向传递的配方需要在此函数中定义,但此后应该调用 Module 实例,而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则默默地忽略它们。

示例

>>> from transformers import AutoImageProcessor, Swin2SRModel
>>> 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("caidas/swin2SR-classical-sr-x2-64")
>>> model = Swin2SRModel.from_pretrained("caidas/swin2SR-classical-sr-x2-64")

>>> 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, 180, 488, 648]

Swin2SRForImageSuperResolution

transformers.Swin2SRForImageSuperResolution

< >

( config )

参数

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

带有向上采样头的 Swin2SR 模型转换器,用于图像超分辨率和恢复。

此模型是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档了解与一般使用和行为相关的所有事项。

前向传播

< >

( pixel_values: Optional = None head_mask: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.modeling_outputs.ImageSuperResolutionOutputtuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor 形状为 (batch_size, num_channels, height, width)) — 像素值。可以使用 AutoImageProcessor 获取像素值。有关详细信息,请参阅 Swin2SRImageProcessor.call()
  • 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.ImageSuperResolutionOutputtuple(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=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, patch_size, sequence_length)

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

Swin2SRForImageSuperResolution 前向方法覆盖了__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`
< > 在 GitHub 上更新