mythos.ui.loggers.aim
=====================

.. py:module:: mythos.ui.loggers.aim

.. autoapi-nested-parse::

   Aim logging backend.



Classes
-------

.. autoapisummary::

   mythos.ui.loggers.aim.AimLogger


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

.. py:class:: AimLogger(aim_run: aim.Run = None, **kwargs)

   Bases: :py:obj:`mythos.ui.loggers.logger.Logger`


   Logger that emits metrics and status to Aim.


   .. py:method:: log_metric(name: str, value: float, step: int) -> None

      Log the `value` for `name` at `step`.

      :param name: the name of the metric
      :type name: str
      :param value: the value of the metric
      :type value: float
      :param step: the step at which the metric was recorded
      :type step: int



   .. py:method:: update_status(name: str, status: mythos.ui.loggers.logger.Status) -> None

      Updates the status of a simulator, objective, or observable.