espnet3.utils.publish.pack_model

source

espnet3.utils.publish.pack_model(system, , include: List[Path] | None = None, extra: List[Path] | None = None) → Path

Pack model artifacts for publishing.

espnet3.utils.publish.system

ESPnet3 system instance providing configs and helper paths.

• Parameters:
  • system – Object with train_config and optional publish_config.
  • include – Optional explicit include paths (defaults to exp_dir and config includes).
  • extra – Optional explicit extra paths (defaults to config extras).
• Returns: Path to the packed output directory.
• Yields: None.
• Raises:RuntimeError – If train_config is missing or required files are absent.

Examples

>>> from espnet3.utils.publish import pack_model
>>> pack_path = pack_model(system)
>>> print(pack_path)

NOTE

pack_model.strategy controls whether espnet2 or espnet3 packing logic is used. The output location can be set via publish.pack_model.out_dir. publish.pack_model.readme_template can override the default README template path. publish.pack_model.decode_dir can be used to specify which scores.json to include. If not set, it falls back to infer_config.decode_dir. README generation uses scores.json to render a per-test metrics table.