From ec6c8102647a8cd981334b7c84d37493189e0c9d Mon Sep 17 00:00:00 2001 From: Hans Dembinski Date: Sun, 19 Mar 2023 14:37:17 +0100 Subject: [PATCH] better readme --- README.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index e30d2ae..fca4c9a 100644 --- a/README.rst +++ b/README.rst @@ -43,9 +43,10 @@ Features Example ------- +We bootstrap the uncertainty of the arithmetic mean, an estimator for the expectation. In this case, we know the formula to compute this uncertainty and can compare it to the bootstrap result. + .. code-block:: python - # bootstrap uncertainty of arithmetic mean from resample.bootstrap import variance import numpy as np @@ -55,6 +56,8 @@ Example print(f"bootstrap {stdev_of_mean:.2f} exact {np.std(d) / len(d) ** 0.5:.2f}") # bootstrap 0.82 exact 0.83 +The amazing thing is that the bootstrap works as well for arbitrarily complex estimators. + .. _numpy: http://www.numpy.org .. _scipy: https://www.scipy.org