Require keyword args for all architectures (#279)

* KWOnly for all except ATD

* Better error message

* ATD

libs/spandrel/spandrel/architectures/ATD/arch/atd_arch.py

@@ -909,6 +909,7 @@ class ATD(nn.Module):
 
     def __init__(
         self,
+        *,
         img_size=64,
         patch_size=1,
         in_chans=3,

libs/spandrel/spandrel/architectures/CRAFT/arch/CRAFT.py

@@ -748,6 +748,7 @@ class CRAFT(nn.Module):
 
     def __init__(
         self,
+        *,
         in_chans=3,
         # img_size=64,
         window_size=16,

libs/spandrel/spandrel/architectures/Compact/arch/SRVGG.py

@@ -26,6 +26,7 @@ class SRVGGNetCompact(nn.Module):
 
     def __init__(
         self,
+        *,
         num_in_ch=3,
         num_out_ch=3,
         num_feat=64,

libs/spandrel/spandrel/architectures/DAT/arch/DAT.py

@@ -920,6 +920,7 @@ class DAT(nn.Module):
 
     def __init__(
         self,
+        *,
         img_size=64,
         in_chans=3,
         embed_dim=180,

libs/spandrel/spandrel/architectures/DCTLSA/arch/dctlsa.py

@@ -461,6 +461,7 @@ class DCTLSA(nn.Module):
 
     def __init__(
         self,
+        *,
         in_nc=3,
         nf=55,
         num_modules=6,

libs/spandrel/spandrel/architectures/DITN/arch/DITN_Real.py

@@ -265,6 +265,7 @@ class DITN_Real(nn.Module):
 
     def __init__(
         self,
+        *,
         inp_channels=3,
         dim=60,
         ITL_blocks=4,

libs/spandrel/spandrel/architectures/DRCT/arch/drct_arch.py

@@ -688,6 +688,7 @@ class DRCT(nn.Module):
 
     def __init__(
         self,
+        *,
         img_size=64,
         patch_size=1,
         in_chans=3,

libs/spandrel/spandrel/architectures/DRUNet/arch/network_unet.py

@@ -21,6 +21,7 @@ class DRUNet(nn.Module):
 
     def __init__(
         self,
+        *,
         in_nc=1,
         out_nc=1,
         nc=[64, 128, 256, 512],

libs/spandrel/spandrel/architectures/DnCNN/arch/network_dncnn.py

@@ -45,6 +45,7 @@ class DnCNN(nn.Module):
 
     def __init__(
         self,
+        *,
         in_nc=1,
         out_nc=1,
         nc=64,

libs/spandrel/spandrel/architectures/ESRGAN/arch/RRDB.py

@@ -19,6 +19,7 @@ class RRDBNet(nn.Module):
 
     def __init__(
         self,
+        *,
         in_nc: int = 3,
         out_nc: int = 3,
         num_filters: int = 64,

libs/spandrel/spandrel/architectures/FBCNN/arch/FBCNN.py

@@ -411,6 +411,7 @@ class FBCNN(nn.Module):
 
     def __init__(
         self,
+        *,
         in_nc=3,
         out_nc=3,
         nc=[64, 128, 256, 512],

libs/spandrel/spandrel/architectures/FFTformer/arch/fftformer_arch.py

@@ -275,6 +275,7 @@ class FFTformer(nn.Module):
 
     def __init__(
         self,
+        *,
         inp_channels=3,
         out_channels=3,
         dim=48,

libs/spandrel/spandrel/architectures/GFPGAN/arch/gfpganv1_clean_arch.py

@@ -196,6 +196,7 @@ class GFPGANv1Clean(nn.Module):
 
     def __init__(
         self,
+        *,
         out_size=512,
         num_style_feat=512,
         channel_multiplier=2,

libs/spandrel/spandrel/architectures/GRL/arch/grl.py

@@ -231,6 +231,7 @@ class GRL(nn.Module):
 
     def __init__(
         self,
+        *,
         img_size=64,
         in_channels: int = 3,
         out_channels: int = 3,

libs/spandrel/spandrel/architectures/HAT/arch/HAT.py

@@ -856,6 +856,7 @@ class HAT(nn.Module):
 
     def __init__(
         self,
+        *,
         img_size=64,
         patch_size=1,
         in_chans=3,

libs/spandrel/spandrel/architectures/HVICIDNet/arch/cidnet.py

@@ -14,6 +14,7 @@ class CIDNet(nn.Module):
 
     def __init__(
         self,
+        *,
         channels=[36, 36, 72, 144],
         heads=[1, 2, 4, 8],
         norm=False,

libs/spandrel/spandrel/architectures/IPT/arch/ipt.py

@@ -22,6 +22,7 @@ class IPT(nn.Module):
 
     def __init__(
         self,
+        *,
         patch_size: int = 48,
         patch_dim: int = 3,
         n_feats: int = 64,

libs/spandrel/spandrel/architectures/KBNet/arch/kbnet_l.py

@@ -223,6 +223,7 @@ class KBNet_l(nn.Module):
 
     def __init__(
         self,
+        *,
         inp_channels=3,
         out_channels=3,
         dim=48,

libs/spandrel/spandrel/architectures/KBNet/arch/kbnet_s.py

@@ -205,6 +205,7 @@ class KBNet_s(nn.Module):
 
     def __init__(
         self,
+        *,
         img_channel=3,
         width=64,
         middle_blk_num=12,

libs/spandrel/spandrel/architectures/LaMa/arch/LaMa.py

@@ -667,7 +667,7 @@ def forward(self, image, mask):
 class LaMa(nn.Module):
     hyperparameters = {}
 
-    def __init__(self, in_nc=3, out_nc=3) -> None:
+    def __init__(self, *, in_nc=3, out_nc=3) -> None:
         super().__init__()
         self.model = FFCResNetGenerator(in_nc, out_nc)
 

libs/spandrel/spandrel/architectures/MMRealSR/arch/mmrealsr_arch.py

@@ -554,6 +554,7 @@ class MMRRDBNet_test(nn.Module):
 
     def __init__(
         self,
+        *,
         num_in_ch,
         num_out_ch,
         scale=4,

libs/spandrel/spandrel/architectures/MixDehazeNet/arch/MixDehazeNet.py

@@ -208,6 +208,7 @@ class MixDehazeNet(nn.Module):
 
     def __init__(
         self,
+        *,
         in_chans=3,
         out_chans=4,
         embed_dims=[24, 48, 96, 48, 24],

libs/spandrel/spandrel/architectures/NAFNet/arch/NAFNet_arch.py

@@ -142,6 +142,7 @@ class NAFNet(nn.Module):
 
     def __init__(
         self,
+        *,
         img_channel: int = 3,
         width: int = 16,
         middle_blk_num: int = 1,

libs/spandrel/spandrel/architectures/OmniSR/arch/OmniSR.py

@@ -25,6 +25,7 @@ class OmniSR(nn.Module):
 
     def __init__(
         self,
+        *,
         num_in_ch=3,
         num_out_ch=3,
         num_feat=64,

libs/spandrel/spandrel/architectures/PLKSR/arch/PLKSR.py

@@ -291,6 +291,7 @@ class PLKSR(nn.Module):
 
     def __init__(
         self,
+        *,
         dim: int = 64,
         n_blocks: int = 28,
         upscaling_factor: int = 4,

libs/spandrel/spandrel/architectures/PLKSR/arch/RealPLKSR.py

@@ -103,6 +103,7 @@ class RealPLKSR(nn.Module):
 
     def __init__(
         self,
+        *,
         dim: int = 64,
         n_blocks: int = 28,
         upscaling_factor: int = 4,

libs/spandrel/spandrel/architectures/RGT/arch/rgt.py

@@ -814,6 +814,7 @@ class RGT(nn.Module):
 
     def __init__(
         self,
+        *,
         img_size=64,
         in_chans=3,
         embed_dim=180,

libs/spandrel/spandrel/architectures/RealCUGAN/arch/upcunet_v3.py

@@ -291,7 +291,7 @@ def forward_d(self, x1, x4):  # conv234结尾有se
 class UpCunet2x(nn.Module):
     hyperparameters = {}
 
-    def __init__(self, in_channels=3, out_channels=3, pro: bool = False):
+    def __init__(self, *, in_channels=3, out_channels=3, pro: bool = False):
         super().__init__()
         self.pro: Tensor | None
         if pro:
@@ -333,7 +333,7 @@ def forward(self, x: Tensor, alpha: float = 1):
 class UpCunet3x(nn.Module):
     hyperparameters = {}
 
-    def __init__(self, in_channels=3, out_channels=3, pro: bool = False):
+    def __init__(self, *, in_channels=3, out_channels=3, pro: bool = False):
         super().__init__()
         self.pro: Tensor | None
         if pro:
@@ -375,7 +375,7 @@ def forward(self, x: Tensor, alpha: float = 1):
 class UpCunet4x(nn.Module):
     hyperparameters = {}
 
-    def __init__(self, in_channels=3, out_channels=3, pro: bool = False):
+    def __init__(self, *, in_channels=3, out_channels=3, pro: bool = False):
         super().__init__()
         self.pro: Tensor | None
         if pro:
@@ -425,7 +425,7 @@ def forward(self, x: Tensor, alpha: float = 1):
 class UpCunet2x_fast(nn.Module):
     hyperparameters = {}
 
-    def __init__(self, in_channels=3, out_channels=3):
+    def __init__(self, *, in_channels=3, out_channels=3):
         super().__init__()
         self.unet1 = UNet1(12, 64, deconv=True)
         self.unet2 = UNet2(64, 64, deconv=False)

libs/spandrel/spandrel/architectures/RestoreFormer/arch/restoreformer_arch.py

@@ -674,6 +674,7 @@ class RestoreFormer(nn.Module):
 
     def __init__(
         self,
+        *,
         n_embed=1024,
         embed_dim=256,
         ch=64,

libs/spandrel/spandrel/architectures/RetinexFormer/arch/retinexformer_arch.py

@@ -330,6 +330,7 @@ class RetinexFormer(nn.Module):
 
     def __init__(
         self,
+        *,
         in_channels=3,
         out_channels=3,
         n_feat=40,

libs/spandrel/spandrel/architectures/SAFMN/arch/safmn.py

@@ -162,7 +162,7 @@ def forward(self, x):
 class SAFMN(nn.Module):
     hyperparameters = {}
 
-    def __init__(self, dim: int, n_blocks=8, ffn_scale=2.0, upscaling_factor=4):
+    def __init__(self, *, dim: int, n_blocks=8, ffn_scale=2.0, upscaling_factor=4):
         super().__init__()
         self.to_feat = nn.Conv2d(3, dim, 3, 1, 1)
 

libs/spandrel/spandrel/architectures/SAFMNBCIE/arch/safmn_bcie.py

@@ -123,7 +123,7 @@ class SAFMN_BCIE(nn.Module):
     hyperparameters = {}
 
     def __init__(
-        self, dim: int, n_blocks=6, num_layers=6, ffn_scale=2.0, upscaling_factor=2
+        self, *, dim: int, n_blocks=6, num_layers=6, ffn_scale=2.0, upscaling_factor=2
     ):
         super().__init__()
 

libs/spandrel/spandrel/architectures/SCUNet/arch/SCUNet.py

@@ -279,6 +279,7 @@ class SCUNet(nn.Module):
 
     def __init__(
         self,
+        *,
         in_nc=3,
         config=[4, 4, 4, 4, 4, 4, 4],
         dim=64,

libs/spandrel/spandrel/architectures/SPAN/arch/span.py

@@ -243,6 +243,7 @@ class SPAN(nn.Module):
 
     def __init__(
         self,
+        *,
         num_in_ch: int,
         num_out_ch: int,
         feature_channels=48,

libs/spandrel/spandrel/architectures/SwiftSRGAN/arch/SwiftSRGAN.py

@@ -107,6 +107,7 @@ class Generator(nn.Module):
 
     def __init__(
         self,
+        *,
         in_channels: int = 3,
         num_channels: int = 64,
         num_blocks: int = 16,

libs/spandrel/spandrel/architectures/Swin2SR/arch/Swin2SR.py

@@ -908,6 +908,7 @@ class Swin2SR(nn.Module):
 
     def __init__(
         self,
+        *,
         img_size=64,
         patch_size=1,
         in_chans=3,

libs/spandrel/spandrel/architectures/SwinIR/arch/SwinIR.py

@@ -816,6 +816,7 @@ class SwinIR(nn.Module):
 
     def __init__(
         self,
+        *,
         img_size=64,
         patch_size=1,
         in_chans=3,

libs/spandrel/spandrel/util/__init__.py

@@ -177,6 +177,12 @@ def inner(cls: type[C]) -> type[C]:
             raise UserWarning(
                 "Class has **kwargs, which is not allowed in combination with @store_hyperparameters"
             )
+        if spec.args != ["self"]:
+            raise UserWarning(
+                "@store_hyperparameters requires all arguments of `"
+                + cls.__name__
+                + ".__init__` after `self` to be keyword arguments. Use `def __init__(self, *, a, b, c):`."
+            )
 
         @functools.wraps(old_init)
         def new_init(self: C, **kwargs):

libs/spandrel_extra_arches/spandrel_extra_arches/architectures/CodeFormer/arch/codeformer.py

@@ -610,6 +610,7 @@ class CodeFormer(VQAutoEncoder):
 
     def __init__(
         self,
+        *,
         dim_embd=512,
         n_head=8,
         n_layers=9,

libs/spandrel_extra_arches/spandrel_extra_arches/architectures/DDColor/arch/ddcolor.py

@@ -31,6 +31,7 @@ class DDColor(nn.Module):
 
     def __init__(
         self,
+        *,
         encoder_name="convnext-l",
         decoder_name="MultiScaleColorDecoder",
         num_input_channels=3,

libs/spandrel_extra_arches/spandrel_extra_arches/architectures/M3SNet/arch/M3SNet.py

@@ -171,6 +171,7 @@ class M3SNet(nn.Module):
 
     def __init__(
         self,
+        *,
         img_channel=3,
         width=32,
         middle_blk_num=1,

libs/spandrel_extra_arches/spandrel_extra_arches/architectures/MIRNet2/arch/mirnet_v2_arch.py

@@ -307,6 +307,7 @@ class MIRNet_v2(nn.Module):
 
     def __init__(
         self,
+        *,
         inp_channels=3,
         out_channels=3,
         n_feat=80,

libs/spandrel_extra_arches/spandrel_extra_arches/architectures/MPRNet/arch/MPRNet.py

@@ -398,6 +398,7 @@ class MPRNet(nn.Module):
 
     def __init__(
         self,
+        *,
         in_c: int = 3,
         out_c: int = 3,
         n_feat: int = 40,

libs/spandrel_extra_arches/spandrel_extra_arches/architectures/Restormer/arch/restormer_arch.py

@@ -222,6 +222,7 @@ class Restormer(nn.Module):
 
     def __init__(
         self,
+        *,
         inp_channels=3,
         out_channels=3,
         dim=48,

libs/spandrel_extra_arches/spandrel_extra_arches/architectures/SRFormer/arch/SRFormer.py

@@ -1024,6 +1024,7 @@ class SRFormer(nn.Module):
 
     def __init__(
         self,
+        *,
         img_size=64,
         patch_size=1,
         in_chans=3,