jTLPddlmZddlmZmZddlmZddlmZm Z m Z m Z m Z m Z mZmZmZmZddlZddlmZddlmZmZdd lmZmZed ejjd Ze eefZ ed eZ Gddee eZ e dZ! GddeZ"Gdde#Z$Gddee eZ%Gdde%ee eZ&Gdde%ee eZ'ee&ejje'ejjfZ(dS)) annotations)ABCabstractmethod)Enum) AnyCallableDictFinalGenericLiteralNewTypeTypeVarUnionoverloadN)Tensor)Selfoverride)SizeRequirements pad_tensorTT)bound covariantArchIdczeZdZdZdddfd ZeddZeddZddZe ddZ xZ S) Architecturez8 The abstract base class for all architectures. N)nameid ArchId | strdetectCallable[[StateDict], bool]r str | NonereturnNonectt||_|p||_||_dSN)super__init__r_id_name_detect)selfrr r __class__s TC:\Projects\Historical\venv\Lib\site-packages\spandrel/__helpers/model_descriptor.pyr(zArchitecture.__init__,s> "(**!%  rc|jS)z The unique ID of the architecture. For built-in architectures, this is the same as the module name. E.g. `spandrel.architectures.RestoreFormer` has the ID `RestoreFormer`. )r)r,s r.rzArchitecture.id9s xr/strc|jS)zX The name of the architecture. This is often the same as `id`. )r*r1s r.rzArchitecture.nameBs zr/ state_dict StateDictboolc,||S)a Inspects the given state dict and returns ``True`` if it is a state dict of this architecture. This guarantees that there are no false negatives, but there might be false positives. This is important to remember when ordering architectures in a registry. (Note: while false positives are allowed, they are supposed to be rare. So we do accept bug reports for false positives.) )r+r,r4s r.r zArchitecture.detectKs||J'''r/7ImageModelDescriptor[T] | MaskedImageModelDescriptor[T]cdS)a Loads the given state dict into a model. The hyperparameters will automatically be deduced. The state dict is assumed to be a state dict of this architecture, meaning that `detect` returned `True` for the state dict. If this is not the case, then the behavior of this function is unspecified (the model may be loaded incorrect or an error is thrown). Nr8s r.loadzArchitecture.loadVsr/)rrr r!rr"r#r$)r#r)r#r2)r4r5r#r6)r4r5r#r9) __name__ __module__ __qualname____doc__r(propertyrrr rr< __classcell__r-s@r.rr's        XX ( ( ( (   ^     r/r)SRFaceSR Inpainting Restorationc"eZdZdZdZ dZ dZdS) ModelTilingz< Describes whether and how a model supports tiling. rN)r=r>r?r@ SUPPORTED DISCOURAGEDINTERNALr;r/r.rIrIms=IK Hr/rIceZdZdZdS)UnsupportedDtypeErrorz An error that will be thrown by `.to` if the model does not support the given dtype. See `ModelBase.to` for more information. N)r=r>r?r@r;r/r.rPrPsr/rPc,eZdZdZdejfd4dZed5dZed6dZ ee d7dZ ed8dZ ed9dZ e d:d;d%Zedd*Zd>d+Zd>d,Zd>d-Zd?d@d/Zd>d0ZdAdBd3ZdS)C ModelBasez The base class of all model descriptors. This is mostly intended for `instanceof` checks in user code. Use `ModelDescriptor` for type hints instead. Nmodelrr4r5 architectureArchitecture[T]tags list[str] supports_halfr6supports_bfloat16scaleintinput_channelsoutput_channelssize_requirementsSizeRequirements | NonetilingrIc ||_||_||_ ||_ ||_ ||_ ||_ | |_ | p t|_ | |_ |j |dSr&) _model _architecturerVrXrYrZr\r]rr^r`rSload_state_dict) r,rSr4rTrVrXrYrZr\r]r^r`s r.r(zModelBase.__init__s .:#  $1 (9    $2 %4  3!1!3!3  $*   "":.....r/r#c|jS)z The model itself: a `torch.nn.Module` with weights loaded in. The specific subclass of `torch.nn.Module` depends on the model architecture. )rbr1s r.rSzModelBase.models {r/c|jS)z0 The architecture of the model. )rcr1s r.rTzModelBase.architectures !!r/PurposecdS)z, The purpose of this model. Nr;r1s r.purposezModelBase.purposes r/ torch.devicecXt|jjS)zq The device of the underlying module. Use `to` to move the model to a different device. )nextrS parametersdevicer1s r.rnzModelBase.devices#DJ))++,,33r/ torch.dtypecXt|jjS)zw The data type of the underlying module. Use `to` to cast the model to a different data type. )rlrSrmdtyper1s r.rqzModelBase.dtypes#DJ))++,,22r/rntorch.device | str | Nonerqtorch.dtype | NonercdSr&r;)r,rnrqs r.toz ModelBase.to s sr/cdSr&r;)r,rqs r.ruz ModelBase.tos.1cr/argsobjectc dfd }t|dkr~|d}t|tjr |d|nt|tjt fs| |d |nt d t|t|d kr%|d |d|d|dn2t|d krt d t|d d }dd }tdkrt dt|\|tj kr|j st|j d|tjkr|jst|j dt|t rtj|}|j|||S)a Moves and casts the parameters and buffers of the underlying module to the given device and data type. For more information, see https://pytorch.org/docs/stable/generated/torch.nn.Module.html#torch.nn.Module.to. Use `device` to get the current device and `dtype` to get the current data type of the model. Throws `UnsupportedDtypeError` if the model does not support the given data type. If you want to force a dtype cast, use `.model.to(dtype)` instead. rr2valuerxc>|vrtd|||<dS)Nz.to() got multiple values for keyword argument ) TypeError)rrzkwargss r.set_kwzModelBase.to..set_kw!s1v~~ WQU W WXXX F4LLLr/rrrqNrnz5to() expected a torch.device or torch.dtype, but got rJz2to() expected at most 2 positional arguments, got z&to() got unexpected keyword arguments z' does not support half precision (fp16)z$ does not support bfloat16 precision)rnrq)rr2rzrx)len isinstancetorchrqrnr2r|typepoplistfloat16rXrPrTbfloat16rYrSru)r,rwr}r~argrnrqs ` r.ruz ModelBase.tos4 ! ! ! ! ! ! t99>>q'C#u{++ w$$$$C%,!455 x%%%%WDQTIIWWYY!^^ F8T!W % % % F7DG $ $ $ $ YY]]PSYYPP -3JJx,F,F$*JJw$=$= v;;??ST&\\SSTT T   %%d.@%+(QQQ&&t/E&+(NNN fc " " *\&))F V5 111 r/cD|tj|S)z Moves the parameters and buffers of the underlying module to half precision (fp16). Same as `self.to(torch.half)`. )rurhalfr1s r.rzModelBase.halfNs   r/cD|tj|S)z Moves the parameters and buffers of the underlying module to bfloat16 precision. Same as `self.to(torch.bfloat16)`. )rurrr1s r.rzModelBase.bfloat16Ws  r/cD|tj|S)z Moves the parameters and buffers of the underlying module to single precision (fp32). Same as `self.to(torch.float)`. )rurfloatr1s r.rzModelBase.float`s   r/c8|j|S)z Moves the parameters and buffers of the underlying module to the CPU. Same as `self.to(torch.device("cpu"))`. )rScpur1s r.rz ModelBase.cpuis  r/ int | Nonec:|j||S)z Moves the parameters and buffers of the underlying module to the GPU. Same as `self.to(torch.device("cuda"))`. )rScuda)r,rns r.rzModelBase.cudars  r/c8|j|S)zf Sets the underlying module in evaluation mode. Same as `self.train(False)`. )rSevalr1s r.rzModelBase.eval{s  r/Tmodec:|j||S)zi Sets the underlying module in training mode. Same as `self.model.train(mode)`. )rStrain)r,rs r.rzModelBase.trains  r/)rSrr4r5rTrUrVrWrXr6rYr6rZr[r\r[r]r[r^r_r`rI)r#r)r#rU)r#rg)r#rj)r#ro)NN)rnrrrqrsr#r)rqror#r)rwrxr#r)r#rr&)rnrr#r)T)rr6r#r)r=r>r?r@rIrLr(rArSrTrrirnrqrrurrrrrrrr;r/r.rRrRs"6:)3C/C/C/C/C/JX"""X"    ^X  4 4 4X 4333X3-1$(X 111X17777rr/rRceZdZdZdejdfd fd Zeed!dZ e j d"dZ xZ S)#ImageModelDescriptorzi A model that takes an image as input and returns an image. See `__call__` for more information. NrSrr4r5rTrUri&Literal['SR', 'FaceSR', 'Restoration']rVrWrXr6rYrZr[r\r]r^r_r`rIcall_fn$Callable[[T, Tensor], Tensor] | Nonec |dks|dks Jdt|||||||| | | |  ||_| pd|_dS)NrGrz)Restoration models must have a scale of 1rXrYrZr\r]r^r`c||Sr&r;)rSimages r.z/ImageModelDescriptor.__init__..sur/r'r(_purpose_call_fn)r,rSr4rTrirVrXrYrZr\r]r^r`rr-s r.r(zImageModelDescriptor.__init__s" } $ $ 6)3 2     '/)+/  AH F$E$E r/r#c|jSr&rr1s r.rizImageModelDescriptor.purpose }r/rrc,t|jdkrtd|j|j\}}}}t||j\}}|jjr|j||j|}t|ts4Jdt|jj dt|| dd}|r|dd||jzd||jzf}|S) a Takes a single image tensor as input and returns a single image tensor as output. The `image` tensor must be a 4D tensor with shape `(1, input_channels, H, W)`. The data type (float32, float16, bfloat16) and device of the `image` tensor must be the same as the model. The range of the `image` tensor must be ``[0, 1]``. The output tensor will be a 4D tensor with shape `(1, output_channels, H*scale, W*scale)`. The data type and device of the output tensor will be the same as the `image` tensor. The range of the output tensor will be ``[0, 1]``. If the width and height of the `image` tensor do not satisfy the `size_requirements` of the model, then the `image` tensor will be padded to satisfy the requirements. The additional padding will be removed from the output tensor before returning it. If the image already satisfies the requirements, then no padding will be added. 4Expected image tensor to have 4 dimensions, but got Expected z# model to return a tensor, but got rr.N)rshape ValueErrorrr^rStrainingrrrrrr=clamp_rZ)r,r_hwdid_padoutputs r.__call__zImageModelDescriptor.__call__s@ u{  q Tu{TT [ 1a$E4+ABB :   JOO   tz511 F   d d ctDJ''0 c cUYZ`UaUa c c d d q!$$  EC!11tz>!13CQ^3CCDF r/)rSrr4r5rTrUrirrVrWrXr6rYr6rZr[r\r[r]r[r^r_r`rIrr)r#r)rrr#r)r=r>r?r@rIrLr(rArririnference_moderrBrCs@r.rrs 6:)38<$G$G$G$G$G$G$GL XXU%%%%%%%%r/rcfeZdZdZdejdfd fd Zeed!dZ d"dZ xZ S)#MaskedImageModelDescriptorz A model that takes an image and a mask for that image as input and returns an image. See `__call__` for more information. NrSrr4r5rTrUriLiteral['Inpainting']rVrWrXr6rYr\r[r]r^r_r`rIr,Callable[[T, Tensor, Tensor], Tensor] | Nonec t||||||d|| | |  ||_| pd|_dS)Nrrc|||Sr&r;)rSrmasks r.rz5MaskedImageModelDescriptor.__init__.. suuUD?Q?Qr/r)r,rSr4rTrirVrXrYr\r]r^r`rr-s r.r(z#MaskedImageModelDescriptor.__init__sd     '/)+/  07 R$Q$Q r/r#c|jSr&rr1s r.riz"MaskedImageModelDescriptor.purpose rr/rrrct|jdkrtd|jt|jdkrtd|j|j\}}}}tjdd||g}|j|krtd|d|jt ||j\}}t ||j\}}||j||}t|ts4Jdt|jj dt|| d d}|r|d d ||jzd ||jzf}|S) a Takes an image tensor and an image mask tensor as input and returns a single image tensor as output. The data type (float32, float16, bfloat16) and device of the `image` and `mask` tensors must be the same as the model. The `image` tensor must be a 4D tensor with shape `(1, input_channels, H, W)`. The range of the `image` tensor must be ``[0, 1]``. The `mask` tensor must be a 4D tensor with shape `(1, 1, H, W)`. The width and height must be the same as `image` tensor. The values of the `mask` tensor must be either 0 (keep) or 1 (inpaint). The output tensor will be a 4D tensor with shape `(1, output_channels, H, W)`. The data type and device of the output tensor will be the same as the `image` tensor. The range of the output tensor will be ``[0, 1]``. If the width and height of the `image` tensor do not satisfy the `size_requirements` of the model, then the `image` tensor will be padded to satisfy the requirements. The additional padding will be removed from the output tensor before returning it. If the image already satisfies the requirements, then no padding will be added. rrz3Expected mask tensor to have 4 dimensions, but got rzExpected mask shape to be z , but got rz$ model to returns a tensor, but got r.N)rrrrSizerr^rrSrrrr=rrZ) r,rrrrr mask_shaperrs r.rz#MaskedImageModelDescriptor.__call__s u{  q Tu{TT  tz??a  RdjRR [ 1aZAq! -- : # #OZOO4:OO  $E4+ABBT4#9::4tz5$77 F   e e dtDJ''0 d dVZ[aVbVb d d e e q!$$  EC!11tz>!13CQ^3CCDF r/)rSrr4r5rTrUrirrVrWrXr6rYr6r\r[r]r[r^r_r`rIrr)r#r)rrrrr#r) r=r>r?r@rIrLr(rArrirrBrCs@r.rrs6:)3@DSSSSSSSB XX11111111r/r)) __future__rabcrrenumrtypingrrr r r r r rrrrrtyping_extensionsrrsize_reqrrnnModulerr2r5rrrgrI ExceptionrPrRrrModelDescriptorr;r/r.rs""""""########                         ,,,,,,,,22222222 GCux$777 cN  3   8 8 8 8 8 3 8 8 8 v = >$4I|||||WQZ|||~VVVVV9Q<VVVr\\\\\1wqz\\\~)ux/1r/