Formatting fixes

Author: akashkw

pytorch_lightning/loggers/base.py

@@ -146,13 +146,13 @@ def _finalize_agg_metrics(self):
 
     def agg_and_log_metrics(self, metrics: Dict[str, float], step: Optional[int] = None):
         """
+        Aggregates and records metrics. This method doesn't log the passed metrics instantaneously, but instead
+        it aggregates them and logs only if metrics are ready to be logged.
+
         .. deprecated:: v1.6
             This method is deprecated in v1.6 and will be removed in v1.8.
             Please use `LightningLoggerBase.log_metrics` instead.
 
-        Aggregates and records metrics. This method doesn't log the passed metrics instantaneously, but instead
-        it aggregates them and logs only if metrics are ready to be logged.
-
         Args:
             metrics: Dictionary with metric names as keys and measured quantities as values
             step: Step number at which the metrics should be recorded

pytorch_lightning/trainer/connectors/logger_connector/logger_connector.py

@@ -65,7 +65,9 @@ def on_trainer_init(
         self.trainer.flush_logs_every_n_steps = flush_logs_every_n_steps
         self.trainer.log_every_n_steps = log_every_n_steps
         self.trainer.move_metrics_to_cpu = move_metrics_to_cpu
-        if not isinstance(self.trainer.logger, LoggerCollection) and is_overridden("agg_and_log_metrics", self.trainer.logger, LightningLoggerBase):
+        if not isinstance(self.trainer.logger, LoggerCollection) and is_overridden(
+            "agg_and_log_metrics", self.trainer.logger, LightningLoggerBase
+        ):
             rank_zero_deprecation(
                 "`LightningLoggerBase.agg_and_log_metrics` is deprecated in v1.6 and will be"
                 " removed in v1.8. Please use `LightningLoggerBase.log_metrics` instead."
@@ -122,7 +124,9 @@ def log_metrics(self, metrics: _OUT_DICT, step: Optional[int] = None) -> None:
             step = self.trainer.global_step
 
         # log actual metrics
-        if not isinstance(self.trainer.logger, LoggerCollection) and is_overridden("agg_and_log_metrics", self.trainer.logger, LightningLoggerBase):
+        if not isinstance(self.trainer.logger, LoggerCollection) and is_overridden(
+            "agg_and_log_metrics", self.trainer.logger, LightningLoggerBase
+        ):
             self.trainer.logger.agg_and_log_metrics(metrics=scalar_metrics, step=step)
         else:
             self.trainer.logger.log_metrics(metrics=scalar_metrics, step=step)

tests/deprecated_api/test_remove_1-8.py

@@ -36,7 +36,7 @@
 from pytorch_lightning.utilities.apply_func import move_data_to_device
 from pytorch_lightning.utilities.enums import DeviceType, DistributedType
 from pytorch_lightning.utilities.imports import _TORCHTEXT_LEGACY
-from pytorch_lightning.utilities.rank_zero import rank_zero_warn, rank_zero_only
+from pytorch_lightning.utilities.rank_zero import rank_zero_only, rank_zero_warn
 from tests.helpers.boring_model import BoringDataModule, BoringModel
 from tests.helpers.runif import RunIf
 from tests.helpers.torchtext_utils import get_dummy_torchtext_data_iterator
@@ -502,6 +502,7 @@ def on_before_accelerator_backend_setup(self, *args, **kwargs):
     ):
         trainer.fit(model)
 
+
 def test_v1_8_0_deprecated_agg_and_log_metrics_override(tmpdir):
     class AggregationLogger(CSVLogger):
         def __init__(self, *args, **kwargs):
@@ -521,5 +522,6 @@ def __init__(self, *args, **kwargs):
         match="`LightningLoggerBase.agg_and_log_metrics` is deprecated in v1.6 and will be"
         " removed in v1.8. Please use `LightningLoggerBase.log_metrics` instead."
     ):
-        trainer = Trainer(logger=logger)
-    trainer2 = Trainer(logger=logger2)
+        Trainer(logger=logger)
+    # Should have no deprecation warning
+    Trainer(logger=logger2)