o
    ,i8K                  $   @   s  d dl mZmZ d dlZd dlmZ ddlmZmZmZm	Z	m
Z
mZmZmZmZmZmZmZ ddgZG dd deZd	d
e
 de de de d	 e_dee dee dee dee dee dee dedededededededededef ddZdee dee dee dee dee dee dedededededededededef dd Ze	ed!		"	"	"	"d%dee dee dee dee dee dee d#ee dedededededededededef"d$dZdS )&    )ListOptionalN)Tensor   )_capturable_doc_default_to_fused_or_foreach_differentiable_doc_disable_dynamo_if_unsupported_foreach_doc!_get_capturable_supported_devices_get_scalar_dtype_maximize_doc_use_grad_for_differentiable_view_as_real	OptimizerParamsTRMSproprmspropc                       s~   e Zd Z										ddeded	ed
edededee dedef fddZ fddZdd Z	e
dddZ  ZS )r   {Gz?Gz?:0yE>r   FNparamslralphaepsweight_decaymomentumforeachmaximizedifferentiablec                    s   d|kst d| d|kst d| d|ks!t d| d|ks,t d| d|ks7t d| t||||||||	|
|d
}t || d S )Ng        zInvalid learning rate: zInvalid epsilon value: zInvalid momentum value: zInvalid weight_decay value: zInvalid alpha value: )
r   r   r   r   centeredr   
capturabler   r   r   )
ValueErrordictsuper__init__)selfr   r   r   r   r   r   r    r!   r   r   r   defaults	__class__ Q/home/ubuntu/SoloSpeech/.venv/lib/python3.10/site-packages/torch/optim/rmsprop.pyr%      s.   zRMSprop.__init__c                    s   t  | | jD ]_}|dd |dd |dd  |dd |dd |dd |d	 D ]4}| j|g }t|dkrgt|d
 sgt	|d
 }|d r]tj
|t |jdntj
|t d|d
< q3q	d S )Nr   r   r    Fr   r   r   r!   r   stepdtypedevicer.   )r$   __setstate__param_groups
setdefaultstategetlentorch	is_tensorfloattensorr   r/   )r&   r4   grouppp_statestep_valr(   r*   r+   r1   @   s*   

zRMSprop.__setstate__c                 C   s8  d}|d D ]}	|	j d u rq|t|	O }||	 |	j jr"td||	j  | j|	 }
t|
dkrs|d rAtjdt	 |	j
dntjdt	 d|
d	< tj|	tjd
|
d< |d dkretj|	tjd
|
d< |d rstj|	tjd
|
d< ||
d  ||
d	  |d dkr||
d  |d r||
d  q|S )NFr   z)RMSprop does not support sparse gradientsr   r!   r*   r-   r0   r,   )memory_format
square_avgr   momentum_bufferr    grad_avg)gradr7   
is_complexappend	is_sparseRuntimeErrorr4   r6   zerosr   r/   
zeros_likepreserve_format)r&   r;   params_with_gradgradssquare_avgsmomentum_buffer_list	grad_avgsstate_stepshas_complexr<   r4   r*   r*   r+   _init_groupU   sD   






zRMSprop._init_groupc                 C   s   |    d}|dur!t  | }W d   n1 sw   Y  | jD ]B}g }g }g }g }g }g }	| |||||||	}
t||||||	|d |d |d |d |d |d |d |d	 |d
 |d |
d q$|S )zPerforms a single optimization step.

        Args:
            closure (Callable, optional): A closure that reevaluates the model
                and returns the loss.
        Nr   r   r   r   r   r    r   r   r   r!   )r   r   r   r   r   r    r   r   r   r!   rQ   ) _cuda_graph_capture_health_checkr7   enable_gradr2   rR   r   )r&   closurelossr;   rK   rL   rM   rO   rN   rP   rQ   r*   r*   r+   r,      sT   


zRMSprop.step)
r   r   r   r   r   FFNFFN)__name__
__module____qualname__r   r9   r   boolr%   r1   rR   r   r,   __classcell__r*   r*   r(   r+   r      sD    
'3a  Implements RMSprop algorithm.

    .. math::
       \begin{aligned}
            &\rule{110mm}{0.4pt}                                                                 \\
            &\textbf{input}      : \alpha \text{ (alpha)},\: \gamma \text{ (lr)},
                \: \theta_0 \text{ (params)}, \: f(\theta) \text{ (objective)}                   \\
            &\hspace{13mm}   \lambda \text{ (weight decay)},\: \mu \text{ (momentum)},\: centered\\
            &\textbf{initialize} : v_0 \leftarrow 0 \text{ (square average)}, \:
                \textbf{b}_0 \leftarrow 0 \text{ (buffer)}, \: g^{ave}_0 \leftarrow 0     \\[-1.ex]
            &\rule{110mm}{0.4pt}                                                                 \\
            &\textbf{for} \: t=1 \: \textbf{to} \: \ldots \: \textbf{do}                         \\
            &\hspace{5mm}g_t           \leftarrow   \nabla_{\theta} f_t (\theta_{t-1})           \\
            &\hspace{5mm}if \: \lambda \neq 0                                                    \\
            &\hspace{10mm} g_t \leftarrow g_t + \lambda  \theta_{t-1}                            \\
            &\hspace{5mm}v_t           \leftarrow   \alpha v_{t-1} + (1 - \alpha) g^2_t
                \hspace{8mm}                                                                     \\
            &\hspace{5mm} \tilde{v_t} \leftarrow v_t                                             \\
            &\hspace{5mm}if \: centered                                                          \\
            &\hspace{10mm} g^{ave}_t \leftarrow g^{ave}_{t-1} \alpha + (1-\alpha) g_t            \\
            &\hspace{10mm} \tilde{v_t} \leftarrow \tilde{v_t} -  \big(g^{ave}_{t} \big)^2        \\
            &\hspace{5mm}if \: \mu > 0                                                           \\
            &\hspace{10mm} \textbf{b}_t\leftarrow \mu \textbf{b}_{t-1} +
                g_t/ \big(\sqrt{\tilde{v_t}} +  \epsilon \big)                                   \\
            &\hspace{10mm} \theta_t \leftarrow \theta_{t-1} - \gamma \textbf{b}_t                \\
            &\hspace{5mm} else                                                                   \\
            &\hspace{10mm}\theta_t      \leftarrow   \theta_{t-1} -
                \gamma  g_t/ \big(\sqrt{\tilde{v_t}} + \epsilon \big)  \hspace{3mm}              \\
            &\rule{110mm}{0.4pt}                                                          \\[-1.ex]
            &\bf{return} \:  \theta_t                                                     \\[-1.ex]
            &\rule{110mm}{0.4pt}                                                          \\[-1.ex]
       \end{aligned}

    For further details regarding the algorithm we refer to
    `lecture notes <https://www.cs.toronto.edu/~tijmen/csc321/slides/lecture_slides_lec6.pdf>`_ by G. Hinton.
    and centered version `Generating Sequences
    With Recurrent Neural Networks <https://arxiv.org/pdf/1308.0850v5.pdf>`_.
    The implementation here takes the square root of the gradient average before
    adding epsilon (note that TensorFlow interchanges these two operations). The effective
    learning rate is thus :math:`\gamma/(\sqrt{v} + \epsilon)` where :math:`\gamma`
    is the scheduled learning rate and :math:`v` is the weighted moving average
    of the squared gradient.
    a  
    Args:
        params (iterable): iterable of parameters to optimize or dicts defining
            parameter groups
        lr (float, optional): learning rate (default: 1e-2)
        momentum (float, optional): momentum factor (default: 0)
        alpha (float, optional): smoothing constant (default: 0.99)
        eps (float, optional): term added to the denominator to improve
            numerical stability (default: 1e-8)
        centered (bool, optional) : if ``True``, compute the centered RMSProp,
            the gradient is normalized by an estimation of its variance
        weight_decay (float, optional): weight decay (L2 penalty) (default: 0)
        z	
        z

    r   rL   rM   rO   rN   rP   r   r   r   r   r   r    r   r   r!   rQ   c       
         C   s  t | D ]\}}|| }tj s,|r,t }|jj|jjkr$|jj|v s,J d| d|| }|s4|n| }|| }|d7 }|	dkrJ|j||	d}t|}|r`t	|}t	|}t	|}|
|j||d| d |r|| }|rzt	|}||d|  |j||dd }n| }|r||}n||}|
dkr|| }|rt	|}|
|
|| |j|| d q|j||| d qd S )NIIf capturable=True, params and state_steps must be on supported devices: .r   r   r   value)	enumerater7   _utilsis_compilingr   r/   typeaddrD   view_as_realmul_addcmul_lerp_addcmulsqrt_sqrtadd_addcdiv_)r   rL   rM   rO   rN   rP   r   r   r   r   r   r    r   r   r!   rQ   iparamr,   capturable_supported_devicesrC   r@   is_complex_paramrB   avgbufr*   r*   r+   _single_tensor_rmsprop  sL   







rw   c       
            sd  t | dkrd S |rJ dtj s.|r.t  t fddt| |D s.J d  dt| |||||g}|	 D ]\\}}}}}}}|re||g}|
dkrV|
| |r]|
| t|g|R   |rlt|}|d jrtj|tjddd	dd
 nt|d |	dkr|rtj|||	d
 ntj|||	d
}t|| tj|||d| d |rt||d|  tj|||dd}t| t|| nt|}t|| |
dkrt||
 t||| |rt|tjrt|| }t|| q=tj||| d
 q=|r%t|tjr%t||  t||| q=tj|||| d q=d S )Nr   z#_foreach ops don't support autogradc                 3   s0    | ]\}}|j j|j jko|j j v V  qd S rW   )r/   rf   ).0r<   r,   rs   r*   r+   	<genexpr>c  s    

z(_multi_tensor_rmsprop.<locals>.<genexpr>r]   r^   g      ?cpu)r/   r_   r   r`   rb   )r6   r7   rd   re   r   allzipr   "_group_tensors_by_device_and_dtypevaluesrE   r   _foreach_negis_cpu_foreach_add_r:   _foreach_add_foreach_mul__foreach_addcmul__foreach_lerp__foreach_addcmul_foreach_sqrt__foreach_sqrt_foreach_addcdiv_
isinstancer   _foreach_mul_foreach_div_)r   rL   rM   rO   rN   rP   r   r   r   r   r   r    r   r   r!   rQ   grouped_tensorsgrouped_paramsgrouped_gradsgrouped_square_avgsgrouped_grad_avgsgrouped_momentum_buffer_listgrouped_state_steps_state_and_gradsru   momentum_lrr*   ry   r+   _multi_tensor_rmspropH  s   








r   )single_tensor_fnFr   c                C   s   t j stdd |D std|du rt| |dd\}}|r*t j r*td|r4t j s4t}nt	}|| |||||||||||||	||
d dS )	zsFunctional API that performs rmsprop algorithm computation.
    See :class:`~torch.optim.RMSProp` for details.
    c                 s   s    | ]	}t |tjV  qd S rW   )r   r7   r   )rx   tr*   r*   r+   rz     s    
zrmsprop.<locals>.<genexpr>zPAPI has changed, `state_steps` argument must contain a list of singleton tensorsNF)	use_fusedz6torch.jit.script not supported with foreach optimizers)
r   r   r   r   r   r    r   r!   r   rQ   )
r7   rd   re   r|   rG   r   jitis_scriptingr   rw   )r   rL   rM   rO   rN   rP   r   r   r   r!   rQ   r   r   r   r   r   r    r   funcr*   r*   r+   r     sB   

)NFFFF)typingr   r   r7   r   	optimizerr   r   r   r	   r
   r   r   r   r   r   r   r   __all__r   __doc__r9   r[   rw   r   r   r*   r*   r*   r+   <module>   s   8 *+A	

G	

s
	
