Serialization

Common Helpers

Convert a serialized Dashi payload to a standards-compliant JSON string.

Return type:: str

from_json(json_string)[source]

Parse a JSON string back into a Python dictionary with Dashi scalar metadata restored.

Return type:: dict

sanitize_for_json(data)[source]

Return a JSON-compatible representation while preserving Dashi metadata. Use if you need to serialize data to a JSON file but do not want to export using the to_json function

Return type:: Any

Temporal Serialization

data_temporal_map_to_dict(dtm)[source]

Serialize one DataTemporalMap or a dictionary of them.

Return type:: dict

dict_to_data_temporal_map(data)[source]

Deserialize one DataTemporalMap or a dictionary of them.

Return type:: DataTemporalMap | dict[str, DataTemporalMap]

multivariate_data_temporal_map_to_dict(mdtm)[source]

Serialize one MultiVariateDataTemporalMap.

Return type:: dict

dict_to_multivariate_data_temporal_map(data)[source]

Deserialize one MultiVariateDataTemporalMap.

Return type:: MultiVariateDataTemporalMap

conditional_temporal_map_to_dict(conditional_dtm)[source]

Serialize a conditional temporal map dictionary returned by Dashi.

Return type:: dict

dict_to_conditional_temporal_map(data)[source]

Deserialize a conditional temporal map dictionary.

Return type:: dict[Any, MultiVariateDataTemporalMap]

conditional_univariate_temporal_map_to_dict(conditional_dtm)[source]

Serialize the result of estimate_conditional_univariate_data_temporal_map.

Return type:: dict

dict_to_conditional_univariate_temporal_map(data)[source]

Deserialize the result of conditional_univariate_temporal_map_to_dict.

Return type:: dict[Any, DataTemporalMap | dict[str, DataTemporalMap]]

Source Serialization

data_source_map_to_dict(dsm)[source]

Serialize one DataSourceMap or a dictionary of them.

Return type:: dict

dict_to_data_source_map(data)[source]

Deserialize one DataSourceMap or a dictionary of them.

Return type:: DataSourceMap | dict[str, DataSourceMap]

multivariate_data_source_map_to_dict(mdsm)[source]

Serialize one MultiVariateDataSourceMap.

Return type:: dict

dict_to_multivariate_data_source_map(data)[source]

Deserialize one MultiVariateDataSourceMap.

Return type:: MultiVariateDataSourceMap

conditional_source_map_to_dict(conditional_dsm)[source]

Serialize the result of estimate_conditional_data_source_map.

Return type:: dict

dict_to_conditional_source_map(data)[source]

Deserialize the result of conditional_source_map_to_dict.

Return type:: dict[Any, MultiVariateDataSourceMap]

conditional_univariate_source_map_to_dict(conditional_dsm)[source]

Serialize the result of estimate_conditional_univariate_data_source_map.

Return type:: dict

dict_to_conditional_univariate_source_map(data)[source]

Deserialize the result of conditional_univariate_source_map_to_dict.

Return type:: dict[Any, DataSourceMap | dict[str, DataSourceMap]]