paramspace.yaml_constructors module

Defines the yaml constructors for the generation of ParamSpace and ParamDim during loading of YAML files.

paramspace.yaml_constructors.pspace_unsorted(loader, node) → ParamSpace

yaml constructor for creating a ParamSpace object from a mapping.

Unlike the regular constructor, this one does NOT sort the input before instantiating ParamSpace.

paramspace.yaml_constructors.pdim(loader, node) → ParamDim

constructor for creating a ParamDim object from a mapping, but only return the default value.

paramspace.yaml_constructors.coupled_pdim(loader, node) → ParamDim

constructor for creating a ParamDim object from a mapping, but only return the default value.

paramspace.yaml_constructors.pdim_default(loader, node) → ParamDim

constructor for creating a ParamDim object from a mapping, but only return the default value.

paramspace.yaml_constructors.coupled_pdim_default(loader, node) → CoupledParamDim

Constructor for creating a CoupledParamDim object from a mapping, but only return the default value.

Note

This can only be used for coupled parameter dimensions that do not rely on the coupling target for their default value.

paramspace.yaml_constructors._pspace_constructor(loader, node, sort_if_mapping: bool = True, Cls=<class 'paramspace.paramspace.ParamSpace'>) → ParamSpace

Constructor for instantiating ParamSpace from a mapping or a sequence

paramspace.yaml_constructors._pdim_constructor(loader, node, *, Cls=<class 'paramspace.paramdim.ParamDim'>, default_order: ~typing.Optional[float] = None) → ParamDimBase

Constructor for creating a ParamDim object from a mapping

For it to be incorported into a ParamSpace, one parent (or higher) of this node needs to be tagged such that the pspace_constructor is invoked.