Skip to content

unienv_interface.utils.array_serialization

Functions:

Name Description
serialize_scalar_or_array_value

Serialize a scalar or backend array value to a JSON-compatible payload.

deserialize_scalar_or_array_value

Deserialize a scalar or backend array value from serialized payload.

serialize_scalar_or_array_value

serialize_scalar_or_array_value(
    value: Any,
) -> Tuple[Optional[ComputeBackend], Optional[Dict[str, Any]]]

Serialize a scalar or backend array value to a JSON-compatible payload.

Returns:

Type Description
Optional[ComputeBackend]

(backend, serialized_data)

Optional[Dict[str, Any]]
  • backend is only set for backend-array values.
Tuple[Optional[ComputeBackend], Optional[Dict[str, Any]]]
  • serialized_data is None when the input value is None.

deserialize_scalar_or_array_value

deserialize_scalar_or_array_value(
    value_data: Optional[Dict[str, Any]],
    override_backend: Optional[ComputeBackend] = None,
    override_device: Optional[BDeviceType] = None,
) -> Tuple[Optional[ComputeBackend], Any]

Deserialize a scalar or backend array value from serialized payload.

Returns:

Type Description
Optional[ComputeBackend]

(backend, value)

Any
  • backend is only set for backend-array values.
Tuple[Optional[ComputeBackend], Any]
  • value is None when input value_data is None.