neuro_morpho.logging.comet
==========================

.. py:module:: neuro_morpho.logging.comet

.. autoapi-nested-parse::

   Comet.ml logger for experiment tracking.



Classes
-------

.. autoapisummary::

   neuro_morpho.logging.comet.CometLogger


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

.. py:class:: CometLogger(api_key: str | None = None, experiment_key: str | None = None, project_name: str | None = None, workspace: str | None = None, auto_param_logging: bool = False, auto_metric_logging: bool = False, disabled: bool = False)

   Bases: :py:obj:`neuro_morpho.logging.base.Logger`


   Logger for Comet.ml.

   This logger sends experiment data to Comet.ml for tracking and visualization.


   .. py:attribute:: experiment


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

      Log a scalar value.

      :param name: The name of the scalar.
      :type name: str
      :param value: The value of the scalar.
      :type value: float
      :param step: The current step.
      :type step: int
      :param train: Whether this is a training or testing metric.
      :type train: bool



   .. py:method:: log_triplet(in_img: numpy.ndarray, lbl_img: numpy.ndarray, out_img: numpy.ndarray, name: str, step: int, train: bool) -> None

      Log an image triplet (input, label, output).

      :param in_img: The input image.
      :type in_img: np.ndarray
      :param lbl_img: The label image.
      :type lbl_img: np.ndarray
      :param out_img: The output image.
      :type out_img: np.ndarray
      :param name: The name of the triplet.
      :type name: str
      :param step: The current step.
      :type step: int
      :param train: Whether this is a training or testing metric.
      :type train: bool



   .. py:method:: log_parameters(metrics: dict[str, str | float | int]) -> None

      Log a dictionary of hyperparameters.

      :param metrics: The dictionary of hyperparameters.
      :type metrics: dict



   .. py:method:: log_code(folder: pathlib.Path | str) -> None

      Log the code in the given folder.

      :param folder: The folder containing the code to log.
      :type folder: str | Path