paramspace package

This package provides classes to conveniently define hierarchically structured parameter spaces and iterate over them.

To that end, any dict-like object can be populated with ParamDim objects to create a parameter dimension at that key. When creating a ParamSpace from this dict, it becomes possible to iterate over all points in the space created by the parameter dimensions, i.e. the parameter space.

Furthermore, the paramspace.yaml module provides possibilities to define the parameter space fully from YAML configuration files, using custom YAML tags.

Submodules

• paramspace.paramdim module
  • Masked
    • Masked.__init__()
    • Masked.value
    • Masked.to_yaml()
  • MaskedValueError
    • MaskedValueError.args
    • MaskedValueError.with_traceback()
  • ParamDimBase
    • ParamDimBase._OMIT_ATTR_IN_EQ
    • ParamDimBase._REPR_ATTRS
    • ParamDimBase._VKWARGS
    • ParamDimBase.__init__()
    • ParamDimBase._init_vals()
    • ParamDimBase.name
    • ParamDimBase.order
    • ParamDimBase.default
    • ParamDimBase.values
    • ParamDimBase.coords
    • ParamDimBase.pure_coords
    • ParamDimBase.num_values
    • ParamDimBase.num_states
    • ParamDimBase.state
    • ParamDimBase.current_value
    • ParamDimBase.__eq__()
    • ParamDimBase.__len__()
    • ParamDimBase.__str__()
    • ParamDimBase.__repr__()
    • ParamDimBase._parse_repr_attrs()
    • ParamDimBase.__iter__()
    • ParamDimBase.__next__()
    • ParamDimBase.enter_iteration()
    • ParamDimBase.iterate_state()
    • ParamDimBase.reset()
    • ParamDimBase._parse_value()
    • ParamDimBase._set_values()
    • ParamDimBase._rec_tuple_conv()
    • ParamDimBase._YAML_UPDATE
    • ParamDimBase._YAML_REMOVE_IF
    • ParamDimBase.to_yaml()
    • ParamDimBase.from_yaml()
    • ParamDimBase._abc_impl
  • ParamDim
    • ParamDim._OMIT_ATTR_IN_EQ
    • ParamDim._REPR_ATTRS
    • ParamDim.yaml_tag
    • ParamDim._YAML_UPDATE
    • ParamDim._YAML_REMOVE_IF
    • ParamDim.__init__()
    • ParamDim.target_of
    • ParamDim.state
    • ParamDim.mask_tuple
    • ParamDim.mask
    • ParamDim.num_masked
    • ParamDim.__len__()
    • ParamDim.enter_iteration()
    • ParamDim.iterate_state()
    • ParamDim.reset()
    • ParamDim._VKWARGS
    • ParamDim.__eq__()
    • ParamDim.__iter__()
    • ParamDim.__next__()
    • ParamDim.__repr__()
    • ParamDim.__str__()
    • ParamDim._abc_impl
    • ParamDim._init_vals()
    • ParamDim._parse_repr_attrs()
    • ParamDim._parse_value()
    • ParamDim._rec_tuple_conv()
    • ParamDim._set_values()
    • ParamDim.coords
    • ParamDim.current_value
    • ParamDim.default
    • ParamDim.from_yaml()
    • ParamDim.name
    • ParamDim.num_states
    • ParamDim.num_values
    • ParamDim.order
    • ParamDim.pure_coords
    • ParamDim.to_yaml()
    • ParamDim.values
  • CoupledParamDim
    • CoupledParamDim._OMIT_ATTR_IN_EQ
    • CoupledParamDim._REPR_ATTRS
    • CoupledParamDim.yaml_tag
    • CoupledParamDim._YAML_UPDATE
    • CoupledParamDim._YAML_REMOVE_IF
    • CoupledParamDim.__init__()
    • CoupledParamDim.__len__()
    • CoupledParamDim.enter_iteration()
    • CoupledParamDim.iterate_state()
    • CoupledParamDim.reset()
    • CoupledParamDim.target_name
    • CoupledParamDim._target_name_as_list
    • CoupledParamDim._VKWARGS
    • CoupledParamDim.__eq__()
    • CoupledParamDim.__iter__()
    • CoupledParamDim.__next__()
    • CoupledParamDim.__repr__()
    • CoupledParamDim.__str__()
    • CoupledParamDim._abc_impl
    • CoupledParamDim._init_vals()
    • CoupledParamDim._parse_repr_attrs()
    • CoupledParamDim._parse_value()
    • CoupledParamDim._rec_tuple_conv()
    • CoupledParamDim._set_values()
    • CoupledParamDim.coords
    • CoupledParamDim.from_yaml()
    • CoupledParamDim.name
    • CoupledParamDim.num_states
    • CoupledParamDim.num_values
    • CoupledParamDim.order
    • CoupledParamDim.pure_coords
    • CoupledParamDim.to_yaml()
    • CoupledParamDim.target_pdim
    • CoupledParamDim.default
    • CoupledParamDim.values
    • CoupledParamDim.state
    • CoupledParamDim.current_value
    • CoupledParamDim.mask
• paramspace.paramspace module
  • ParamSpace
    • ParamSpace.yaml_tag
    • ParamSpace.__init__()
    • ParamSpace._gather_paramdims()
    • ParamSpace._unique_dim_names()
    • ParamSpace._get_dim()
    • ParamSpace.default
    • ParamSpace.current_point
    • ParamSpace.dims
    • ParamSpace.dims_by_loc
    • ParamSpace.coupled_dims
    • ParamSpace.coupled_dims_by_loc
    • ParamSpace.coords
    • ParamSpace.pure_coords
    • ParamSpace.current_coords
    • ParamSpace.num_dims
    • ParamSpace.num_coupled_dims
    • ParamSpace.volume
    • ParamSpace.full_volume
    • ParamSpace.shape
    • ParamSpace.full_shape
    • ParamSpace.states_shape
    • ParamSpace.max_state_no
    • ParamSpace.state_vector
    • ParamSpace.state_no
    • ParamSpace.__eq__()
    • ParamSpace.__str__()
    • ParamSpace.__repr__()
    • ParamSpace.get_info_dict()
    • ParamSpace.get_info_str()
    • ParamSpace._parse_dims()
    • ParamSpace.to_yaml()
    • ParamSpace.from_yaml()
    • ParamSpace.get()
    • ParamSpace.pop()
    • ParamSpace.__iter__()
    • ParamSpace.iterator()
    • ParamSpace.reset()
    • ParamSpace._next_state()
    • ParamSpace._gen_iter_rv()
    • ParamSpace.state_map
    • ParamSpace.active_state_map
    • ParamSpace.get_state_vector()
    • ParamSpace.get_dim_values()
    • ParamSpace._calc_state_no()
    • ParamSpace.set_mask()
    • ParamSpace.set_masks()
    • ParamSpace.activate_subspace()
• paramspace.tools module
  • log
  • SKIP
  • Skip
  • recursive_contains()
  • recursive_getitem()
  • recursive_update()
  • recursive_setitem()
  • recursive_collect()
  • recursive_replace()
  • recursively_sort_dict()
  • is_iterable()
  • get_key_val_iter()
• paramspace.yaml module
• paramspace.yaml_constructors module
  • pspace_unsorted()
  • pdim()
  • coupled_pdim()
  • pdim_default()
  • coupled_pdim_default()
  • _pspace_constructor()
  • _pdim_constructor()
• paramspace.yaml_representers module