pastas.solver.timer.StatTimer
=============================

.. toctree::
   :hidden:

   /api/pastas/solver/timer/StatTimer.timer

.. py:class:: pastas.solver.timer.StatTimer(ml: pastas.typing.Model, *args: Any, statistic: Literal['rmse', 'sse', 'mae', 'rsq', 'evp', 'nse', 'nnse', 'aic', 'aicc', 'bic'] = 'rmse', update_interval: int | None = None, **kwargs: Any)



   
   StatTimer that updates a user-specified solve statistic every N iterations.

   :param ml: The model being solved, used to compute residuals.
   :type ml: pastas.Model
   :param statistic: The statistic to compute and display, by default "rmse". Must be a valid
                     statistic in pastas.stats.metrics that accepts ``res=`` as an argument.
   :type statistic: str, optional
   :param update_interval: Number of iterations between RMSE updates. If None (default), the
                           RMSE is updated when iteration % number of varying parameters == 0.
   :type update_interval: int, optional















   ..
       !! processed by numpydoc !!
Methods
-------

.. autoapisummary::

   pastas.solver.timer.StatTimer.timer