Ë
    Ž\;j’Z  ã                   ó†   — d dl Z d dl mZ d dlmZ d dlmZ d dlmZ d dl	m
Z
 d dlmZ d dlmZ d d	lmZ g Z G d
„ de«      Zy)é    N)Ú_C_ops)Ú	framework)Úbase)ÚProgram)ÚLayerHelper)Úsignature_safe_contextmanager)Úin_dynamic_mode)Ú	Optimizerc                   ó  ‡ — e Zd ZdZ	 	 	 	 dˆ fd„	Zd„ Zd„ Zej                  	 dd„«       Z	e
j                  ej                  d„ «       «       Zeej                  dd„«       «       Zej                  dd„«       Zd	„ Zd
„ Zˆ xZS )ÚModelAverageay  
    The ModelAverage optimizer accumulates specific continuous historical
    parameters during training. The accumulated historical range can be controlled
    by the passed ``average_window_rate`` argument. The averaged ``Parameter`` are
    used in the prediction, which usually can improve the accuracy of the prediction.

    Accumulate the average of the ``Parameter`` in the sliding window, the result will be saved
    in a temporary variable, can be applied to the current model's ``Parameter`` by calling
    the ``apply()`` method, and the current model ``Parameter`` can be restored by calling
    the ``restore()`` method.

    The window size for calculating the average is determined by ``average_window_rate``,
    ``min_average_window``, ``max_average_window`` and the current ``Parameter`` update times (num_updates).

    When the cumulative times (num_accumulates) is greater than the specific window
    threshold (average_window), the accumulated ``Parameter`` temporary variable is set to 0.0.
    The following example will help to understand the role of these arguments:

    ::

        if num_accumulates >= min_average_window and num_accumulates >= min(max_average_window, num_updates * average_window_rate):
            num_accumulates = 0

    In the above conditional judgment statement, ``num_accumulates`` indicates the current
    accumulated number, which can be abstractly understood as the length of the cumulative window.
    The length of the window must be at least the length set by the ``min_average_window`` argument,
    and cannot exceed the length specified by the ``max_average_window`` argument or
    ``num_updates * average_window_rate``, where ``num_updates`` indicates the current ``Parameter``
    update times, ``average_window_rate`` is a coefficient that calculates the length of the window.

    Args:
        average_window_rate (float): The calculate ratio of the window length relative to ``Parameter`` update times.
        parameters (list, optional): List of ``Tensor`` names to update to minimize ``loss``. \
            This parameter is required in dygraph mode. \
            The default value is None in static graph mode, at this time all parameters will be updated.
        min_average_window (int, optional): the minimum size of average window length. The default value is 10000.
        max_average_window (int, optional): The maximum size of average window length. The default value is 10000.
        name (str, optional): Normally there is no need for user to set this property.
            For more information, please refer to :ref:`api_guide_Name`.
            The default value is None.

    Examples:

        .. code-block:: python

            >>> # doctest: +SKIP("Cannot get source code by to_static in REPL")
            >>> import numpy as np
            >>> import paddle
            >>> import paddle.nn as nn
            >>> import paddle.optimizer as opt

            >>> BATCH_SIZE = 16
            >>> BATCH_NUM = 4
            >>> EPOCH_NUM = 4

            >>> IMAGE_SIZE = 784
            >>> CLASS_NUM = 10

            >>> # define a random dataset
            >>> class RandomDataset(paddle.io.Dataset):
            ...     def __init__(self, num_samples):
            ...         self.num_samples = num_samples
            ...     def __getitem__(self, idx):
            ...         image = np.random.random([IMAGE_SIZE]).astype('float32')
            ...         label = np.random.randint(0, CLASS_NUM - 1, (1, )).astype('int64')
            ...         return image, label
            ...     def __len__(self):
            ...         return self.num_samples
            ...
            >>> class LinearNet(nn.Layer):
            ...     def __init__(self):
            ...         super().__init__()
            ...         self._linear = nn.Linear(IMAGE_SIZE, CLASS_NUM)
            ...         self.bias = self._linear.bias
            ...
            ...     @paddle.jit.to_static
            ...     def forward(self, x):
            ...         return self._linear(x)
            ...
            >>> def train(layer, loader, loss_fn, opt, model_average):
            ...     for epoch_id in range(EPOCH_NUM):
            ...         for batch_id, (image, label) in enumerate(loader()):
            ...             out = layer(image)
            ...             loss = loss_fn(out, label)
            ...             loss.backward()
            ...             opt.step()
            ...             model_average.step()
            ...             opt.clear_grad()
            ...             model_average.clear_grad()
            ...             print("Train Epoch {} batch {}: loss = {}, bias = {}".format(
            ...                 epoch_id, batch_id, np.mean(loss.numpy()), layer.bias.numpy()))
            ...
            >>> def evaluate(layer, loader, loss_fn):
            ...     for batch_id, (image, label) in enumerate(loader()):
            ...         out = layer(image)
            ...         loss = loss_fn(out, label)
            ...         loss.backward()
            ...         print("Evaluate batch {}: loss = {}, bias = {}".format(
            ...             batch_id, np.mean(loss.numpy()), layer.bias.numpy()))
            ...
            >>> # create network
            >>> layer = LinearNet()
            >>> loss_fn = nn.CrossEntropyLoss()
            >>> optimizer = opt.Momentum(learning_rate=0.2, momentum=0.1, parameters=layer.parameters())
            >>> model_average = paddle.incubate.ModelAverage(
            ...     0.15,
            ...     parameters=layer.parameters(),
            ...     min_average_window=2,
            ...     max_average_window=10
            ... )
            ...
            >>> # create data loader
            >>> dataset = RandomDataset(BATCH_NUM * BATCH_SIZE)
            >>> loader = paddle.io.DataLoader(dataset,
            ...     batch_size=BATCH_SIZE,
            ...     shuffle=True,
            ...     drop_last=True,
            ...     num_workers=2)
            ...
            >>> # create data loader
            >>> eval_loader = paddle.io.DataLoader(dataset,
            ...     batch_size=BATCH_SIZE,
            ...     shuffle=True,
            ...     drop_last=True,
            ...     num_workers=1
            ... )
            ...
            >>> # train
            >>> train(layer, loader, loss_fn, optimizer, model_average)

            >>> print("\nEvaluate With ModelAverage")
            >>> with model_average.apply(need_restore=False):
            ...     evaluate(layer, eval_loader, loss_fn)

            >>> print("\nEvaluate With Restored Paramters")
            >>> model_average.restore()
            >>> evaluate(layer, eval_loader, loss_fn)

    c                 ól  •— t         ‰
| �  d|d d |¬«       t        | j                  j                  «      | _        || _        || _        || _        d| _	        t        «       �s<t        j                  «       j                  «       }|r|n|j                  «       }| j                  ||«       |D ]  }| j!                  ||d g«       Œ t#        «       | _        | j$                  j                  «       }	t        j&                  | j$                  ¬«      5  |D ]  }| j)                  |	|«       Œ 	 d d d «       t#        «       | _        | j*                  j                  «       }	t        j&                  | j*                  ¬«      5  |D ]  }| j-                  |	|«       Œ 	 d d d «       y y # 1 sw Y   ŒwxY w# 1 sw Y   y xY w)Ng        )Úlearning_rateÚ
parametersÚweight_decayÚ	grad_clipÚnameÚaverage_accumulates)Úmain_program)ÚsuperÚ__init__r   Ú	__class__Ú__name__ÚhelperÚaverage_windowÚmin_average_windowÚmax_average_windowÚtyper	   r   Údefault_main_programÚglobal_blockÚall_parametersÚ_create_accumulatorsÚ_append_optimize_opr   Úapply_programÚprogram_guardÚ_add_average_apply_opÚrestore_programÚ_add_average_restore_op)ÚselfÚaverage_window_rater   r   r   r   r   r    ÚparamÚblockr   s             €úoG:\00. PROJECTS\API\Inventory\templateJSON\kerjaOCR\Lib\site-packages\paddle/incubate/optimizer/modelaverage.pyr   zModelAverage.__init__©   s�  ø€ ô 	‰ÑØØ!ØØØð 	ô 	
ô " $§.¡.×"9Ñ"9Ó:ˆŒØ1ˆÔØ"4ˆÔØ"4ˆÔØ)ˆŒ	äÕ Ü$×9Ñ9Ó;×HÑHÓJˆLá(‘
¨l×.IÑ.IÓ.Kð ð ×%Ñ% l°NÔCÛ'�Ø×(Ñ(¨¸¸t°}ÕEð (ä!(£ˆDÔØ×&Ñ&×3Ñ3Ó5ˆEÜ×(Ñ(°d×6HÑ6HÖIÛ+�EØ×.Ñ.¨u°eÕ<ñ ,÷ Jô $+£9ˆDÔ Ø×(Ñ(×5Ñ5Ó7ˆEÜ×(Ñ(°d×6JÑ6JÖKÛ+�EØ×0Ñ0°¸Õ>ñ ,÷ LÐKð! !÷ JÐIú÷
 LÐKús   ÄFÅ9F*ÆF'Æ*F3c                 ó^  — t        |t        j                  «      sJ ‚|D ]Œ  }| j                  d|«       | j                  d|«       | j                  d|«       | j                  d|«       | j                  d|ddg¬«       | j                  d	|ddg¬«       | j                  d
|ddg¬«       ŒŽ y )NÚsum_1Úsum_2Úsum_3ÚrestoreÚnum_accumulatesÚint64é   )ÚdtypeÚshapeÚold_num_accumulatesÚnum_updates)Ú
isinstancer   ÚBlockÚ_add_accumulator)r(   r+   r   r*   s       r,   r!   z!ModelAverage._create_accumulatorsÓ   s¾   € Ü˜%¤§¡Ô1Ð1Ð1ãˆEØ×!Ñ! '¨5Ô1Ø×!Ñ! '¨5Ô1Ø×!Ñ! '¨5Ô1Ø×!Ñ! )¨UÔ3Ø×!Ñ!Ø! 5°À¸sð "ô ð ×!Ñ!Ø% u°GÀAÀ3ð "ô ð ×!Ñ!Ø˜u¨G¸A¸3ð "õ ñ  ó    c                 óÔ  — t        |t        j                  «      sJ ‚| j                  d|d   «      }| j                  d|d   «      }| j                  d|d   «      }| j                  d|d   «      }| j                  d|d   «      }| j                  d|d   «      }t	        «       rGt        j                  |d   ||||||| j                  | j                  | j                  «
      \  }	}	}	}	}	}	y t        j                  «       j                  «       }| j                  | j                  | j                  dœ}
|d   ||||||d	œ}||||||d
œ}|j                  | j                  |||
d¬«      }|S )Nr.   r   r/   r0   r2   r7   r8   )r   r   r   )r*   Úin_sum_1Úin_sum_2Úin_sum_3Úin_num_accumulatesÚin_old_num_accumulatesÚin_num_updates)Ú	out_sum_1Ú	out_sum_2Ú	out_sum_3Úout_num_accumulatesÚout_old_num_accumulatesÚout_num_updatesT)r   ÚinputsÚoutputsÚattrsÚstop_gradient)r9   r   r:   Ú_get_accumulatorr	   r   Úaverage_accumulates_r   r   r   r   r   Ú	append_opr   )r(   r+   Úparam_and_gradr.   r/   r0   r2   r7   r8   Ú_rL   rJ   rK   Úaverage_accumulates_ops                 r,   r"   z ModelAverage._append_optimize_opå   s°  € Ü˜%¤§¡Ô1Ð1Ð1à×%Ñ% g¨~¸aÑ/@ÓAˆØ×%Ñ% g¨~¸aÑ/@ÓAˆØ×%Ñ% g¨~¸aÑ/@ÓAˆØ×/Ñ/Ø˜~¨aÑ0ó
ˆð #×3Ñ3Ø! >°!Ñ#4ó
Ðð ×+Ñ+¨M¸>È!Ñ;LÓMˆäÔÜ%×:Ñ:Ø˜qÑ!ØØØØØ#ØØ×#Ñ#Ø×'Ñ'Ø×'Ñ'ó ÑˆAˆq�!�Q˜˜1ð ä×.Ñ.Ó0×=Ñ=Ó?ˆà"×1Ñ1Ø"&×"9Ñ"9Ø"&×"9Ñ"9ñ
ˆð $ AÑ&ØØØØ"1Ø&9Ø)ñ
ˆð ØØØ#2Ø':Ø*ñ
ˆð "'§¡Ø—‘ØØØØð "1ó "
Ðð &Ð%r<   c                 ó:   — t        «       r| j                  «        yy)aŽ  
        Add operations to minimize ``loss`` by updating ``parameters``.

        Args:
            loss (Tensor): A ``Tensor`` containing the value to minimize.
            startup_program (Program, optional): :ref:`api_paddle_static_Program` for
                initializing parameters in ``parameters``. The default value
                is None, at this time :ref:`api_paddle_static_default_startup_program` will be used.
            parameters (list, optional): List of ``Tensor`` or ``Tensor.name`` to update
                to minimize ``loss``. The default value is None, at this time all parameters
                will be updated.
            no_grad_set (set, optional): Set of ``Tensor``  or ``Tensor.name`` that don't need
                to be updated. The default value is None.

        Returns:
            tuple: tuple (optimize_ops, params_grads), A list of operators appended
            by minimize and a list of (param, grad) tensor pairs, param is
            ``Parameter``, grad is the gradient value corresponding to the parameter.
            In static graph mode, the returned tuple can be passed to ``fetch_list`` in ``Executor.run()`` to
            indicate program pruning. If so, the program will be pruned by ``feed`` and
            ``fetch_list`` before run, see details in ``Executor``.

        Examples:

            .. code-block:: python

                >>> import paddle
                >>> inp = paddle.rand([1, 10], dtype="float32")
                >>> linear = paddle.nn.Linear(10, 1)
                >>> out = linear(inp)
                >>> loss = paddle.mean(out)
                >>> loss.backward()

                >>> sgd = paddle.optimizer.SGD(learning_rate=0.1,parameters=linear.parameters())
                >>> sgd.minimize(loss)

                >>> modelaverage = paddle.incubate.ModelAverage(
                ...     0.15,
                ...     parameters=linear.parameters(),
                ...     min_average_window=2,
                ...     max_average_window=4
                ... )
                >>> modelaverage.minimize(loss)
                >>> sgd.clear_grad()
                >>> modelaverage.clear_grad()

        N)r	   Ústep)r(   ÚlossÚstartup_programr   Úno_grad_sets        r,   ÚminimizezModelAverage.minimize&  s   € ôf ÔØ�I‰I�Kð r<   c                 óZ  — g }| j                   D ]C  }|j                  sŒ|j                  «       €Œ!|j                  «       }|j                  ||f«       ŒE t	        j
                  «       j                  «       }| j                  || j                   «       |D ]  }| j                  ||«       Œ y)a®  
        Execute the optimizer and update parameters once.

        Returns:
            None

        Examples:

            .. code-block:: python

                >>> import paddle
                >>> inp = paddle.rand([1, 10], dtype="float32")
                >>> linear = paddle.nn.Linear(10, 1)
                >>> out = linear(inp)
                >>> loss = paddle.mean(out)
                >>> sgd = paddle.optimizer.SGD(learning_rate=0.1,parameters=linear.parameters())
                >>> modelaverage = paddle.incubate.ModelAverage(
                ...     0.15,
                ...     parameters=linear.parameters(),
                ...     min_average_window=2,
                ...     max_average_window=4
                ... )
                >>> loss.backward()
                >>> sgd.step()
                >>> modelaverage.step()
                >>> sgd.clear_grad()
                >>> modelaverage.clear_grad()
        N)	Ú_parameter_listÚ	trainableÚ
_grad_ivarÚappendr   r   r   r!   r"   )r(   Úparams_gradsr*   Úgrad_varr+   rQ   s         r,   rU   zModelAverage.step\  s�   € ð@ ˆØ×)Ô)ˆEØ—?’?ØØ×ÑÓ!Ñ-Ø ×+Ñ+Ó-�Ø×#Ñ# U¨HÐ$5Õ6ð *ô ×.Ñ.Ó0×=Ñ=Ó?ˆØ×!Ñ! %¨×)=Ñ)=Ô>Û*ˆNØ×$Ñ$ U¨NÕ;ñ +r<   c              #   ó  K  — t        «       �r| j                  D ]Ú  }| j                  d|«      }| j                  d|«      }| j                  d|«      }| j                  d|«      }| j                  d|«      }| j                  d|«      }	t        j                  ||	«       ||z   |z   }
||z   }t        j
                  |
d¬«      }
t        j
                  |d¬«      }|
|z  }t        j                  ||«       ŒÜ 	 d	–— |r| j                  «        y	|€t        d
«      ‚|j                  | j                  «       	 d	–— |r| j                  |«       y	y	# |r| j                  «        w w xY w# |r| j                  |«       w w xY w­w)aÏ  
        Apply the average of the cumulative ``Parameter`` to the parameters of the current model.

        Args:
            executor(Executor): The network executor in static-graph mode. The default value is None in dygraph mode.
            need_restore(bool): Restore flag variable, if set to True, the network will restore
                the parameters of the network to the default value, if set to False,
                it will not be restored. The default value is True.

        Examples:

            .. code-block:: python

                >>> import paddle
                >>> inp = paddle.rand([1, 10], dtype="float32")
                >>> linear = paddle.nn.Linear(10, 1)
                >>> out = linear(inp)
                >>> loss = paddle.mean(out)
                >>> loss.backward()

                >>> sgd = paddle.optimizer.SGD(learning_rate=0.1,parameters=linear.parameters())

                >>> modelaverage = paddle.incubate.ModelAverage(
                ...     0.15,
                ...     parameters=linear.parameters(),
                ...     min_average_window=2,
                ...     max_average_window=4
                ... )
                >>> sgd.step()
                >>> modelaverage.step()

                >>> with modelaverage.apply():
                ...     for param in linear.parameters():
                ...         print(param)

                >>> for param in linear.parameters():
                ...     print(param)
        r2   r7   r.   r/   r0   r1   Úfloat32)r5   Nú1Executor should not be None in static graph mode.)
r	   r[   rN   ÚpaddleÚassignÚcastr1   ÚRuntimeErrorÚrunr#   )r(   ÚexecutorÚneed_restorer*   r2   r7   r.   r/   r0   Úparam_restoreÚtotal_paramÚtotal_accumulatesÚaverage_params                r,   ÚapplyzModelAverage.apply‰  s…  è ø€ ôR ÕØ×-Ô-�Ø"&×"7Ñ"7Ø% uó#�ð '+×&;Ñ&;Ø)¨5ó'Ð#ð ×-Ñ-¨g°uÓ=�Ø×-Ñ-¨g°uÓ=�Ø×-Ñ-¨g°uÓ=�Ø $× 5Ñ 5°iÀÓ G�ä—‘˜e ]Ô3Ø# e™m¨eÑ3�Ø$3Ð6IÑ$IÐ!Ü$Ÿk™k¨+¸YÔG�Ü$*§K¡KØ%¨Yô%Ð!ð !,Ð.?Ñ ?�Ü—‘˜m¨UÕ3ð) .ð*#ÛáØ—L‘L”NØØÐÜØCóð ð 	�‰�T×'Ñ'Ô(ð	'ÛáØ—‘˜XÕ&ð øñ  Ø—L‘L•Nð  ûñ Ø—‘˜XÕ&ð üs6   ‚C5FÃ8E Ã<;FÄ8E) Ä<FÅE&Å&FÅ)E?Å?Fc                 óÜ   — t        «       r:| j                  D ]*  }| j                  d|«      }t        j                  ||«       Œ, y|€t        d«      ‚|j                  | j                  «       y)aD  
        Restore ``Parameter`` values of current model.

        Args:
            executor(Executor): The network executor in static-graph mode. The default value is None in dygraph mode

        Examples:

            .. code-block:: python

                >>> import paddle
                >>> inp = paddle.rand([1, 10], dtype="float32")
                >>> linear = paddle.nn.Linear(10, 1)
                >>> out = linear(inp)
                >>> loss = paddle.mean(out)
                >>> loss.backward()

                >>> sgd = paddle.optimizer.SGD(learning_rate=0.1,parameters=linear.parameters())

                >>> modelaverage = paddle.incubate.ModelAverage(
                ...     0.15,
                ...     parameters=linear.parameters(),
                ...     min_average_window=2,
                ...     max_average_window=4
                ... )
                >>> sgd.step()
                >>> modelaverage.step()

                >>> with modelaverage.apply(need_restore=False):
                ...     for param in linear.parameters():
                ...         print(param)

                >>> for param in linear.parameters():
                ...     print(param)

                >>> modelaverage.restore()

                >>> for param in linear.parameters():
                ...     print(param)
        r1   Nrc   )r	   r[   rN   rd   re   rg   rh   r&   )r(   ri   r*   rk   s       r,   r1   zModelAverage.restoreÙ  sj   € ôT ÔØ×-Ô-�Ø $× 5Ñ 5°iÀÓ G�Ü—‘˜m¨UÕ3ð .ð ØÐÜØCóð ð 	�‰�T×)Ñ)Õ*r<   c                 óR  — |j                  |«      }|j                  | j                  d|«      «      }|j                  | j                  d|«      «      }|j                  | j                  d|«      «      }|j                  | j                  d|«      «      }|j                  | j                  d|«      «      }|j                  | j                  d|«      «      }t        j                  ||¬«       t        j                  ||g«      }	t        j                  |||g«      }
t        j
                  |	| j                  €dn| j                  ¬	«      }	t        j
                  |
| j                  €dn| j                  ¬	«      }
t        j                  j                  j                  |
|	|¬
«       y )Nr1   r.   r/   r0   r2   r7   ©Úoutputrb   )Úxr5   )rt   ÚyÚout)
Ú_clone_variablerN   rd   re   Úadd_nrf   Ú_dtypeÚtensorÚopsÚ_elementwise_div)r(   r+   r*   Úgradr.   r/   r0   r2   r7   ÚtmpÚsums              r,   r%   z"ModelAverage._add_average_apply_op  sk  € Ø×%Ñ% eÓ,ˆØ×$Ñ$ T×%:Ñ%:¸9ÀeÓ%LÓMˆØ×%Ñ% d×&;Ñ&;¸GÀUÓ&KÓLˆØ×%Ñ% d×&;Ñ&;¸GÀUÓ&KÓLˆØ×%Ñ% d×&;Ñ&;¸GÀUÓ&KÓLˆØ×/Ñ/Ø×!Ñ!Ð"3°UÓ;ó
ˆð $×3Ñ3Ø×!Ñ!Ð"7¸Ó?ó
Ðô 	�‰�e DÕ)ä�l‰l˜OÐ-@ÐAÓBˆÜ�l‰l˜E 5¨%Ð0Ó1ˆÜ�k‰kØ d§k¡kÐ&9™¸t¿{¹{ô
ˆô �k‰kØ d§k¡kÐ&9™¸t¿{¹{ô
ˆô 	�‰×Ñ×*Ñ*¨S°C¸UÐ*ÕCr<   c                 ó–   — |j                  |«      }|j                  | j                  d|«      «      }t        j                  ||¬«       y )Nr1   rr   )rw   rN   rd   re   )r(   r+   r*   r}   s       r,   r'   z$ModelAverage._add_average_restore_op'  s=   € Ø×%Ñ% eÓ,ˆØ×$Ñ$ T×%:Ñ%:¸9ÀeÓ%LÓMˆÜ�‰�d 5Ö)r<   )Né'  r�   N)NNN)NT)N)r   Ú
__module__Ú__qualname__Ú__doc__r   r!   r"   Úimperative_baseÚno_gradrY   r   Údygraph_onlyrU   r   ro   r1   r%   r'   Ú__classcell__)r   s   @r,   r   r      s»   ø„ ñJð^ Ø Ø Øõ(?òTò$?&ðB ×ÑàGKò3ó ð3ðj ×ÑØ×Ññ)<ó ó ð)<ðV #Ø×ÑòL'ó ó #ðL'ð\ ×Ñò2+ó ð2+òhDö2*r<   r   )rd   r   Úpaddle.baser   Úpaddle.base.dygraphr   r…   Úpaddle.base.frameworkr   Úpaddle.base.layer_helperr   Úpaddle.base.wrapped_decoratorr   Úpaddle.frameworkr	   Úpaddle.optimizerr
   Ú__all__r   © r<   r,   Ú<module>r’      s5   ðó Ý Ý !Ý 7Ý )Ý 0Ý GÝ ,Ý &à
€ôN*�9õ N*r<   