espnet3.contract.stages.StageSpec

source

class espnet3.contract.stages.StageSpec(, name: str, config: str | tuple[str, ...], log_dir: str | None = None, dir_aliases: tuple[str, ...] = ())

Bases: object

One stage of a system: its method name, config role(s), and log path.

• Parameters:
  • name – The stage method name on the system (e.g. "train").
  • config – The config role(s) the stage runs on - a non-empty identifier, or a tuple of them when the stage needs more than one, each naming an *_config constructor argument the system takes ("training" -> training_config). A system’s full set of roles is derived from its stages (see list_roles()); there is no separate, fixed role list.
  • log_dir – A dotted key inside the first provided role’s config whose value is the stage’s log directory (e.g. "exp_dir", "pack.out_dir"); None falls back to the system’s own default log directory.

Examples

>>> StageSpec(name="train", config="training", log_dir="exp_dir")
StageSpec(name='train', config='training', log_dir='exp_dir')
>>> StageSpec(name="pack_model", config=("training", "publication"))
StageSpec(name='pack_model', config=('training', 'publication'), log_dir=None)

config : str | tuple[str, ...]

dir_aliases : tuple[str, ...] = ()

log_dir : str | None = None

name : str