param.parameterized.Parameters.serialize_parameters#

Parameters.serialize_parameters(subset: Iterable[str] | None = None, mode='json')[source]#

Return the serialized parameters of the Parameterized object.

Parameters:

  • subset (iterable of str, optional) – An iterable of parameter names to serialize. If None, all parameters will be serialized. Default is None.

  • mode (str, optional) – The serialization format. By default, only 'json' is supported. Default is 'json'.

Returns:

The serialized value.

Return type:

Any

Raises:

ValueError – If the specified serialization mode is not supported.

References

https://param.holoviz.org/user_guide/Serialization_and_Persistence.html#serializing-with-json

Examples

Create a Parameterized instance and serialize its parameters:

>>> import param
>>> class P(param.Parameterized):
...     a = param.Number()
...     b = param.String()
>>> p = P(a=1, b="hello")

Serialize parameters:

>>> serialized_data = p.param.serialize_parameters()
>>> serialized_data
'{"name": "P00002", "a": 1, "b": "hello"}'