spandrel API Documentation Modules Classes Names
Clear Help

Class Hierarchy

  • abc.ABC
    • spandrel.Architecture - The abstract base class for all architectures.
      • spandrel.architectures.ATD.ATDArch - Undocumented
      • spandrel.architectures.Compact.CompactArch - Undocumented
      • spandrel.architectures.CRAFT.CRAFTArch - Undocumented
      • spandrel.architectures.DAT.DATArch - Undocumented
      • spandrel.architectures.DCTLSA.DCTLSAArch - Undocumented
      • spandrel.architectures.DITN.DITNArch - Undocumented
      • spandrel.architectures.DnCNN.DnCNNArch - Undocumented
      • spandrel.architectures.DRCT.DRCTArch - Undocumented
      • spandrel.architectures.DRUNet.DRUNetArch - Undocumented
      • spandrel.architectures.ESRGAN.ESRGANArch - Undocumented
      • spandrel.architectures.FBCNN.FBCNNArch - Undocumented
      • spandrel.architectures.FFTformer.FFTformerArch - Undocumented
      • spandrel.architectures.GFPGAN.GFPGANArch - Undocumented
      • spandrel.architectures.GRL.GRLArch - Undocumented
      • spandrel.architectures.HAT.HATArch - Undocumented
      • spandrel.architectures.HVICIDNet.HVICIDNetArch - Undocumented
      • spandrel.architectures.IPT.IPTArch - Undocumented
      • spandrel.architectures.KBNet.KBNetArch - Undocumented
      • spandrel.architectures.LaMa.LaMaArch - Undocumented
      • spandrel.architectures.MixDehazeNet.MixDehazeNetArch - Undocumented
      • spandrel.architectures.MMRealSR.MMRealSRArch - Undocumented
      • spandrel.architectures.MoESR.MoESRArch - Undocumented
      • spandrel.architectures.MoSR.MoSRArch - Undocumented
      • spandrel.architectures.NAFNet.NAFNetArch - Undocumented
      • spandrel.architectures.OmniSR.OmniSRArch - Undocumented
      • spandrel.architectures.PLKSR.PLKSRArch - Undocumented
      • spandrel.architectures.RCAN.RCANArch - Undocumented
      • spandrel.architectures.RealCUGAN.RealCUGANArch - Undocumented
      • spandrel.architectures.RestoreFormer.RestoreFormerArch - Undocumented
      • spandrel.architectures.RetinexFormer.RetinexFormerArch - Undocumented
      • spandrel.architectures.RGT.RGTArch - Undocumented
      • spandrel.architectures.SAFMN.SAFMNArch - Undocumented
      • spandrel.architectures.SAFMNBCIE.SAFMNBCIEArch - Undocumented
      • spandrel.architectures.SCUNet.SCUNetArch - Undocumented
      • spandrel.architectures.SeemoRe.SeemoReArch - Undocumented
      • spandrel.architectures.SPAN.SPANArch - Undocumented
      • spandrel.architectures.SwiftSRGAN.SwiftSRGANArch - Undocumented
      • spandrel.architectures.Swin2SR.Swin2SRArch - Undocumented
      • spandrel.architectures.SwinIR.SwinIRArch - Undocumented
      • spandrel.architectures.Uformer.UformerArch - Undocumented
      • spandrel_extra_arches.architectures.AdaCode.AdaCodeArch - Undocumented
      • spandrel_extra_arches.architectures.CodeFormer.CodeFormerArch - Undocumented
      • spandrel_extra_arches.architectures.DDColor.DDColorArch - Undocumented
      • spandrel_extra_arches.architectures.FeMaSR.FeMaSRArch - Undocumented
      • spandrel_extra_arches.architectures.M3SNet.M3SNetArch - Undocumented
      • spandrel_extra_arches.architectures.MAT.MATArch - Undocumented
      • spandrel_extra_arches.architectures.MIRNet2.MIRNet2Arch - Undocumented
      • spandrel_extra_arches.architectures.MPRNet.MPRNetArch - Undocumented
      • spandrel_extra_arches.architectures.Restormer.RestormerArch - Undocumented
      • spandrel_extra_arches.architectures.SRFormer.SRFormerArch - Undocumented
    • spandrel.ModelBase - The base class of all model descriptors.
      • spandrel.ImageModelDescriptor - A model that takes an image as input and returns an image. See __call__ for more information.
      • spandrel.MaskedImageModelDescriptor - A model that takes an image and a mask for that image as input and returns an image. See __call__ for more information.
  • enum.Enum
    • spandrel.ModelTiling - Describes whether and how a model supports tiling.
  • Exception
    • spandrel.UnsupportedDtypeError - An error that will be thrown by .to if the model does not support the given dtype.
    • spandrel.UnsupportedModelError - An error that will be thrown by ArchRegistry and ModelLoader if a model architecture is not supported.
  • spandrel.ArchRegistry - A registry of architectures.
  • spandrel.ArchSupport - An entry in an ArchRegistry that describes how to detect and load a model architecture.
  • spandrel.ModelLoader - Class for automatically loading a pth file into any architecture
  • spandrel.SizeRequirements - A set of requirements for the size of an input image.
  • spandrel.util.KeyCondition - A condition that checks if a state dict has the given keys.
  • spandrel_extra_arches.architectures.CodeFormer.__arch.codeformer.VQAutoEncoder
    • spandrel_extra_arches.architectures.CodeFormer.CodeFormer - Undocumented
  • torch.nn.Module
    • spandrel.architectures.__arch_helpers.block.ConcatBlock - Undocumented
    • spandrel.architectures.__arch_helpers.block.ResidualDenseBlock_5C - Residual Dense Block Style: 5 convs The core module of paper: (Residual Dense Network for Image Super-Resolution, CVPR 18) Modified options that can be used:
    • spandrel.architectures.__arch_helpers.block.ResNetBlock - ResNet Block, 3-3 style with extra residual scaling used in EDSR (Enhanced Deep Residual Networks for Single Image Super-Resolution, CVPRW 17)
    • spandrel.architectures.__arch_helpers.block.RRDB - Residual in Residual Dense Block (ESRGAN: Enhanced Super-Resolution Generative Adversarial Networks)
    • spandrel.architectures.__arch_helpers.block.ShortcutBlock - Undocumented
    • spandrel.architectures.__arch_helpers.block.ShortcutBlockSPSR - Undocumented
    • spandrel.architectures.__arch_helpers.dpir_basic_block.ResBlock - Undocumented
    • spandrel.architectures.__arch_helpers.dysample.DySample - Adapted from 'Learning to Upsample by Learning to Sample': https://arxiv.org/abs/2308.15085 https://github.com/tiny-smart/dysample
    • spandrel.architectures.ATD.ATD - ATD
    • spandrel.architectures.Compact.Compact - A compact VGG-style network structure for super-resolution.
    • spandrel.architectures.CRAFT.CRAFT - Some codes are based on SwinIR.
    • spandrel.architectures.DAT.DAT - Dual Aggregation Transformer
    • spandrel.architectures.DCTLSA.DCTLSA - Undocumented
    • spandrel.architectures.DITN.DITN - Undocumented
    • spandrel.architectures.DnCNN.DnCNN - No class docstring; 0/2 instance variable, 0/1 class variable, 1/2 method documented
    • spandrel.architectures.DRCT.DRCT - Undocumented
    • spandrel.architectures.DRUNet.DRUNet - Undocumented
    • spandrel.architectures.ESRGAN.ESRGAN - No class docstring; 0/3 instance variable, 0/1 class variable, 1/2 method documented
    • spandrel.architectures.FBCNN.FBCNN - Undocumented
    • spandrel.architectures.FFTformer.FFTformer - Undocumented
    • spandrel.architectures.GFPGAN.GFPGAN - The GFPGAN architecture: Unet + StyleGAN2 decoder with SFT. It is the clean version without custom compiled CUDA extensions used in StyleGAN2. Ref: GFP-GAN: Towards Real-World Blind Face Restoration with Generative Facial Prior.
    • spandrel.architectures.GRL.GRL - Image restoration transformer with global, non-local, and local connections
    • spandrel.architectures.HAT.HAT - A PyTorch implementation of : Activating More Pixels in Image Super-Resolution Transformer. Some codes are based on SwinIR.
    • spandrel.architectures.HVICIDNet.HVICIDNet - Undocumented
    • spandrel.architectures.IPT.IPT - Undocumented
    • spandrel.architectures.KBNet.KBNet_l - Undocumented
    • spandrel.architectures.KBNet.KBNet_s - Undocumented
    • spandrel.architectures.LaMa.LaMa - Undocumented
    • spandrel.architectures.MixDehazeNet.MixDehazeNet - Undocumented
    • spandrel.architectures.MMRealSR.MMRealSR - Networks consisting of Residual in Residual Dense Block, which is used in ESRGAN. v2.1
    • spandrel.architectures.MoSR.MoSR - Mamba Out Super-Resolution
    • spandrel.architectures.NAFNet.NAFNet - Undocumented
    • spandrel.architectures.OmniSR.OmniSR - Undocumented
    • spandrel.architectures.PLKSR.PLKSR - Undocumented
    • spandrel.architectures.PLKSR.RealPLKSR - Partial Large Kernel CNNs for Efficient Super-Resolution: https://arxiv.org/abs/2404.11848
    • spandrel.architectures.RealCUGAN.UpCunet2x - Undocumented
    • spandrel.architectures.RealCUGAN.UpCunet2x_fast - Undocumented
    • spandrel.architectures.RealCUGAN.UpCunet3x - Undocumented
    • spandrel.architectures.RealCUGAN.UpCunet4x - Undocumented
    • spandrel.architectures.RestoreFormer.RestoreFormer - Undocumented
    • spandrel.architectures.RetinexFormer.RetinexFormer - No class docstring; 0/2 instance variable, 0/1 class variable, 1/2 method documented
    • spandrel.architectures.RGT.RGT - No class docstring; 0/15 instance variable, 0/1 class variable, 1/3 method documented
    • spandrel.architectures.SAFMN.SAFMN - Undocumented
    • spandrel.architectures.SAFMNBCIE.SAFMNBCIE - Undocumented
    • spandrel.architectures.SCUNet.SCUNet - Undocumented
    • spandrel.architectures.SeemoRe.SeemoRe - Undocumented
    • spandrel.architectures.SPAN.SPAN - Swift Parameter-free Attention Network for Efficient Super-Resolution
    • spandrel.architectures.SwiftSRGAN.SwiftSRGAN - Swift-SRGAN Generator
    • spandrel.architectures.Swin2SR.Swin2SR - A PyTorch impl of : Swin2SR: SwinV2 Transformer for Compressed Image Super-Resolution and Restoration.
    • spandrel.architectures.SwinIR.SwinIR - A PyTorch impl of : SwinIR: Image Restoration Using Swin Transformer, based on Swin Transformer.
    • spandrel.architectures.Uformer.Uformer - Undocumented
    • spandrel.util.timm.DropBlock2d - DropBlock. See https://arxiv.org/pdf/1810.12890.pdf
    • spandrel.util.timm.DropPath - Drop paths (Stochastic Depth) per sample (when applied in main path of residual blocks).
    • spandrel_extra_arches.architectures.AdaCode.AdaCode - Undocumented
    • spandrel_extra_arches.architectures.DDColor.DDColor - Undocumented
    • spandrel_extra_arches.architectures.FeMaSR.FeMaSR - Undocumented
    • spandrel_extra_arches.architectures.M3SNet.M3SNet - Undocumented
    • spandrel_extra_arches.architectures.MAT.MAT - No class docstring; 0/3 instance variable, 0/1 class variable, 1/2 method documented
    • spandrel_extra_arches.architectures.MIRNet2.MIRNet2 - Undocumented
    • spandrel_extra_arches.architectures.MPRNet.MPRNet - Undocumented
    • spandrel_extra_arches.architectures.Restormer.Restormer - Undocumented
    • spandrel_extra_arches.architectures.SRFormer.SRFormer - A PyTorch implement of : SRFormer: Permuted Self-Attention for Single Image Super-Resolution, based on Swin Transformer.
  • typing.Generic
    • spandrel.Architecture - The abstract base class for all architectures.
      • spandrel.architectures.ATD.ATDArch - Undocumented
      • spandrel.architectures.Compact.CompactArch - Undocumented
      • spandrel.architectures.CRAFT.CRAFTArch - Undocumented
      • spandrel.architectures.DAT.DATArch - Undocumented
      • spandrel.architectures.DCTLSA.DCTLSAArch - Undocumented
      • spandrel.architectures.DITN.DITNArch - Undocumented
      • spandrel.architectures.DnCNN.DnCNNArch - Undocumented
      • spandrel.architectures.DRCT.DRCTArch - Undocumented
      • spandrel.architectures.DRUNet.DRUNetArch - Undocumented
      • spandrel.architectures.ESRGAN.ESRGANArch - Undocumented
      • spandrel.architectures.FBCNN.FBCNNArch - Undocumented
      • spandrel.architectures.FFTformer.FFTformerArch - Undocumented
      • spandrel.architectures.GFPGAN.GFPGANArch - Undocumented
      • spandrel.architectures.GRL.GRLArch - Undocumented
      • spandrel.architectures.HAT.HATArch - Undocumented
      • spandrel.architectures.HVICIDNet.HVICIDNetArch - Undocumented
      • spandrel.architectures.IPT.IPTArch - Undocumented
      • spandrel.architectures.KBNet.KBNetArch - Undocumented
      • spandrel.architectures.LaMa.LaMaArch - Undocumented
      • spandrel.architectures.MixDehazeNet.MixDehazeNetArch - Undocumented
      • spandrel.architectures.MMRealSR.MMRealSRArch - Undocumented
      • spandrel.architectures.MoESR.MoESRArch - Undocumented
      • spandrel.architectures.MoSR.MoSRArch - Undocumented
      • spandrel.architectures.NAFNet.NAFNetArch - Undocumented
      • spandrel.architectures.OmniSR.OmniSRArch - Undocumented
      • spandrel.architectures.PLKSR.PLKSRArch - Undocumented
      • spandrel.architectures.RCAN.RCANArch - Undocumented
      • spandrel.architectures.RealCUGAN.RealCUGANArch - Undocumented
      • spandrel.architectures.RestoreFormer.RestoreFormerArch - Undocumented
      • spandrel.architectures.RetinexFormer.RetinexFormerArch - Undocumented
      • spandrel.architectures.RGT.RGTArch - Undocumented
      • spandrel.architectures.SAFMN.SAFMNArch - Undocumented
      • spandrel.architectures.SAFMNBCIE.SAFMNBCIEArch - Undocumented
      • spandrel.architectures.SCUNet.SCUNetArch - Undocumented
      • spandrel.architectures.SeemoRe.SeemoReArch - Undocumented
      • spandrel.architectures.SPAN.SPANArch - Undocumented
      • spandrel.architectures.SwiftSRGAN.SwiftSRGANArch - Undocumented
      • spandrel.architectures.Swin2SR.Swin2SRArch - Undocumented
      • spandrel.architectures.SwinIR.SwinIRArch - Undocumented
      • spandrel.architectures.Uformer.UformerArch - Undocumented
      • spandrel_extra_arches.architectures.AdaCode.AdaCodeArch - Undocumented
      • spandrel_extra_arches.architectures.CodeFormer.CodeFormerArch - Undocumented
      • spandrel_extra_arches.architectures.DDColor.DDColorArch - Undocumented
      • spandrel_extra_arches.architectures.FeMaSR.FeMaSRArch - Undocumented
      • spandrel_extra_arches.architectures.M3SNet.M3SNetArch - Undocumented
      • spandrel_extra_arches.architectures.MAT.MATArch - Undocumented
      • spandrel_extra_arches.architectures.MIRNet2.MIRNet2Arch - Undocumented
      • spandrel_extra_arches.architectures.MPRNet.MPRNetArch - Undocumented
      • spandrel_extra_arches.architectures.Restormer.RestormerArch - Undocumented
      • spandrel_extra_arches.architectures.SRFormer.SRFormerArch - Undocumented
    • spandrel.ImageModelDescriptor - A model that takes an image as input and returns an image. See __call__ for more information.
    • spandrel.MaskedImageModelDescriptor - A model that takes an image and a mask for that image as input and returns an image. See __call__ for more information.
    • spandrel.ModelBase - The base class of all model descriptors.
      • spandrel.ImageModelDescriptor - A model that takes an image as input and returns an image. See __call__ for more information.
      • spandrel.MaskedImageModelDescriptor - A model that takes an image and a mask for that image as input and returns an image. See __call__ for more information.
  • ValueError
    • spandrel.DuplicateArchitectureError - An error that will be thrown by ArchRegistry if the same architecture is added twice.

API Documentation for spandrel, generated by pydoctor 23.9.1 at 2025-01-19 15:31:11.