computerise / computerise/stonks

Implement Fama and French Three Factor Model

Open
#24 0 comments 0 reactions 0 assignees View on GitHub
component:processing:model enhancement good first issue
Dominant language
Python
Stars
2
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Add a `fama_and_french_three_factor_model` function to `stonks/processing/models.py`. For formula details, see [here](https://www.investopedia.com/terms/f/famaandfrenchthreefactormodel.asp).

- The function takes only the relevant formula parameters as arguments.
- The function returns the Total Return of a Stock.
- All percentages are represented as decimals (ie. 9% is represented 0.09)
- Arguments and return shall be type hinted (will almost certainly be `float` in most cases. See other functions in `stonks/processing/models.py` for type hinting examples).
- Exactly one unit test shall be written for this function called `test_arbitrage_pricing_theory` in `test/processing/test_models.py`.[

[This](https://hackernoon.com/calculate-required-rate-of-return-with-the-fama-french-three-factor-model-0k1d31ww) may also be helpful/relevant.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.