Skip to content

Commit c0726ba

Browse files
carmoccamauvilsa
andauthored
Update LightningCLI(trainer_defaults=...) doc (#11309)
Co-authored-by: Mauricio Villegas <[email protected]>
1 parent dcffca7 commit c0726ba

File tree

1 file changed

+4
-1
lines changed
  • pytorch_lightning/utilities

1 file changed

+4
-1
lines changed

pytorch_lightning/utilities/cli.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -483,7 +483,10 @@ def __init__(
483483
save_config_multifile: When input is multiple config files, saved config preserves this structure.
484484
trainer_class: An optional subclass of the :class:`~pytorch_lightning.trainer.trainer.Trainer` class or a
485485
callable which returns a :class:`~pytorch_lightning.trainer.trainer.Trainer` instance when called.
486-
trainer_defaults: Set to override Trainer defaults or add persistent callbacks.
486+
trainer_defaults: Set to override Trainer defaults or add persistent callbacks. The callbacks added through
487+
this argument will not be configurable from a configuration file and will always be present for
488+
this particular CLI. Alternatively, configurable callbacks can be added as explained in
489+
:ref:`the CLI docs <common/lightning_cli:Configurable callbacks>`.
487490
seed_everything_default: Default value for the :func:`~pytorch_lightning.utilities.seed.seed_everything`
488491
seed argument.
489492
description: Description of the tool shown when running ``--help``.

0 commit comments

Comments
 (0)