lenskit.logging.progress
========================

.. py:module:: lenskit.logging.progress


Classes
-------

.. toctree::
   :hidden:

   /api/lenskit/logging/progress/Progress

.. autoapisummary::

   lenskit.logging.progress.Progress


Functions
---------

.. autoapisummary::

   lenskit.logging.progress.item_progress
   lenskit.logging.progress.set_progress_impl
   lenskit.logging.progress.item_progress_handle
   lenskit.logging.progress.pbh_update



Package Contents
----------------

.. py:function:: item_progress(label, total = None, fields = None)

   Create a progress bar for distinct, counted items.

   :param label: The progress bar label.
   :param total: The total number of items.
   :param fields: Additional fields to report with the progress bar (such as a current
                  loss).  These are specified as a dictionary mapping field names to
                  format strings (the pieces inside ``{...}`` in :meth:`str.format`),
                  and the values come from extra kwargs to :meth:`Progress.update`;
                  mapping to ``None`` use default ``str`` formatting.


.. py:function:: set_progress_impl(name: Literal['rich', 'notebook', 'none'] | None) -> None
                 set_progress_impl(backend: ProgressBackend, /) -> None

   Set the progress bar implementation.


.. py:function:: item_progress_handle(*args, **kwargs)

.. py:function:: pbh_update(h, incr = 1)