dubfi.core.profile_util
=======================

.. py:module:: dubfi.core.profile_util

.. autoapi-nested-parse::

   Profiling and performance monitoring utilities.

   .. codeauthor:: Valentin Bruch, DWD <valentin.bruch@dwd.de>
   .. versionadded:: 0.1.0 (initial release)



Functions
---------

.. autoapisummary::

   dubfi.core.profile_util.timer
   dubfi.core.profile_util.profile_fnc
   dubfi.core.profile_util.monitor_memory
   dubfi.core.profile_util._monitor_memory_thread


Module Contents
---------------

.. py:function:: timer(f, log=log)

   Log duration of wall clock time of function call.


.. py:function:: profile_fnc(fnc, target=None)

   Profile function and save result to file (decorator).


.. py:function:: monitor_memory(interval: float = 10, log_fn=log.info, count: int = -1) -> int

   Create daemon thread that logs memory usage.

   :param interval: logging interval in seconds
   :type interval: float
   :param log_fn: output function, can be print or log.info or similar. This
                  function should take one string as argument.
   :type log_fn: callable
   :param count: stop after this number of log message
   :type count: int, optional


.. py:function:: _monitor_memory_thread(interval: float, log_fn: Callable, count: int) -> None

   Log memory usage to log_fn in infinite loop.