@@ -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
5657You 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 .
59602 . Call ` .fit(chain, market) ` to calibrate.
60613 . 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
7374Step 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
0 commit comments