Skip to content

Update LightningCLI(trainer_defaults=...) doc #11309

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 5, 2022
Merged

Update LightningCLI(trainer_defaults=...) doc #11309

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5ffec1d
Update `LightningCLI(trainer_defaults=...)` doc
carmocca Jan 4, 2022
531b0c1
Update pytorch_lightning/utilities/cli.py
tchaton Jan 4, 2022
3e9a3b7
Line break
carmocca Jan 4, 2022
641ba7a
Fix
carmocca Jan 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion pytorch_lightning/utilities/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -483,7 +483,9 @@ def __init__(
save_config_multifile: When input is multiple config files, saved config preserves this structure.
trainer_class: An optional subclass of the :class:`~pytorch_lightning.trainer.trainer.Trainer` class or a
callable which returns a :class:`~pytorch_lightning.trainer.trainer.Trainer` instance when called.
trainer_defaults: Set to override Trainer defaults or add persistent callbacks.
trainer_defaults: Set to override Trainer defaults or add persistent callbacks. The callbacks added through
this argument will not be configurable from a configuration file and will always be present for
this particular CLI. Alternatively, configurable callbacks can be added as explained in :ref:`the CLI docs <common/lightning_cli:configurable-callbacks>`.
seed_everything_default: Default value for the :func:`~pytorch_lightning.utilities.seed.seed_everything`
seed argument.
description: Description of the tool shown when running ``--help``.
Expand Down