Skip to content

Commit 12fb18e

Browse files
committed
update readme
1 parent a9d86d4 commit 12fb18e

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ lb = binom_ci(k, n, alpha, 'lb')
5959

6060
Find maximum expected shortage given miscoverage rate and number of samples:
6161
```
62+
from binomial_cis import max_expected_shortage
63+
6264
mes_ub, mes_lb, p_lb, num_iters = max_expected_shortage(alpha, n, tol=1e-3)
6365
```
6466

@@ -79,6 +81,8 @@ ub = binom_ci(k, n, alpha, 'ub')
7981

8082
Find maximum expected excess given miscoverage rate and number of samples:
8183
```
84+
from binomial_cis import max_expected_excess
85+
8286
mee_ub, mee_lb, p_lb, num_iters = max_expected_excess(alpha, n, tol=1e-3)
8387
```
8488

@@ -99,6 +103,8 @@ lb, ub = binom_ci(k, n, alpha, 'lb,ub')
99103

100104
Find maximum expected width given miscoverage rate and number of samples:
101105
```
106+
from binomial_cis import max_expected_width
107+
102108
mew_ub, mew_lb, p_lb, num_iters = max_expected_width(alpha, n, tol=1e-3)
103109
```
104110

docs/index.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@ Find maximum expected shortage given miscoverage rate and number of samples:
5151

5252
.. code-block::
5353
54+
from binomial_cis import max_expected_shortage
55+
5456
mes_ub, mes_lb, p_lb, num_iters = max_expected_shortage(alpha, n, tol=1e-3)
5557
5658
@@ -75,6 +77,8 @@ Find maximum expected excess given miscoverage rate and number of samples:
7577

7678
.. code-block::
7779
80+
from binomial_cis import max_expected_excess
81+
7882
mee_ub, mee_lb, p_lb, num_iters = max_expected_excess(alpha, n, tol=1e-3)
7983
8084
@@ -100,6 +104,8 @@ Find maximum expected width given miscoverage rate and number of samples:
100104

101105
.. code-block::
102106
107+
from binomial_cis import max_expected_width
108+
103109
mew_ub, mew_lb, p_lb, num_iters = max_expected_width(alpha, n, tol=1e-3)
104110
105111

0 commit comments

Comments
 (0)