Skip to content

Commit 322b269

Browse files
Add envelope_prob entry to rcParams (#138)
* added envelope_prob to rcParams * added envelope_prob parameter to api docs * run current docstub version --------- Co-authored-by: Oriol (ProDesk) <oriol.abril.pla@gmail.com>
1 parent fc50ef1 commit 322b269

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

docs/source/api/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,15 @@ which sometimes requires updating default values, for example to use new algorit
222222
The default probability of computed credible intervals. Its default value here
223223
is also a friendly reminder of the arbitrary nature of commonly values like 95%
224224
225+
.. py:data:: stats.envelope_prob
226+
:type: float
227+
:value: 0.99
228+
229+
The default probability of envelopes used in diagnostic plots. The relatively high
230+
default value reflects their role in highlighting systematic departures
231+
from the model while reducing false positives due to random variation.
232+
233+
225234
.. py:data:: stats.round_to
226235
:type: int or str
227236
:value: "2g"

src/arviz_base/rcparams.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -336,6 +336,7 @@ def validate_iterable(value):
336336
"stats.module": ("base", _validate_stats_module),
337337
"stats.ci_kind": ("eti", _make_validate_choice({"eti", "hdi"})),
338338
"stats.ci_prob": (0.89, _validate_probability),
339+
"stats.envelope_prob": (0.99, _validate_probability),
339340
"stats.round_to": ("2g", _validate_rounding),
340341
"stats.ic_pointwise": (True, _validate_boolean),
341342
"stats.ic_scale": (

0 commit comments

Comments
 (0)