param.parameterized.Parameters.get_value_generator

Parameters.get_value_generator(name: str) → Any

Retrieve the value or value-generating object of a named parameter.

For most parameters, this is simply the parameter’s value (i.e. the same as getattr()), but param.Dynamic parameters have their value-generating object returned.

Parameters:

name (str) – The name of the parameter whose value or value-generating object is to be retrieved.

Returns:

The current value of the parameter, a value-generating object for param.Dynamic parameters.

Return type:

Any

Examples

>>> import param
>>> import numbergen
>>> class MyClass(param.Parameterized):
...     x = param.String(default="Hello")
...     y = param.Dynamic(default=numbergen.UniformRandom(lbound=-1, ubound=1, seed=1))

>>> instance = MyClass()

Access the parameter value directly:

>>> instance.y
-0.7312715117751976
>>> instance.y
0.6948674738744653

Retrieve the parameter’s value or value-generating object:

>>> instance.param.get_value_generator("y")
<UniformRandom UniformRandom ...>