`parametrised_sweep`

Module Contents

Parent class for all Sweep types that need a custom hash

class parametrised_sweep.ParametrizedSweep(**params)

Bases: param.Parameterized

Parent class for all Sweep types that need a custom hash

static param_hash(param_type: param.Parameterized, hash_value: bool = True) → int

A custom hash function for parametrised types with options for hashing the value of the type and hashing metadata

Parameters:

param_type (Parameterized) – A parameter
hash_value (bool, optional) – use the value as part of the hash. Defaults to True.
hash_meta (#) – use metadata as part of the hash. Defaults to False.

Returns:

a hash

Return type:

int

hash_persistent() → str: A hash function that avoids the PYTHONHASHSEED ‘feature’ which returns a different hash value each time the program is run

update_params_from_kwargs(**kwargs) → None: Given a dictionary of kwargs, set the parameters of the passed class ‘self’ to the values in the dictionary.

classmethod get_input_and_results(include_name: bool = False) → Tuple[dict, dict]

Get dictionaries of input parameters and result parameters

Parameters:

cls – A parametrised class
include_name (bool) – Include the name parameter that all parametrised classes have. Default False

Returns:

a tuple containing the inputs and result parameters as dictionaries

Return type:

Tuple[dict, dict]

get_inputs_as_dict() → dict: Get the key:value pairs for all the input variables

get_results_values_as_dict(holomap=None) → dict: Get a dictionary of result variables with the name and the current value

classmethod get_inputs_only() → List[param.Parameter]

Return a list of input parameters

classmethod get_input_defaults(override_defaults: List = None) → List[Tuple[param.Parameter, Any]]

classmethod get_results_only() → List[param.Parameter]

Return a list of input parameters

classmethod get_inputs_as_dims(compute_values=False, remove_dims: str | List[str] = None) → List[holoviews.Dimension]

to_dynamic_map(callback=None, name=None, remove_dims: str | List[str] = None) → holoviews.DynamicMap

to_holomap(callback, remove_dims: str | List[str] = None) → holoviews.DynamicMap