arviz_stats.base.array_stats.hdi

array_stats.hdi(ary, prob, axis=-1, method='nearest', circular=False, max_modes=10, skipna=False, **kwargs)

Compute highest density interval (HDI) on an array of samples.

See docstring of arviz_stats.hdi for full description of computation and arguments.

Parameters:

aryarray_like

probfloat

axisint, sequence of int or None, default -1

methodstr, default “nearest”

Valid options are “nearest”, “multimodal” or “multimodal_sample”

circularbool, default False

max_modesint, default 10

skipnabool, default False

**kwargs

Only used for multimodal methods with continuous data. Passed to kde computation with a bw default of “taylor” for circular data, “isj” otherwise.