add support of old style "experiment_name" argument

Author: japdubengsub

src/lightning/pytorch/loggers/comet.py

@@ -67,7 +67,7 @@ class CometLogger(Logger):
             workspace="COMET_WORKSPACE",  # Optional
             project="default_project",  # Optional
             experiment_key="COMET_EXPERIMENT_KEY",  # Optional
-            experiment_name="lightning_logs",  # Optional
+            name="lightning_logs",  # Optional
         )
         trainer = Trainer(logger=comet_logger)
 
@@ -81,7 +81,7 @@ class CometLogger(Logger):
         comet_logger = CometLogger(
             workspace="COMET_WORKSPACE",  # Optional
             project="default_project",  # Optional
-            experiment_name="lightning_logs",  # Optional
+            name="lightning_logs",  # Optional
             online=False
         )
         trainer = Trainer(logger=comet_logger)
@@ -186,7 +186,7 @@ def __init__(self, *args, **kwarg):
             locally in an offline experiment. Default is ``True``.
         prefix (str, optional): The prefix to add to names of the logged metrics.
             example: prefix=`exp1`, then metric name will be `exp1_metric_name`
-        **kwargs: Additional arguments like `experiment_name`, `log_code`, `offline_directory` etc. used by
+        **kwargs: Additional arguments like `name`, `log_code`, `offline_directory` etc. used by
             :class:`CometExperiment` can be passed as keyword arguments in this logger.
 
     Raises:
@@ -215,7 +215,20 @@ def __init__(
         ##################################################
         # HANDLE PASSED OLD TYPE PARAMS
 
-        # handle old "project name" param
+        # handle old "experiment_name" param
+        if "experiment_name" in kwargs:
+            log.warning("The parameter `experiment_name` is deprecated, please use `name` instead.")
+            experiment_name = kwargs.pop("experiment_name")
+
+            if "name" not in kwargs:
+                kwargs["name"] = experiment_name
+            else:
+                log.warning(
+                    "You specified both `experiment_name` and `name` parameters, "
+                    "please use `name` only"
+                )
+
+        # handle old "project_name" param
         if "project_name" in kwargs:
             log.warning("The parameter `project_name` is deprecated, please use `project` instead.")
             if project is None:

tests/tests_pytorch/loggers/test_comet.py

@@ -100,6 +100,7 @@ def test_comet_logger_experiment_name(comet_mock):
 
     comet_start = comet_mock.start
 
+    # here we use old style arg "experiment_name" (new one is "name")
     logger = CometLogger(api_key=api_key, experiment_name=experiment_name)
     comet_start.assert_called_once_with(
         api_key=api_key,
@@ -110,11 +111,13 @@ def test_comet_logger_experiment_name(comet_mock):
         online=None,
         experiment_config=comet_mock.ExperimentConfig(),
     )
-    # check that we saved "experiment name" in kwargs
-    assert logger._kwargs["experiment_name"] == experiment_name
+    # check that we saved "experiment name" in kwargs as new "name" arg
+    assert logger._kwargs["name"] == experiment_name
+    assert "experiment_name" not in logger._kwargs
 
-    # check that "experiment name" was passed to experiment config
-    assert call(experiment_name=experiment_name) in comet_mock.ExperimentConfig.call_args_list
+    # check that "experiment name" was passed to experiment config correctly
+    assert call(experiment_name=experiment_name) not in comet_mock.ExperimentConfig.call_args_list
+    assert call(name=experiment_name) in comet_mock.ExperimentConfig.call_args_list
 
 
 @mock.patch.dict(os.environ, {})
@@ -123,7 +126,7 @@ def test_comet_version(comet_mock):
     api_key = "key"
     experiment_name = "My Name"
 
-    logger = CometLogger(api_key=api_key, experiment_name=experiment_name)
+    logger = CometLogger(api_key=api_key, name=experiment_name)
     assert logger._experiment is not None
     _ = logger.version