Merge pull request #1298 from humanprotocol/develop

Release 20231201

Author: portuu3

docs/sdk/SUMMARY.md

@@ -15,8 +15,31 @@
 * [Storage](typescript/modules/storage.md)
   * [StorageClient](typescript/classes/storage.StorageClient.md)
 * [Statistics](typescript/modules/statistics.md)
-  * [StakingClient](typescript/classes/statistics.StatisticsClient.md)
+  * [StatisticsClient](typescript/classes/statistics.StatisticsClient.md)
 
 ## Python SDK
 
-* [human_protocol_sdk](python/index.md)
+* [agreement](python/human_protocol_sdk.agreement.md)
+  * [bootstrap](python/human_protocol_sdk.agreement.bootstrap.md)
+  * [measures](python/human_protocol_sdk.agreement.measures.md)
+  * [utils](python/human_protocol_sdk.agreement.utils.md)
+* [encryption](python/human_protocol_sdk.encryption.md)
+  * [encryption](python/human_protocol_sdk.encryption.encryption.md)
+  * [legacy_encryption](python/human_protocol_sdk.legacy_encryption.md)
+  * [encryption_utils](python/human_protocol_sdk.encryption.encryption_utils.md)
+* [escrow](python/human_protocol_sdk.escrow.md)
+  * [escrow_client](python/human_protocol_sdk.escrow.escrow_client.md)
+  * [escrow_utils](python/human_protocol_sdk.escrow.escrow_utils.md)
+* [kvstore](python/human_protocol_sdk.kvstore.md)
+  * [kvstore_client](python/human_protocol_sdk.kvstore.kvstore_client.md)
+* [staking](python/human_protocol_sdk.staking.md)
+  * [staking_client](python/human_protocol_sdk.staking.staking_client.md)
+  * [staking_utils](python/human_protocol_sdk.staking.staking_utils.md)
+* [statistics](python/human_protocol_sdk.statistics.md)
+  * [statistics_client](python/human_protocol_sdk.statistics.statistics_client.md)
+* [storage](python/human_protocol_sdk.storage.md)
+  * [storage_client](python/human_protocol_sdk.storage.storage_client.md)
+  * [storage_utils](python/human_protocol_sdk.storage.storage_utils.md)
+* [constants](python/human_protocol_sdk.constants.md)
+* [filter](python/human_protocol_sdk.filter.md)
+* [utils](python/human_protocol_sdk.utils.md)

docs/sdk/python/human_protocol_sdk.agreement.bootstrap.md

@@ -0,0 +1,41 @@
+# human_protocol_sdk.agreement.bootstrap module
+
+Module containing methods to calculate confidence intervals using bootstrapping.
+
+### human_protocol_sdk.agreement.bootstrap.confidence_intervals(data, statistic_fn, n_iterations=1000, n_sample=None, confidence_level=0.95, algorithm='bca', seed=None)
+
+Returns a tuple, containing the confidence interval for the boostrap estimates of the given statistic and statistics of the bootstrap samples.
+
+* **Parameters:**
+  * **data** (`Sequence`) – Data to estimate the statistic.
+  * **statistic_fn** (`Callable`) – Function to calculate the statistic. statistic_fn(data) must return a number.
+  * **n_iterations** (`int`) – Number of bootstrap samples to use for the estimate.
+  * **n_sample** (`Optional`[`int`]) – If provided, determines the size of each bootstrap sample
+    drawn from the data. If omitted, is equal to the length of the data.
+  * **confidence_level** – Size of the confidence interval.
+  * **algorithm** – Which algorithm to use for the confidence interval
+    estimation. “bca” uses the “Bias Corrected Bootstrap with
+    Acceleration”, “percentile” simply takes the appropriate
+    percentiles from the bootstrap distribution.
+  * **seed** – Random seed to use.
+* **Return type:**
+  `Tuple`[`Tuple`[`float`, `float`], `ndarray`]
+* **Returns:**
+  Confidence interval and bootstrap distribution.
+* **Example:**
+  ```python
+  from human_protocol_sdk.agreement.bootstrap import confidence_interval
+  import numpy as np
+
+  np.random.seed(42)
+  data = np.random.randn(10_000)
+  fn = np.mean
+  sample_mean = fn(data)
+  print(f"Sample mean is {sample_mean:.3f}")
+  # Sample mean is -0.002
+
+  cl = 0.99
+  ci, _ = confidence_interval(data, fn, confidence_level=cl)
+  print(f"Population mean is between {ci[0]:.2f} and {ci[1]:.2f} with a probablity of {cl}")
+  # Population mean is between -0.02 and 0.02 with a probablity of 0.99
+  ```