SamplesSummary.from_array()

SamplesSummary.from_array()#

classmethod SamplesSummary.from_array(a, quantiles=(0.05, 0.5, 0.95), hdi_prob=0.9, selected=None, deselected=None, per_chain=False, name='v', which=('mean', 'sd', 'var', 'quantiles', 'hdi', 'ess_bulk', 'ess_tail', 'rhat', 'mcse_mean', 'mcse_sd'))[source]#

Initializes the summary from an array of samples.

Parameters:

  • a (Any) – The array of samples to summarize.

  • hdi_prob (float, default: 0.9) – Level on which to return posterior highest density intervals.

  • 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 like rhat are not available if per_chain is True.

  • name (str, default: 'v') – Variable name to use for labelling in to_dataframe().

Return type:

SamplesSummary