espnet3.contract.inference.load_inference_contract

source

espnet3.contract.inference.load_inference_contract(config: DictConfig | Mapping[str, Any] | None, , allow_imports: bool = True) → InferenceContract | None

Build a contract from the inference config after loading custom kinds.

• Parameters:
  • config – The contract section: a mapping (or DictConfig) with inputs, outputs and optional imports; None for none.
  • allow_imports – Whether imports may be loaded; False for an untrusted bundle.
• Returns: The contract, or None when config is None.
• Raises:
  • TypeError – If config or imports has the wrong type.
  • ValueError – If the contract has an unknown option, or imports is set while allow_imports is false.

Examples

>>> contract = load_inference_contract(
...     {
...         "inputs": {"text": {"kind": "text"}},
...         "outputs": {"text": {"kind": "text"}},
...     }
... )
>>> [field.name for field in contract.inputs]
['text']