Shortcuts

cli

Functions

instantiate_class

rtype

Any

Classes

LightningArgumentParser

Initialize argument parser that supports configuration file input.

LightningCLI

Receives as input pytorch-lightning classes (or callables which return pytorch-lightning classes), which are called / instantiated using a parsed configuration file and / or command line args.

SaveConfigCallback

Deprecated utilities for LightningCLI.

class pytorch_lightning.utilities.cli.LightningArgumentParser(*args, **kwargs)[source]

Bases: pytorch_lightning.cli.LightningArgumentParser

Initialize argument parser that supports configuration file input.

For full details of accepted arguments see ArgumentParser.__init__.

class pytorch_lightning.utilities.cli.LightningCLI(*args, **kwargs)[source]

Bases: pytorch_lightning.cli.LightningCLI

Receives as input pytorch-lightning classes (or callables which return pytorch-lightning classes), which are called / instantiated using a parsed configuration file and / or command line args.

Parsing of configuration from environment variables can be enabled by setting env_parse=True. A full configuration yaml would be parsed from PL_CONFIG if set. Individual settings are so parsed from variables named for example PL_TRAINER__MAX_EPOCHS.

For more info, read the CLI docs.

Warning

LightningCLI is in beta and subject to change.

Parameters
  • model_class – An optional LightningModule class to train on or a callable which returns a LightningModule instance when called. If None, you can pass a registered model with --model=MyModel.

  • datamodule_class – An optional LightningDataModule class or a callable which returns a LightningDataModule instance when called. If None, you can pass a registered datamodule with --data=MyDataModule.

  • save_config_callback – A callback class to save the training config.

  • save_config_filename – Filename for the config file.

  • save_config_overwrite – Whether to overwrite an existing config file.

  • save_config_multifile – When input is multiple config files, saved config preserves this structure.

  • trainer_class – An optional subclass of the Trainer class or a callable which returns a Trainer instance when called.

  • 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 the CLI docs.

  • seed_everything_default – Value for the seed_everything() seed argument. Set to True to automatically choose a valid seed. Setting it to False will not call 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.

  • parser_kwargs – Additional arguments to instantiate each LightningArgumentParser.

  • subclass_mode_model – Whether model can be any subclass of the given class.

  • subclass_mode_data

    Whether datamodule can be any subclass of the given class.

  • run – Whether subcommands should be added to run a Trainer method. If set to False, the trainer and model classes will be instantiated only.

  • auto_registry – Whether to automatically fill up the registries with all defined subclasses.

class pytorch_lightning.utilities.cli.SaveConfigCallback(*args, **kwargs)[source]

Bases: pytorch_lightning.cli.SaveConfigCallback

Read the Docs v: stable
Versions
latest
stable
1.7.7
1.7.6
1.7.5
1.7.4
1.7.3
1.7.2
1.7.1
1.7.0
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.5.10
1.5.9
1.5.8
1.5.7
1.5.6
1.5.5
1.5.4
1.5.3
1.5.2
1.5.1
1.5.0
1.4.9
1.4.8
1.4.7
1.4.6
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.8
1.3.7
1.3.6
1.3.5
1.3.4
1.3.3
1.3.2
1.3.1
1.3.0
1.2.10
1.2.8
1.2.7
1.2.6
1.2.5
1.2.4
1.2.3
1.2.2
1.2.1
1.2.0
1.1.8
1.1.7
1.1.6
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.0.8
1.0.7
1.0.6
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
0.10.0
0.9.0
0.8.5
0.8.4
0.8.3
0.8.2
0.8.1
0.8.0
0.7.6
0.7.5
0.7.4
0.7.3
0.7.2
0.7.1
0.7.0
0.6.0
0.5.3
0.4.9
future-structure
Downloads
html
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.