From 618eb913da3cb4e1d2afc8b0870f7de182d70d5c Mon Sep 17 00:00:00 2001 From: JackCaster Date: Thu, 24 Sep 2020 22:15:01 +0200 Subject: [PATCH] Update docstring for early_stop_callback default Trainer argument (#3641) --- pytorch_lightning/trainer/__init__.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/pytorch_lightning/trainer/__init__.py b/pytorch_lightning/trainer/__init__.py index 059d667737..14752b6e58 100644 --- a/pytorch_lightning/trainer/__init__.py +++ b/pytorch_lightning/trainer/__init__.py @@ -417,8 +417,8 @@ early_stop_callback (:class:`pytorch_lightning.callbacks.EarlyStopping`) Will raise an error if a :class:`~pytorch_lightning.core.step_result.Result` is returned and ``early_stopping_on`` was not specified. - ``False``: Early stopping will be disabled. -- ``None``: Same as, if ``True`` is specified. -- Default: ``None``. +- ``None``: Equivalent to ``True``. +- Default: ``False``. .. testcode:: @@ -1094,4 +1094,5 @@ Trainer class API from pytorch_lightning.trainer.trainer import Trainer from pytorch_lightning.utilities.seed import seed_everything -__all__ = ['Trainer', 'seed_everything'] +__all__ = ["Trainer", "seed_everything"] +