Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
improve psislw docstring
  • Loading branch information
OriolAbril committed Dec 22, 2023
commit 7a36f15a5cae6fecf0383943bfe1203496b5201b
13 changes: 7 additions & 6 deletions arviz/stats/stats.py
Original file line number Diff line number Diff line change
Expand Up @@ -880,17 +880,18 @@ def psislw(log_weights, reff=1.0):

Parameters
----------
log_weights: array
log_weights : DataArray or (..., N) array-like
Array of size (n_observations, n_samples)
reff: float
reff : float, default 1
relative MCMC efficiency, ``ess / n``

Returns
-------
lw_out: array
Smoothed log weights
kss: array
Pareto tail indices
lw_out : DataArray or (..., N) ndarray
Smoothed, truncated and normalized log weights.
kss : DataArray or (...) ndarray
Estimates of the shape parameter *k* of the generalized Pareto
distribution.

References
----------
Expand Down