ESPnet3 Demo Configuration

This page explains the demo.yaml schema used by pack_demo and upload_demo.

Important

Current demo config is centered on a packed model source plus UI definition.

Minimum required keys

Typical demo config needs:

• model.dir_or_tag
• ui.app_script
• upload_demo.hf_repo for uploads

Common optional keys:

• model.trust_user_code
• model.call_args
• ui.title
• ui.description
• ui.inputs
• ui.outputs
• pack.include
• pack.exclude

Basic shape

model:
  dir_or_tag: ../model_pack
  trust_user_code: false
  call_args: {}

ui:
  app_script: src/app.py
  title: null
  description: readme.md
  inputs:
    - key: speech
      type: audio
      label: "Input Audio"
  outputs:
    - key: hyp
      type: text
      label: "Transcription"

pack:
  out_dir: demo
  include: []
  exclude: []

upload_demo:
  hf_repo: your-hf-username/your-demo

Main sections

Section	Description
model	Packed model source used by the demo runtime
ui	Gradio app script and UI definition
pack	Extra files to copy into the packed demo
upload_demo	Hugging Face Space upload settings

model

model.dir_or_tag selects the model used by the demo.

Supported values:

• a local packed model directory such as ../model_pack
• a remote model tag understood by the model loader

model.call_args is passed at inference call time.

ui

ui.app_script is copied into the packed demo as app.py.

ui.description can be:

• a file path
• inline text

ui.inputs and ui.outputs define the default Gradio wiring used by the app.

pack

pack.include copies extra files or directories into the demo bundle. pack.exclude removes matching files from copied directories.

upload_demo

Uploads use upload_demo.hf_repo.

The packed demo directory is uploaded as-is, so repo-facing metadata should live in the files included in the bundle.

Related pages

Demo Stage

Read the stage-level flow for packing and uploading demos.

Inference Config

See the inference-side concepts that demos typically wrap.

Config Overview

Return to the full config map across the pipeline.