Shortcuts

setup_tb_logging#

ignite.handlers.logger_utils.setup_tb_logging(output_path, trainer, optimizers=None, evaluators=None, log_every_iters=100, **kwargs)[source]#

Method to setup TensorBoard logging on trainer and a list of evaluators. Logged metrics are:

  • Training metrics, e.g. running average loss values

  • Learning rate(s)

  • Evaluation metrics

Parameters:
  • output_path (str) – logging directory path

  • trainer (Engine) – trainer engine

  • optimizers (Optimizer | dict[str, torch.optim.optimizer.Optimizer] | None) – single or dictionary of torch optimizers. If a dictionary, keys are used as tags arguments for logging.

  • evaluators (Engine | dict[str, ignite.engine.engine.Engine] | None) – single or dictionary of evaluators. If a dictionary, keys are used as tags arguments for logging.

  • log_every_iters (int) – interval for loggers attached to iteration events. To log every iteration, value can be set to 1 or None.

  • kwargs (Any) – optional keyword args to be passed to construct the logger.

Returns:

TensorboardLogger

Return type:

TensorboardLogger

×

Search Docs