U
    ¯Ê¹jí  ã                   @   sb   d Z ddlZddlmZmZmZmZ ddlZddlZerFddl	m
Z
 neZ
G dd„ dejjƒZdS )z~ PyTorch MADGRAD optimizer

MADGRAD: https://arxiv.org/abs/2101.11075

Code from: https://github.com/facebookresearch/madgrad
é    N)ÚTYPE_CHECKINGÚAnyÚCallableÚOptional)Ú	_params_tc                       s€   e Zd ZdZdeeeeeedœ‡ fdd	„Zeed
œdd„ƒZ	eed
œdd„ƒZ
e ¡ deeg ef  ee dœdd„ƒZ‡  ZS )ÚMADGRADaî  
    MADGRAD_: A Momentumized, Adaptive, Dual Averaged Gradient Method for Stochastic
    Optimization.

    .. _MADGRAD: https://arxiv.org/abs/2101.11075

    MADGRAD is a general purpose optimizer that can be used in place of SGD or
    Adam may converge faster and generalize better. Currently GPU-only.
    Typically, the same learning rate schedule that is used for SGD or Adam may
    be used. The overall learning rate is not comparable to either method and
    should be determined by a hyper-parameter sweep.

    MADGRAD requires less weight decay than other methods, often as little as
    zero. Momentum values used for SGD or Adam's beta1 should work here also.

    On sparse problems both weight_decay and momentum should be set to 0.

    Arguments:
        params (iterable):
            Iterable of parameters to optimize or dicts defining parameter groups.
        lr (float):
            Learning rate (default: 1e-2).
        momentum (float):
            Momentum value in  the range [0,1) (default: 0.9).
        weight_decay (float):
            Weight decay, i.e. a L2 penalty (default: 0).
        eps (float):
            Term added to the denominator outside of the root operation to improve numerical stability. (default: 1e-6).
    ç{®Gáz„?çÍÌÌÌÌÌì?r   ç�íµ ÷Æ°>F)ÚparamsÚlrÚmomentumÚweight_decayÚepsÚdecoupled_decayc                    s„   |dk s|dkr t d|› d�ƒ‚|dkr8t d|› d�ƒ‚|dk rPt d|› d�ƒ‚|dk r`t d	ƒ‚t|||||d
�}tƒ  ||¡ d S )Nr   é   z	Momentum z must be in the range [0,1]zLearning rate z must be positivezWeight decay z must be non-negativezEps must be non-negative)r   r   r   r   r   )Ú
ValueErrorÚdictÚsuperÚ__init__)Úselfr   r   r   r   r   r   Údefaults©Ú	__class__© úQ/var/www/html/bwave/python/venv/lib/python3.8/site-packages/timm/optim/madgrad.pyr   7   s     	    ÿzMADGRAD.__init__)Úreturnc                 C   s   dS )NFr   ©r   r   r   r   Úsupports_memory_efficient_fp16M   s    z&MADGRAD.supports_memory_efficient_fp16c                 C   s   dS )NTr   r   r   r   r   Úsupports_flat_paramsQ   s    zMADGRAD.supports_flat_paramsN)Úclosurer   c              	   C   s  d}|dk	r&t  ¡ � |ƒ }W 5 Q R X | jD �]Ô}|d }|d | }|d }|d }d| }|d D �]˜}	|	jdkrxqf|	j}
|dkr”|
jr”td	ƒ‚| j|	 }t|ƒd
krèd
|d< t  |	¡|d< t  |	¡|d< |d
krèt  	|	¡ 
¡ |d< |d  d7  < |d }|d }|t |d ¡ }|d
k�rd|d �rF|	 d|d |  ¡ n|
j�rVtdƒ‚|
j|	|d� |
j�rT|
 ¡ }
|
 ¡ }|	 |
¡}| |
¡}| |
¡}| ¡  d¡ |¡}| ¡ j| ¡ |dd�}|
|
 }|j||d� |j||d� | ¡  d¡ |¡}|j|
|d� | ¡ j||d� |j| ¡ |dd�}| ¡ j|dd� |	j|dd� qf|d
k�r€| d¡ |¡}|	j||dd�}n|d }|j|
|
|d� | d¡ |¡}|j|
|d� |d
k�rØ|	 |j||dd�¡ qf|j||dd�}|	 d| ¡j||d� qfq,|S )z¦Performs a single optimization step.

        Arguments:
            closure (callable, optional): A closure that reevaluates the model and returns the loss.
        Nr   r   r   r   r   r   g        z5momentum != 0 is not compatible with sparse gradientsr   ÚstepÚgrad_sum_sqÚsÚx0r   g      ð?z;weight_decay option is not compatible with sparse gradients)ÚalphagUUUUUUÕ?)Úvalueéÿÿÿÿ)ÚtorchZenable_gradZparam_groupsÚgradZ	is_sparseÚRuntimeErrorÚstateÚlenZ
zeros_likeÚcloneÚdetachÚmathÚsqrtZmul_Zadd_ZcoalesceZ_valuesZsparse_maskÚpowZaddcdivZpow_Zaddcmul_Zcopy_)r   r    ZlossÚgroupr   r   r   r   ZckÚpr)   r+   r"   r#   ZlambZgrad_valZp_maskedZgrad_sum_sq_maskedZs_maskedZrms_masked_valsZx0_masked_valsZgrad_sqZp_kp1_masked_valsZrmsr$   Úzr   r   r   r!   U   s|    









zMADGRAD.step)r   r	   r   r
   F)N)Ú__name__Ú
__module__Ú__qualname__Ú__doc__r   ÚfloatÚboolr   Úpropertyr   r   r(   Zno_gradr   r   r!   Ú__classcell__r   r   r   r   r      s(   !     ùùr   )r8   r/   Útypingr   r   r   r   r(   Ztorch.optimZtorch.optim.optimizerr   ZoptimZ	Optimizerr   r   r   r   r   Ú<module>   s   