designspace.payload

designspace.payload(config: dict[str, Any], param_path: str) → dict[str, Any] | None

The parameters carried by a choice parameter’s selected variant.

Parameters:

• config (dict[str, Any]) – A configuration, in nested form.

• param_path (str) – Path of the choice parameter.

Returns:

The variant’s own parameters, or None when the selected variant carries none.

Return type:

dict[str, Any] | None

Examples

>>> ds.payload({"opt": {"sgd": {"momentum": 0.5}}}, "opt")
{'momentum': 0.5}
>>> ds.payload({"opt": "adagrad"}, "opt") is None
True