Rooba
/
lightning
mirror of https://github.com/Lightning-AI/lightning.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update docstring for early_stop_callback default Trainer argument (#3641)

This commit is contained in:
JackCaster 2020-09-24 22:15:01 +02:00 committed by GitHub
parent aa52c930f4
commit 618eb913da
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
pytorch_lightning/trainer/__init__.py
View File

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