
    Vhm:                         d dl Z d dlmZmZ d dlZd dlmZmZ d dlmZ	m
Z
 d dlmZ ddlmZ ddlmZ g d	Z G d
 de      Z G d de      Zeeee   ef   Z G d de      Z G d de      Z G d de      Zy)    N)OptionalUnion)SizeTensor)
functionalinit)	Parameter   )CrossMapLRN2d)Module)LocalResponseNormr   	LayerNorm	GroupNormRMSNormc                        e Zd ZU dZg dZeed<   eed<   eed<   eed<   	 ddededededdf
 fd	Zd
e	de	fdZ
d Z xZS )r   a  Applies local response normalization over an input signal.

    The input signal is composed of several input planes, where channels occupy the second dimension.
    Applies normalization across channels.

    .. math::
        b_{c} = a_{c}\left(k + \frac{\alpha}{n}
        \sum_{c'=\max(0, c-n/2)}^{\min(N-1,c+n/2)}a_{c'}^2\right)^{-\beta}

    Args:
        size: amount of neighbouring channels used for normalization
        alpha: multiplicative factor. Default: 0.0001
        beta: exponent. Default: 0.75
        k: additive factor. Default: 1

    Shape:
        - Input: :math:`(N, C, *)`
        - Output: :math:`(N, C, *)` (same shape as input)

    Examples::

        >>> lrn = nn.LocalResponseNorm(2)
        >>> signal_2d = torch.randn(32, 5, 24, 24)
        >>> signal_4d = torch.randn(16, 5, 7, 7, 7, 7)
        >>> output_2d = lrn(signal_2d)
        >>> output_4d = lrn(signal_4d)

    )sizealphabetakr   r   r   r   returnNc                 Z    t         |           || _        || _        || _        || _        y Nsuper__init__r   r   r   r   selfr   r   r   r   	__class__s        N/home/dcms/DCMS/lib/python3.12/site-packages/torch/nn/modules/normalization.pyr   zLocalResponseNorm.__init__5   ,     		
	    inputc                     t        j                  || j                  | j                  | j                  | j
                        S r   )Flocal_response_normr   r   r   r   r   r"   s     r   forwardzLocalResponseNorm.forward>   s+    $$UDIItzz499dffUUr!   c                 :     dj                   di | j                  S Nz){size}, alpha={alpha}, beta={beta}, k={k} format__dict__r   s    r   
extra_reprzLocalResponseNorm.extra_reprA       A:AARDMMRRr!   )-C6?      ?g      ?)__name__
__module____qualname____doc____constants__int__annotations__floatr   r   r'   r/   __classcell__r   s   @r   r   r      ss    : 3M
IL
KH NQ %49EJ	VV V VSr!   r   c                   ~     e Zd ZU eed<   eed<   eed<   eed<   	 ddededededdf
 fdZdedefd	Zde	fd
Z
 xZS )r   r   r   r   r   r   Nc                 Z    t         |           || _        || _        || _        || _        y r   r   r   s        r   r   zCrossMapLRN2d.__init__K   r    r!   r"   c                     t        j                  || j                  | j                  | j                  | j
                        S r   )_cross_map_lrn2dapplyr   r   r   r   r&   s     r   r'   zCrossMapLRN2d.forwardT   s+    %%eTYY

DIItvvVVr!   c                 :     dj                   di | j                  S r)   r+   r.   s    r   r/   zCrossMapLRN2d.extra_reprW   r0   r!   )r1   r2   r
   )r3   r4   r5   r8   r9   r:   r   r   r'   strr/   r;   r<   s   @r   r   r   E   so    
IL
KH NO %49EJ	WV W WSC Sr!   r   c                        e Zd ZU dZg dZeedf   ed<   eed<   e	ed<   	 	 	 	 	 dde
dede	de	d	df
 fd
ZddZded	efdZd	efdZ xZS )r   a  Applies Layer Normalization over a mini-batch of inputs.

    This layer implements the operation as described in
    the paper `Layer Normalization <https://arxiv.org/abs/1607.06450>`__

    .. math::
        y = \frac{x - \mathrm{E}[x]}{ \sqrt{\mathrm{Var}[x] + \epsilon}} * \gamma + \beta

    The mean and standard-deviation are calculated over the last `D` dimensions, where `D`
    is the dimension of :attr:`normalized_shape`. For example, if :attr:`normalized_shape`
    is ``(3, 5)`` (a 2-dimensional shape), the mean and standard-deviation are computed over
    the last 2 dimensions of the input (i.e. ``input.mean((-2, -1))``).
    :math:`\gamma` and :math:`\beta` are learnable affine transform parameters of
    :attr:`normalized_shape` if :attr:`elementwise_affine` is ``True``.
    The variance is calculated via the biased estimator, equivalent to
    `torch.var(input, unbiased=False)`.

    .. note::
        Unlike Batch Normalization and Instance Normalization, which applies
        scalar scale and bias for each entire channel/plane with the
        :attr:`affine` option, Layer Normalization applies per-element scale and
        bias with :attr:`elementwise_affine`.

    This layer uses statistics computed from input data in both training and
    evaluation modes.

    Args:
        normalized_shape (int or list or torch.Size): input shape from an expected input
            of size

            .. math::
                [* \times \text{normalized\_shape}[0] \times \text{normalized\_shape}[1]
                    \times \ldots \times \text{normalized\_shape}[-1]]

            If a single integer is used, it is treated as a singleton list, and this module will
            normalize over the last dimension which is expected to be of that specific size.
        eps: a value added to the denominator for numerical stability. Default: 1e-5
        elementwise_affine: a boolean value that when set to ``True``, this module
            has learnable per-element affine parameters initialized to ones (for weights)
            and zeros (for biases). Default: ``True``.
        bias: If set to ``False``, the layer will not learn an additive bias (only relevant if
            :attr:`elementwise_affine` is ``True``). Default: ``True``.

    Attributes:
        weight: the learnable weights of the module of shape
            :math:`\text{normalized\_shape}` when :attr:`elementwise_affine` is set to ``True``.
            The values are initialized to 1.
        bias:   the learnable bias of the module of shape
                :math:`\text{normalized\_shape}` when :attr:`elementwise_affine` is set to ``True``.
                The values are initialized to 0.

    Shape:
        - Input: :math:`(N, *)`
        - Output: :math:`(N, *)` (same shape as input)

    Examples::

        >>> # NLP Example
        >>> batch, sentence_length, embedding_dim = 20, 5, 10
        >>> embedding = torch.randn(batch, sentence_length, embedding_dim)
        >>> layer_norm = nn.LayerNorm(embedding_dim)
        >>> # Activate module
        >>> layer_norm(embedding)
        >>>
        >>> # Image Example
        >>> N, C, H, W = 20, 5, 10, 10
        >>> input = torch.randn(N, C, H, W)
        >>> # Normalize over the last three dimensions (i.e. the channel and spatial dimensions)
        >>> # as shown in the image below
        >>> layer_norm = nn.LayerNorm([C, H, W])
        >>> output = layer_norm(input)

    .. image:: ../_static/img/nn/layer_norm.jpg
        :scale: 50 %

    normalized_shapeepselementwise_affine.rF   rG   rH   Nbiasr   c                    ||d}t         |           t        |t        j                        r|f}t        |      | _        || _        || _        | j                  rrt        t        j                  | j                  fi |      | _        |r/t        t        j                  | j                  fi |      | _        n7| j                  dd        n$| j                  dd        | j                  dd        | j                          y )NdevicedtyperI   weight)r   r   
isinstancenumbersIntegraltuplerF   rG   rH   r	   torchemptyrN   rI   register_parameterreset_parameters)	r   rF   rG   rH   rI   rL   rM   factory_kwargsr   s	           r   r   zLayerNorm.__init__   s     %+U;&(8(89 02 %&6 7"4""#D11D^DDK %KK 5 5HH	 ''5##Hd3##FD1r!   c                     | j                   rLt        j                  | j                         | j                   t        j
                  | j                         y y y r   )rH   r   ones_rN   rI   zeros_r.   s    r   rV   zLayerNorm.reset_parameters   s?    ""JJt{{#yy$DII& % #r!   r"   c                     t        j                  || j                  | j                  | j                  | j
                        S r   )r$   
layer_normrF   rN   rI   rG   r&   s     r   r'   zLayerNorm.forward   s0    ||4(($++tyy$((
 	
r!   c                 :     dj                   di | j                  S )NF{normalized_shape}, eps={eps}, elementwise_affine={elementwise_affine}r*   r+   r.   s    r   r/   zLayerNorm.extra_repr   s)    = 66<fN?C}}N	
r!   )h㈵>TTNNr   N)r3   r4   r5   r6   r7   rR   r8   r9   r:   bool_shape_tr   rV   r   r'   rC   r/   r;   r<   s   @r   r   r   ^   s    KZ FMCHo%	J
 #' "    !	 
   
 B'
V 
 


C 
r!   r   c                        e Zd ZU dZg dZeed<   eed<   eed<   eed<   	 	 	 	 ddededededdf
 fd	Z	dd
Z
dedefdZdefdZ xZS )r   a  Applies Group Normalization over a mini-batch of inputs.

    This layer implements the operation as described in
    the paper `Group Normalization <https://arxiv.org/abs/1803.08494>`__

    .. math::
        y = \frac{x - \mathrm{E}[x]}{ \sqrt{\mathrm{Var}[x] + \epsilon}} * \gamma + \beta

    The input channels are separated into :attr:`num_groups` groups, each containing
    ``num_channels / num_groups`` channels. :attr:`num_channels` must be divisible by
    :attr:`num_groups`. The mean and standard-deviation are calculated
    separately over the each group. :math:`\gamma` and :math:`\beta` are learnable
    per-channel affine transform parameter vectors of size :attr:`num_channels` if
    :attr:`affine` is ``True``.
    The variance is calculated via the biased estimator, equivalent to
    `torch.var(input, unbiased=False)`.

    This layer uses statistics computed from input data in both training and
    evaluation modes.

    Args:
        num_groups (int): number of groups to separate the channels into
        num_channels (int): number of channels expected in input
        eps: a value added to the denominator for numerical stability. Default: 1e-5
        affine: a boolean value that when set to ``True``, this module
            has learnable per-channel affine parameters initialized to ones (for weights)
            and zeros (for biases). Default: ``True``.

    Shape:
        - Input: :math:`(N, C, *)` where :math:`C=\text{num\_channels}`
        - Output: :math:`(N, C, *)` (same shape as input)

    Examples::

        >>> input = torch.randn(20, 6, 10, 10)
        >>> # Separate 6 channels into 3 groups
        >>> m = nn.GroupNorm(3, 6)
        >>> # Separate 6 channels into 6 groups (equivalent with InstanceNorm)
        >>> m = nn.GroupNorm(6, 6)
        >>> # Put all 6 channels into a single group (equivalent with LayerNorm)
        >>> m = nn.GroupNorm(1, 6)
        >>> # Activating the module
        >>> output = m(input)
    )
num_groupsnum_channelsrG   affinerd   re   rG   rf   Nr   c                    ||d}t         |           ||z  dk7  rt        d      || _        || _        || _        || _        | j                  rIt        t        j                  |fi |      | _
        t        t        j                  |fi |      | _        n$| j                  dd        | j                  dd        | j                          y )NrK   r   z,num_channels must be divisible by num_groupsrN   rI   )r   r   
ValueErrorrd   re   rG   rf   r	   rS   rT   rN   rI   rU   rV   )	r   rd   re   rG   rf   rL   rM   rW   r   s	           r   r   zGroupNorm.__init__  s     %+U;*$)KLL$(;;#EKK$O$OPDK!%++l"Mn"MNDI##Hd3##FD1r!   c                     | j                   r?t        j                  | j                         t        j                  | j
                         y y r   )rf   r   rY   rN   rZ   rI   r.   s    r   rV   zGroupNorm.reset_parameters3  s.    ;;JJt{{#KK		" r!   r"   c                     t        j                  || j                  | j                  | j                  | j
                        S r   )r$   
group_normrd   rN   rI   rG   r&   s     r   r'   zGroupNorm.forward8  s)    ||E4??DKKDHHUUr!   c                 :     dj                   di | j                  S )Nz8{num_groups}, {num_channels}, eps={eps}, affine={affine}r*   r+   r.   s    r   r/   zGroupNorm.extra_repr;  s$    PIPP 
mm
 	
r!   )r_   TNNr`   )r3   r4   r5   r6   r7   r8   r9   r:   ra   r   rV   r   r'   rC   r/   r;   r<   s   @r   r   r      s    +Z DMO	JL      	 
   
 6#
VV V V
C 
r!   r   c            	            e Zd ZU dZg dZeedf   ed<   ee	   ed<   e
ed<   	 	 	 	 ddedee	   de
ddf fd	Zdd
Zdej                  dej                  fdZdefdZ xZS )r   a  Applies Root Mean Square Layer Normalization over a mini-batch of inputs.

    This layer implements the operation as described in
    the paper `Root Mean Square Layer Normalization <https://arxiv.org/pdf/1910.07467.pdf>`__

    .. math::
        y_i = \frac{x_i}{\mathrm{RMS}(x)} * \gamma_i, \quad
        \text{where} \quad \text{RMS}(x) = \sqrt{\epsilon + \frac{1}{n} \sum_{i=1}^{n} x_i^2}

    The RMS is taken over the last ``D`` dimensions, where ``D``
    is the dimension of :attr:`normalized_shape`. For example, if :attr:`normalized_shape`
    is ``(3, 5)`` (a 2-dimensional shape), the RMS is computed over
    the last 2 dimensions of the input.

    Args:
        normalized_shape (int or list or torch.Size): input shape from an expected input
            of size

            .. math::
                [* \times \text{normalized\_shape}[0] \times \text{normalized\_shape}[1]
                    \times \ldots \times \text{normalized\_shape}[-1]]

            If a single integer is used, it is treated as a singleton list, and this module will
            normalize over the last dimension which is expected to be of that specific size.
        eps: a value added to the denominator for numerical stability. Default: :func:`torch.finfo(x.dtype).eps`
        elementwise_affine: a boolean value that when set to ``True``, this module
            has learnable per-element affine parameters initialized to ones (for weights). Default: ``True``.

    Shape:
        - Input: :math:`(N, *)`
        - Output: :math:`(N, *)` (same shape as input)

    Examples::

        >>> rms_norm = nn.RMSNorm([2, 3])
        >>> input = torch.randn(2, 2, 3)
        >>> rms_norm(input)

    rE   .rF   rG   rH   Nr   c                 \   ||d}t         |           t        |t        j                        r|f}t        |      | _        || _        || _        | j                  r/t        t        j                  | j                  fi |      | _        n| j                  dd        | j                          y )NrK   rN   )r   r   rO   rP   rQ   rR   rF   rG   rH   r	   rS   rT   rN   rU   rV   )r   rF   rG   rH   rL   rM   rW   r   s          r   r   zRMSNorm.__init__n  s     %+U;&(8(89 02 %&6 7"4""#D11D^DDK ##Hd3r!   c                 \    | j                   r t        j                  | j                         yy)zS
        Resets parameters based on their initialization used in __init__.
        N)rH   r   rY   rN   r.   s    r   rV   zRMSNorm.reset_parameters  s"     ""JJt{{# #r!   xc                 n    t        j                  || j                  | j                  | j                        S )z$
        Runs forward pass.
        )r$   rms_normrF   rN   rG   )r   rp   s     r   r'   zRMSNorm.forward  s'     zz!T22DKKJJr!   c                 :     dj                   di | j                  S )z5
        Extra information about the module.
        r^   r*   r+   r.   s    r   r/   zRMSNorm.extra_repr  s)    
= 66<fN?C}}N	
r!   )NTNNr`   )r3   r4   r5   r6   r7   rR   r8   r9   r   r:   ra   rb   r   rV   rS   r   r'   rC   r/   r;   r<   s   @r   r   r   A  s    &N FMCHo%	%
  $#' "  e_  !	  
 0$K K%,, K
C 
r!   r   )rP   typingr   r   rS   r   r   torch.nnr   r$   r   torch.nn.parameterr	   
_functionsr   r@   moduler   __all__r   r8   listrb   r   r   r   r*   r!   r   <module>r{      s     "   * ( 9  V1S 1ShSF S, d3i%&C
 C
LZ
 Z
zY
f Y
r!   