vak.common.tensorboard.get_summary_writer#

vak.common.tensorboard.get_summary_writer(log_dir: str | Path, filename_suffix: str) → SummaryWriter[source]#

Get an instance of tensorboard.SummaryWriter, to use with a vak.Model during training.

Parameters:

  • log_dir (str, pathlib.Path) – directory where event file will be written

  • filename_suffix (str) – suffix added to events file name

Returns:

summary_writer

Return type:

torch.utils.tensorboard.SummaryWriter

Examples

>>> summary_writer = vak.summary_writer.get_summary_writer(log_dir='./experiments')
>>> tweety_net_model.summary_writer = summary_writer  # set attribute equal to instance we just made
>>> tweety_net_model.train()  # now events during training will be logged with that summary writer