From f135debb6a4eff52491be5030bbe5045a7cc6265 Mon Sep 17 00:00:00 2001 From: SpontaneousDuck Date: Mon, 3 May 2021 20:21:28 -0400 Subject: [PATCH] Clarify logger flag (#7190) * Clarify logger flag Clarify behavior of boolean values on the logger flag for Trainer. * Update docs/source/common/trainer.rst * doc Co-authored-by: Ethan Harris Co-authored-by: Rohit Gupta --- docs/source/common/trainer.rst | 2 +- pytorch_lightning/trainer/trainer.py | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/source/common/trainer.rst b/docs/source/common/trainer.rst index 20aa1f5f28..138b14058d 100644 --- a/docs/source/common/trainer.rst +++ b/docs/source/common/trainer.rst @@ -870,7 +870,7 @@ logger | -:doc:`Logger <../common/loggers>` (or iterable collection of loggers) for experiment tracking. +:doc:`Logger <../common/loggers>` (or iterable collection of loggers) for experiment tracking. A ``True`` value uses the default ``TensorBoardLogger`` shown below. ``False`` will disable logging. .. testcode:: diff --git a/pytorch_lightning/trainer/trainer.py b/pytorch_lightning/trainer/trainer.py index 12fc1c3288..d4cfd548c0 100644 --- a/pytorch_lightning/trainer/trainer.py +++ b/pytorch_lightning/trainer/trainer.py @@ -212,7 +212,8 @@ class Trainer( limit_predict_batches: How much of prediction dataset to check (float = fraction, int = num_batches) - logger: Logger (or iterable collection of loggers) for experiment tracking. + logger: Logger (or iterable collection of loggers) for experiment tracking. A ``True`` value uses + the default ``TensorBoardLogger``. ``False`` will disable logging. log_gpu_memory: None, 'min_max', 'all'. Might slow performance