Skip to content

Commit 1ec2422

Browse files
committed
updated readme
1 parent 3bad9ea commit 1ec2422

2 files changed

Lines changed: 14 additions & 13 deletions

File tree

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,16 +46,17 @@ pip install oipd
4646
4747
<br>
4848

49-
OIPD has four core objects. A simple way to remember them is a matrix:
49+
50+
OIPD has four core objects. A simple way to remember them is a 2x2 matrix:
5051

5152
| Scope | Volatility Layer | Probability Layer |
5253
| --- | --- | --- |
53-
| Single expiry | `VolCurve` | `ProbCurve` |
54-
| Multiple expiries | `VolSurface` | `ProbSurface` |
54+
| Single future date | `VolCurve` | `ProbCurve` |
55+
| Future time horizon | `VolSurface` | `ProbSurface` |
5556

5657
You can think about the lifecycle in three steps:
5758

58-
1. Initialize the estimator object, with configurable params.
59+
1. Initialize the estimator object with configuration.
5960
2. Call `.fit(chain, market)` to calibrate.
6061
3. Query/plot the fitted object, or convert from vol to probability via `.implied_distribution()`.
6162

@@ -68,12 +69,12 @@ Step 1: Fit volatility
6869
Initialize VolCurve / VolSurface object
6970
+ options chain + market inputs
7071
-> .fit(...)
71-
-> fitted VolCurve / VolSurface object (IV, prices, greeks, plots...)
72+
-> fitted VolCurve / VolSurface object (inspect IV, prices, greeks, etc.)
7273
7374
Step 2: Convert fitted volatility to probability
74-
Use the fitted VolCurve / VolSurface
75+
Use fitted VolCurve / VolSurface
7576
-> .implied_distribution()
76-
-> fitted ProbCurve / ProbSurface object (PDF, CDF, quantiles, moments...)
77+
-> ProbCurve / ProbSurface object (inspect PDF, CDF, quantiles, moments, etc.)
7778
```
7879

7980
## 3. Quickstart tutorial in computing market-implied probability distributions

docs/3_user-guide.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ OIPD has four core objects. A simple way to remember them is a 2x2 matrix:
1414

1515
| Scope | Volatility Layer | Probability Layer |
1616
| --- | --- | --- |
17-
| Single expiry | `VolCurve` | `ProbCurve` |
18-
| Multiple expiries | `VolSurface` | `ProbSurface` |
17+
| Single future date | `VolCurve` | `ProbCurve` |
18+
| Future time horizon | `VolSurface` | `ProbSurface` |
1919

2020
You can think about the lifecycle in three steps:
2121

@@ -29,15 +29,15 @@ Conceptual flow:
2929

3030
```text
3131
Step 1: Fit volatility
32-
VolCurve / VolSurface object
32+
Initialize VolCurve / VolSurface object
3333
+ options chain + market inputs
3434
-> .fit(...)
35-
-> fitted VolCurve / VolSurface object (IV, prices, greeks, diagnostics)
35+
-> fitted VolCurve / VolSurface object (inspect IV, prices, greeks, etc.)
3636
3737
Step 2: Convert fitted volatility to probability
38-
fitted VolCurve / VolSurface
38+
Use fitted VolCurve / VolSurface
3939
-> .implied_distribution()
40-
-> ProbCurve / ProbSurface object (PDF, CDF, quantiles, moments)
40+
-> ProbCurve / ProbSurface object (inspect PDF, CDF, quantiles, moments, etc.)
4141
```
4242

4343
**Shortcut for computing probabilities:**

0 commit comments

Comments
 (0)