espnet3.utils.logging.log_run_metadata

source

espnet3.utils.logging.log_run_metadata(logger: Logger, , argv: Iterable[str] | None = None, workdir: Path | None = None, configs: Mapping[str, Path | None] | None = None, write_requirements: bool = False) → None

Log runtime metadata for the current run.

Logged fields include: : - Start timestamp.

• Python executable and command-line arguments.
• Working directory.
• Python version.
• Config paths (if provided).
• Git metadata (commit/branch/dirty), when available.
• Optional requirements snapshot (pip freeze).

• Parameters:
  • logger (logging.Logger) – Logger used to emit metadata.
  • argv (Iterable *[*str ] | None) – Command arguments; defaults to sys.argv.
  • workdir (Path | None) – Working directory to report.
  • configs (Mapping *[*str , Path | None ] | None) – Named config paths to log.
  • write_requirements (bool) – If True, export pip freeze output to requirements.txt alongside the log file.
• Returns: None

Example

>>> import logging
>>> log_run_metadata(logging.getLogger("espnet3"))