update readme

TRI-ML · Jul 1, 2024 · 12fb18e · 12fb18e
1 parent a9d86d4
commit 12fb18e
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -59,6 +59,8 @@ lb = binom_ci(k, n, alpha, 'lb')
 
 Find maximum expected shortage given miscoverage rate and number of samples:
 ```
+from binomial_cis import max_expected_shortage
+
 mes_ub, mes_lb, p_lb, num_iters = max_expected_shortage(alpha, n, tol=1e-3)
 ```
 
@@ -79,6 +81,8 @@ ub = binom_ci(k, n, alpha, 'ub')
 
 Find maximum expected excess given miscoverage rate and number of samples:
 ```
+from binomial_cis import max_expected_excess
+
 mee_ub, mee_lb, p_lb, num_iters = max_expected_excess(alpha, n, tol=1e-3)
 ```
 
@@ -99,6 +103,8 @@ lb, ub = binom_ci(k, n, alpha, 'lb,ub')
 
 Find maximum expected width given miscoverage rate and number of samples:
 ```
+from binomial_cis import max_expected_width
+
 mew_ub, mew_lb, p_lb, num_iters = max_expected_width(alpha, n, tol=1e-3)
 ```
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -51,6 +51,8 @@ Find maximum expected shortage given miscoverage rate and number of samples:
 
 .. code-block::
 
+   from binomial_cis import max_expected_shortage
+
    mes_ub, mes_lb, p_lb, num_iters = max_expected_shortage(alpha, n, tol=1e-3)
 
 
@@ -75,6 +77,8 @@ Find maximum expected excess given miscoverage rate and number of samples:
 
 .. code-block::
 
+   from binomial_cis import max_expected_excess
+   
    mee_ub, mee_lb, p_lb, num_iters = max_expected_excess(alpha, n, tol=1e-3)
 
 
@@ -100,6 +104,8 @@ Find maximum expected width given miscoverage rate and number of samples:
 
 .. code-block::
 
+   from binomial_cis import max_expected_width
+
    mew_ub, mew_lb, p_lb, num_iters = max_expected_width(alpha, n, tol=1e-3)