class_docstr: Logger for comet.
  
  Adds interface for `add_image` in the logger rather than calling the experiment object.
  Note:
      Same as the CometLogger provided by PyTorch Lightning and the doc string is reproduced below.
  
  Track your parameters, metrics, source code and more using
  `Comet <https://www.comet.com/site/products/ml-experiment-tracking/?utm_source=anomalib&utm_medium=referral>`_.
  
  Install it with pip:
  
  .. code-block:: bash
  
      pip install comet-ml
  
  Comet requires either an API Key (online mode) or a local directory path (offline mode).
  
  Args:
      api_key: Required in online mode. API key, found on Comet.ml. If not given, this
          will be loaded from the environment variable COMET_API_KEY or ~/.comet.config
          if either exists.
      save_dir: Required in offline mode. The path for the directory to save local
          comet logs. If given, this also sets the directory for saving checkpoints.
      project_name: Optional. Send your experiment to a specific project.
          Otherwise will be sent to Uncategorized Experiments.
          If the project name does not already exist, Comet.ml will create a new project.
      rest_api_key: Optional. Rest API key found in Comet.ml settings.
          This is used to determine version number
      experiment_name: Optional. String representing the name for this particular experiment on Comet.ml.
      experiment_key: Optional. If set, restores from existing experiment.
      offline: If api_key and save_dir are both given, this determines whether
          the experiment will be in online or offline mode. This is useful if you use
          save_dir to control the checkpoints directory and have a ~/.comet.config
          file but still want to run offline experiments.
      prefix: A string to put at the beginning of metric keys.
      kwargs: Additional arguments like `workspace`, `log_code`, etc. used by
          :class:`CometExperiment` can be passed as keyword arguments in this logger.
  
  Raises:
      ModuleNotFoundError:
          If required Comet package is not installed on the device.
      MisconfigurationException:
          If neither ``api_key`` nor ``save_dir`` are passed as arguments.
  Example:
      >>> from anomalib.utils.loggers import AnomalibCometLogger
      >>> from pytorch_lightning import Trainer
      >>> comet_logger = AnomalibCometLogger()
      >>> trainer = Trainer(logger=comet_logger)
  
  See Also:
      - `Comet Documentation <https://www.comet.com/docs/v2/integrations/ml-frameworks/pytorch-lightning/>`__
docstr: Interface to add image to comet logger.
  
  Args:
      image (np.ndarray | Figure): Image to log
      name (str | None): The tag of the image
      kwargs: Accepts only `global_step` (int). The step at which to log the image.
docstr_tok: ["Interface","to","add","image","to","comet","logger",".","Args",":","image","(","np.ndarray","|","Figure",")",":","Image","to","log","name","(","str","|","None",")",":","The","tag","of","the","image","kwargs",":","Accepts","only","`","global_step","`","(","int",")",".","The","step","at","which","to","log","the","image","."]
code: def add_image(
      self,
      image: np.ndarray | Figure,
      name: str | None = None,
      **kwargs: Any,
  ) -> None:
      """Interface to add image to comet logger.
  
      Args:
          image (np.ndarray | Figure): Image to log
          name (str | None): The tag of the image
          kwargs: Accepts only `global_step` (int). The step at which to log the image.
      """
      if "global_step" not in kwargs:
          raise ValueError("`global_step` is required for comet logger")
  
      global_step = kwargs["global_step"]
      # Need to call different functions of `Experiment` for  Figure vs np.ndarray
  
      if isinstance(image, Figure):
          self.experiment.log_figure(
              figure_name=name, figure=image, step=global_step
          )
      else:
          self.experiment.log_image(
              name=name, image_data=image, step=global_step
          )
  
file_path: anomalib/src/anomalib/utils/loggers/comet.py
imports: from __future__ import annotations
  from typing import Any
  import numpy
  from matplotlib.figure import Figure
  from pytorch_lightning.utilities import rank_zero_only
  from .base import ImageLoggerBase
label_desc: Use image node_id 2 for calling the AnomalibCometLogger obj's underlying member method code with example usage: obj.add_image(image, name) without return types