fix typo

Lightning-AI · Sep 12, 2023 · 78af0e6 · 78af0e6
1 parent e958c6f
commit 78af0e6
Showing 1 changed file with 3 additions and 4 deletions.
diff --git a/src/lightning/pytorch/trainer/connectors/logger_connector/result.py b/src/lightning/pytorch/trainer/connectors/logger_connector/result.py
@@ -300,13 +300,12 @@ class _ResultCollection(dict):
     """Collection (dictionary) of
     :class:`~lightning.pytorch.trainer.connectors.logger_connector.result._ResultMetric`
 
-    Example:
-
-        # `device` needs to be provided before logging
-        result = _ResultCollection(training=True, torch.device("cpu"))
+    Example::
 
         # you can log to a specific collection.
         # arguments: fx, key, value, metadata
+
+        result = _ResultCollection(training=True)
         result.log('training_step', 'acc', torch.tensor(...), on_step=True, on_epoch=True)
         result.log('validation_step', 'recall', torch.tensor(...), on_step=True, on_epoch=True)
     """