Skip to content

Commit 441dc4c

Browse files
add return information to log_gamma doc string
1 parent f307251 commit 441dc4c

File tree

1 file changed

+12
-0
lines changed
  • bayesflow/diagnostics/metrics

1 file changed

+12
-0
lines changed

bayesflow/diagnostics/metrics/sbc.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,18 @@ def log_gamma(
4343
quantile : float in (0, 1), optional, default 0.05
4444
The quantile from the null distribution to be used as a threshold.
4545
A lower quantile increases sensitivity to deviations from uniformity.
46+
47+
Returns
48+
-------
49+
result : dict
50+
Dictionary containing:
51+
52+
- "values" : float or np.ndarray
53+
The log gamma values per variable
54+
- "metric_name" : str
55+
The name of the metric ("Log Gamme").
56+
- "variable_names" : str
57+
The (inferred) variable names.
4658
"""
4759
samples = dicts_to_arrays(
4860
estimates=estimates,

0 commit comments

Comments
 (0)