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')[source]#

Initializes the summary from an array of samples.

Parameters:

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

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

  • selected (Optional[list[str]]) – Allow to get a summary only for a subset of the position keys. (default: None)

  • deselected (Optional[list[str]]) – Allow to get a summary only for a subset of the position keys. (default: None)

  • per_chain (bool) – If True, the summary is calculated on a per-chain basis. Certain measures like rhat are not available if per_chain is True. (default: False)

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

Return type:

SamplesSummary

Contents