docstring of simultaneous_ecdf_bands() #322
Description
I believe the docstring in https://github.com/bayesflow-org/bayesflow/blob/dev/bayesflow/utils/ecdf/simultaneous_ecdf_bands.py is false claiming
def simultaneous_ecdf_bands(
num_samples: int,
[...]
):
"""
num_samples : int
The sample size used for computing the ECDF. Will equal to the number of posterior
samples when used for calibration. Corresponds to `N` in the paper above.
[...]
"""Rather, for correct computation of confidence bands, you need to pass the number of conditions here! And the function calibration_ecdf does so, so the intended functionality is intact. This is only a docs issue.
Since this is not a functionality change, I will just address the docstring and rename the argument to num_estimates in the point-estimation PR. I am writing an issue for this for reference and to give an opportunity to comment/object.