Skip to content

lightning_utils

Module with utilities for PyTorch Lightning models

get_logger

source

.get_logger(
   name = __name__
)

Initializes multi-GPU-friendly python command line logger.

Args

  • name (str, optional) : Name of the logger. Defaults to name.

Returns

Initialized logger.

extras

source

.extras(
   config: DictConfig
)

Applies optional utilities, controlled by config flags.

Utilities: - Ignoring python warnings - Rich config printing

source

.print_config(
   config: DictConfig, print_order: Sequence[str] = ('datamodule', 'model',
   'callbacks', 'logger', 'trainer'), resolve: bool = True
)

Prints content of DictConfig using Rich library and its tree structure.

Args

  • config (DictConfig) : Configuration composed by Hydra.
  • print_order (Sequence[str], optional) : Determines in what order config components are printed.
  • resolve (bool, optional) : Whether to resolve reference fields of DictConfig.

log_hyperparameters

source

.log_hyperparameters(
   config: DictConfig, model: pl.LightningModule, trainer: pl.Trainer
)

Controls which config parts are saved by Lightning loggers.

Args

  • config (DictConfig) : Configuration composed by Hydra.
  • model (pl.LightningModule) : Lightning model.