Update docs for `seed_everything` in LightningCLI (#15308)

Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>
This commit is contained in:
fabio fumarola 2022-11-08 14:29:30 +01:00 committed by GitHub
parent 1cd66b6d7c
commit 5cd8001240
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions

View File

@ -294,9 +294,9 @@ class LightningCLI:
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 <lightning-cli>`.
seed_everything_default: Value for the :func:`~lightning_lite.utilities.seed.seed_everything`
seed argument. Set to True to automatically choose a valid seed.
Setting it to False will not call seed_everything.
seed_everything_default: Number for the :func:`~lightning_lite.utilities.seed.seed_everything`
seed value. Set to True to automatically choose a seed value.
Setting it to False will avoid calling ``seed_everything``.
description: Description of the tool shown when running ``--help``.
env_prefix: Prefix for environment variables.
env_parse: Whether environment variable parsing is enabled.