MMMSummaryFactory.residuals_distribution#

MMMSummaryFactory.residuals_distribution(quantiles=None, aggregation=None, dims=None, output_format=None)[source]#

Create residual distribution quantile summary DataFrame.

Parameters:
quantilessequence of float, optional

Quantile probabilities to report. Default [0.025, 0.5, 0.975].

aggregationlist[str] or str, optional

Extra custom dimensions to collapse into the distribution.

dimsdict, optional

Dimension filters applied before computing quantiles.

output_format{“pandas”, “polars”}, optional

Output DataFrame format (default: uses factory default)

Returns:
pd.DataFrame or pl.DataFrame

Summary DataFrame with columns:

  • quantile: Quantile probability

  • value: Residual value at that quantile

  • <custom_dims>: Facet dimensions not included in aggregation