Prior.to_dict

Prior.to_dict()

Convert the prior to dictionary format.

This is equivalent to the older PyMC-Marketing dictionary format.

Returns:

dict[str, Any]

The dictionary format of the prior.

Examples

Convert a prior to the dictionary format.

from pymc_marketing.prior import Prior

dist = Prior("Normal", mu=0, sigma=1)

dist.to_dict()
# {"dist": "Normal", "kwargs": {"mu": 0, "sigma": 1}}

Convert a hierarchical prior to the dictionary format.

dist = Prior(
    "Normal",
    mu=Prior("Normal"),
    sigma=Prior("HalfNormal"),
    dims="channel",
)

dist.to_dict()
# {
#     "dist": "Normal",
#     "kwargs": {
#         "mu": {"dist": "Normal"},
#         "sigma": {"dist": "HalfNormal"},
#     },
#     "dims": "channel",
# }