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 <ewah1g13@soton.ac.uk>
Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
This commit is contained in:
SpontaneousDuck 2021-05-03 20:21:28 -04:00 committed by GitHub
parent 6da747e775
commit f135debb6a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 2 deletions

View File

@ -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::

View File

@ -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