arviz_stats.base.array_stats.ess

array_stats.ess(ary, chain_axis=-2, draw_axis=-1, method='bulk', relative=False, prob=None)

Compute of ess on array-like inputs.

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

Parameters:

aryarray_like

chain_axisint, default -2

draw_axisint, default -1

methodstr, default “bulk”

relativebool, default False

probfloat or (float, float), default None

When using the array interface, prob is a required argument for the “tail”, “quantile” (as float) and “local” (as tuple) methods.