espnet3.demo.pack.pack_demo
Less than 1 minute
espnet3.demo.pack.pack_demo
espnet3.demo.pack.pack_demo(system) → Path
Package demo assets and configs into a self-contained demo directory.
This prepares a runnable demo folder (typically <exp_dir>/demo) by: : - Resolving and copying the inference config into config/infer.yaml.
- Writing a resolved
demo.yamlwith paths made demo-relative. - Copying additional files configured under
demo_config.pack.files. - Creating
app.py/requirements.txt(viaespnet3.demo.setup.setup_demo_assets()). - Creating a minimal
README.mdwhen missing.
- Parameters:system – System object that provides (at minimum)
demo_configanddemo_config_pathattributes. Typically an ESPnet3 system instance. - Returns: Path to the created demo directory.
- Return type: Path
- Raises:
- RuntimeError – If
system.demo_configis missing or required files (e.g., inference config) cannot be resolved. - ValueError – If the demo config does not define a supported inference provider or does not include
infer_config.
- RuntimeError – If
Example
>>> demo_dir = pack_demo(system)
>>> (demo_dir / "demo.yaml").exists()
TrueNotes
- The output directory defaults to
<system.exp_dir>/demowhen configured, otherwise./demo.
