SamplesSummary#
- class liesel.goose.SamplesSummary(samples, quantiles=(0.05, 0.5, 0.95), hdi_prob=0.9, selected=None, deselected=None, per_chain=False, which=('mean', 'sd', 'var', 'quantiles', 'hdi', 'ess_bulk', 'ess_tail', 'rhat', 'mcse_mean', 'mcse_sd'))[source]#
Bases:
objectPosterior summary and diagnostics for a dictionary of sample arrays.
Accepts read-only mappings and does not modify the supplied mapping or its arrays.
See
Summaryfor the full description of the computed statistics, their interpretation, thequantitieslayout, and the behavior ofquantiles,hdi_prob,per_chain, andwhich. This class computes the same sample-based statistics asSummary, but takes a plain dictionary of sample arrays instead of aSamplingResultsobject and does not include sampling-error or acceptance-probability diagnostics.Offers two main use cases:
- The summary object can be turned into a
DataFrame using
to_dataframe().
- The summary object can be turned into a
Programmatically access summary statistics via
quantities[quantity_name][var_name]. Please refer to the documentation of the attributequantitiesfor details.
- Parameters:
samples (
Mapping[str,ArrayLike]) – The dictionary of samples to summarize. Each array is expected to have leading dimensions(nchains, ndraws, ...).quantiles (
Sequence[float], default:(0.05, 0.5, 0.95)) – Posterior quantile probabilities to compute when"quantiles"is included inwhich.hdi_prob (
float, default:0.9) – Posterior probability mass of the highest density interval to compute when"hdi"is included inwhich.selected (
list[str] |None, default:None) – Allow to get a summary only for a subset of the position keys.deselected (
list[str] |None, default:None) – Allow to get a summary only for a subset of the position keys.per_chain (
bool, default:False) – If True, the summary is calculated on a per-chain basis. Certain measures likerhatare not available ifper_chainis True.which (
Sequence[Literal['mean','sd','var','quantiles','hdi','ess_bulk','ess_tail','rhat','mcse_mean','mcse_sd']], default:('mean', 'sd', 'var', 'quantiles', 'hdi', 'ess_bulk', 'ess_tail', 'rhat', 'mcse_mean', 'mcse_sd')) – Names of the summary statistics to compute. Supported values are the same as forSummary.
Notes
This class is still considered experimental. The API may still undergo larger changes.
Methods
aggregate_diagnostics([by])Aggregates effective sample sizes (ESS) and rhat.
from_array(a[, quantiles, hdi_prob, ...])Initializes the summary from an array of samples.
Turns SamplesSummary object into a
DataFrameobject.Attributes
Configuration used to compute and format the summaries.
Whether summaries are computed separately for each chain.
Computed summary quantities for the selected samples.
Metadata describing the chains and posterior draws.