Skip to content

Commit cda2435

Browse files
committed
updated readme and jupyter notebooks with Palantir example
1 parent aab8fe1 commit cda2435

File tree

4 files changed

+67
-44
lines changed

4 files changed

+67
-44
lines changed
63.3 KB
Loading
42.1 KB
Loading

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,9 @@ pip install oipd
4444

4545
### Quickstart tutorial in computing market-implied probability distributions
4646

47-
This quickstart will cover the functionality in (1) - computing market-implied probabilities. For a more technical tutorial including the functionality of (2) volatility fitting, see the full documentation [still WIP].
47+
This quickstart will cover the functionality in (1) computing market-implied probabilities. See the [included jupyter notebook ](examples/quickstart_yfinance.ipynb) for a full example on using the automated yfinance connection to download options data and compute market-implied probabilities for Palantir.
48+
49+
For a more technical tutorial including the functionality of (2) volatility fitting, see the additional jupyter notebooks in the [examples](examples/) directory, as well as the full documentation [still WIP].
4850

4951
#### A. Usage for computing a probability distribution on a specific future date
5052

@@ -80,6 +82,11 @@ q50 = prob.quantile(0.50) # median implied price
8082
skew = prob.skew() # skew
8183
```
8284

85+
<p align="center" style="margin-top: 120px;">
86+
<img src=".meta/images/palantir_distribution.png" alt="example" style="width:100%; max-width:1200px; height:auto; display:block; margin-top:50px;" />
87+
</p>
88+
89+
8390

8491
#### B. Usage for computing probabilities over time
8592

@@ -116,6 +123,12 @@ curve.prob_below(100) # query probabilities and statistics
116123
curve.kurtosis()
117124
```
118125

126+
<p align="center" style="margin-top: 120px;">
127+
<img src=".meta/images/palantir_price_forecast.png" alt="example" style="width:100%; max-width:1200px; height:auto; display:block; margin-top:50px;" />
128+
</p>
129+
130+
131+
119132
OIPD also **supports manual CSV or DataFrame uploads**.
120133

121134
See [more examples](examples/) for demos.

examples/quickstart_yfinance.ipynb

Lines changed: 53 additions & 43 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)