Comet Logging

pycaret/anomaly/functional.py

@@ -385,7 +385,7 @@ def setup(
 
 
     log_experiment: bool, default = False
-        A (list of) PyCaret ``BaseLogger`` or str (one of 'mlflow', 'wandb')
+        A (list of) PyCaret ``BaseLogger`` or str (one of 'mlflow', 'wandb', 'comet_ml')
         corresponding to a logger to determine which experiment loggers to use.
         Setting to True will use just MLFlow.
 

pycaret/classification/functional.py

@@ -532,7 +532,7 @@ def setup(
 
 
     log_experiment: bool or str or BaseLogger or list of str or BaseLogger, default = False
-        A (list of) PyCaret ``BaseLogger`` or str (one of 'mlflow', 'wandb')
+        A (list of) PyCaret ``BaseLogger`` or str (one of 'mlflow', 'wandb', 'comet_ml')
         corresponding to a logger to determine which experiment loggers to use.
         Setting to True will use just MLFlow.
 

pycaret/classification/oop.py

@@ -628,7 +628,7 @@ def setup(
 
 
         log_experiment: bool or str or BaseLogger or list of str or BaseLogger, default = False
-            A (list of) PyCaret ``BaseLogger`` or str (one of 'mlflow', 'wandb')
+            A (list of) PyCaret ``BaseLogger`` or str (one of 'mlflow', 'wandb', 'comet_ml)
             corresponding to a logger to determine which experiment loggers to use.
             Setting to True will use just MLFlow.
 

pycaret/clustering/functional.py

@@ -374,7 +374,7 @@ def setup(
 
 
     log_experiment: bool, default = False
-        A (list of) PyCaret ``BaseLogger`` or str (one of 'mlflow', 'wandb')
+        A (list of) PyCaret ``BaseLogger`` or str (one of 'mlflow', 'wandb', 'comet_ml')
         corresponding to a logger to determine which experiment loggers to use.
         Setting to True will use just MLFlow.
         If ``wandb`` (Weights & Biases) is installed, will also log there.

pycaret/internal/pycaret_experiment/tabular_experiment.py

@@ -36,6 +36,7 @@
 from pycaret.loggers.dagshub_logger import DagshubLogger
 from pycaret.loggers.mlflow_logger import MlflowLogger
 from pycaret.loggers.wandb_logger import WandbLogger
+from pycaret.loggers.comet_logger import CometLogger
 from pycaret.utils._dependencies import _check_soft_dependencies
 from pycaret.utils.generic import (
     MLUsecase,
@@ -228,7 +229,7 @@ def _profile(self, profile, profile_kwargs):
 
     def _validate_log_experiment(self, obj: Any) -> None:
         return isinstance(obj, (bool, BaseLogger)) or (
-            isinstance(obj, str) and obj.lower() in ["mlflow", "wandb", "dagshub"]
+            isinstance(obj, str) and obj.lower() in ["mlflow", "wandb", "dagshub", "comet_ml"]
         )
 
     def _convert_log_experiment(
@@ -242,7 +243,7 @@ def _convert_log_experiment(
             or self._validate_log_experiment(log_experiment)
         ):
             raise TypeError(
-                "log_experiment parameter must be a bool, BaseLogger, one of 'mlflow', 'wandb', 'dagshub'; or a list of the former."
+                "log_experiment parameter must be a bool, BaseLogger, one of 'mlflow', 'wandb', 'dagshub', 'comet_ml'; or a list of the former."
             )
 
         def convert_logging_param(obj):
@@ -255,6 +256,8 @@ def convert_logging_param(obj):
                 return WandbLogger()
             if obj == "dagshub":
                 return DagshubLogger(os.getenv("MLFLOW_TRACKING_URI"))
+            if obj == "comet_ml":
+                return CometLogger()
 
         if log_experiment:
             if log_experiment is True:

pycaret/internal/pycaret_experiment/unsupervised_experiment.py

@@ -455,10 +455,10 @@ def setup(
 
 
         log_experiment: bool, default = False
-            A (list of) PyCaret ``BaseLogger`` or str (one of 'mlflow', 'wandb')
+            A (list of) PyCaret ``BaseLogger`` or str (one of 'mlflow', 'wandb', 'comet_ml')
             corresponding to a logger to determine which experiment loggers to use.
             Setting to True will use just MLFlow.
-            If ``wandb`` (Weights & Biases) is installed, will also log there.
+            If ``wandb`` (Weights & Biases) or ``comet_ml``is installed, will also log there.
 
 
         experiment_name: str, default = None

pycaret/loggers/__init__.py

@@ -3,11 +3,13 @@
 from .dashboard_logger import DashboardLogger
 from .mlflow_logger import MlflowLogger
 from .wandb_logger import WandbLogger
+from .comet_logger import CometLogger
 
 __all__ = [
     "BaseLogger",
     "DashboardLogger",
     "MlflowLogger",
     "WandbLogger",
     "DagshubLogger",
+    "CometLogger"
 ]

pycaret/loggers/comet_logger.py

@@ -0,0 +1,69 @@
+from pycaret.loggers.base_logger import BaseLogger
+from pathlib import Path
+import uuid
+from copy import deepcopy
+import joblib
+
+try:
+    import comet_ml
+except ImportError:
+    comet_ml = None
+
+class CometLogger(BaseLogger):
+    def __init__(self) -> None:
+        if comet_ml is None:
+            raise ImportError(
+                "CometLogger requires Comet. Install using `pip install comet_ml`"
+            )
+        super().__init__()
+        self.run = None
+
+    def init_experiment(self, exp_name_log, full_name=None, **kwargs):
+        self.run = comet_ml.Experiment(project_name=exp_name_log, **kwargs)
+        self.run.set_name(full_name)
+        self.run.log_other('Created from', 'pycaret')
+        return self.run
+
+    def log_params(self, params, model_name=None):
+        self.run.log_parameters(params, prefix=model_name)
+
+    def set_tags(self, source, experiment_custom_tags, runtime):
+        tags = [source, runtime]
+        self.run.add_tags(tags)
+        self.run.log_others(experiment_custom_tags)
+
+    def log_sklearn_pipeline(self, experiment, prep_pipe, model, path=None):
+
+        pipeline = deepcopy(prep_pipe)
+        pipeline.steps.append(["trained_model", model])
+        joblib.dump(pipeline, 'pipeline.pkl')
+        self.run.log_model(name='model', file_or_folder='pipeline.pkl')
+
+    def log_model_comparison(self, model_result, source):
+        result_copy = deepcopy(model_result)
+        if "Object" in result_copy:
+            result_copy["Object"] = result_copy["Object"].apply(
+                lambda obj: str(type(obj).__name__)
+            )
+        self.run.log_metrics({source: result_copy})
+
+    def log_metrics(self, metrics, source=None):
+        self.run.log_metrics(metrics)
+
+    def log_plot(self, plot, title):
+        self.run.log_figure(figure=plot, figure_name=title)
+
+    def log_hpram_grid(self, html_file, title="hpram_grid"):
+        self.run.log_html(html_file)
+
+    def log_artifact(self, file, type="artifact"):
+        file_name, extension = None, ""
+        file_pathlib = Path(file)
+        file_name = file_pathlib.stem.replace(" ", "_") + str(uuid.uuid1())[:8]
+        artifact = comet_ml.Artifact(name=file_name, artifact_type=type)
+        artifact.add(file)
+        self.run.log_artifact(artifact)
+
+    def finish_experiment(self):
+        if self.run:
+            self.run.end()

pycaret/nlp/__init__.py

@@ -14,7 +14,7 @@
 from pycaret.loggers.base_logger import BaseLogger
 from pycaret.loggers.dagshub_logger import DagshubLogger
 from pycaret.loggers.mlflow_logger import MlflowLogger
-from pycaret.loggers.wandb_logger import WandbLogger
+from pycaret.loggers.comet_logger import CometLogger
 from pycaret.utils import __version__
 from pycaret.utils._dependencies import _check_soft_dependencies
 from pycaret.utils.generic import get_logger
@@ -82,7 +82,7 @@ def setup(
 
 
     log_experiment: bool, default = False
-        A (list of) PyCaret ``BaseLogger`` or str (one of 'mlflow', 'wandb')
+        A (list of) PyCaret ``BaseLogger`` or str (one of 'mlflow', 'wandb', 'comet_ml')
         corresponding to a logger to determine which experiment loggers to use.
         Setting to True will use just MLFlow.
 
@@ -450,6 +450,8 @@ def convert_logging_param(obj):
             return WandbLogger()
         if obj == "dagshub":
             return DagshubLogger(os.getenv("MLFLOW_TRACKING_URI"))
+        if obj == "comet_ml":
+            return CometLogger()
 
     if logging_param:
         loggers_list = []

pycaret/regression/functional.py

@@ -530,10 +530,10 @@ def setup(
 
 
     log_experiment: bool, default = False
-        A (list of) PyCaret ``BaseLogger`` or str (one of 'mlflow', 'wandb')
+        A (list of) PyCaret ``BaseLogger`` or str (one of 'mlflow', 'wandb', 'comet_ml')
         corresponding to a logger to determine which experiment loggers to use.
         Setting to True will use just MLFlow.
-        If ``wandb`` (Weights & Biases) is installed, will also log there.
+        If ``wandb`` (Weights & Biases) or ``comet_ml`` is installed, will also log there.
 
 
     system_log: bool or str or logging.Logger, default = True

pycaret/regression/oop.py

@@ -587,10 +587,10 @@ def setup(
 
 
         log_experiment: bool, default = False
-            A (list of) PyCaret ``BaseLogger`` or str (one of 'mlflow', 'wandb')
+            A (list of) PyCaret ``BaseLogger`` or str (one of 'mlflow', 'wandb', 'comet_ml')
             corresponding to a logger to determine which experiment loggers to use.
             Setting to True will use just MLFlow.
-            If ``wandb`` (Weights & Biases) is installed, will also log there.
+            If ``wandb`` (Weights & Biases) or ``comet_ml``  is installed, will also log there.
 
 
         system_log: bool or str or logging.Logger, default = True