search

tzhangwps / Recession-Predictor

Project description: https://medium.com/p/recession-prediction-using-machine-learning-de6eee16ca94?source=email-2adc3d3cd2ed--writer.postDistributed&sk=2f1dab9738769f9658634e61576a08bd
MIT License
30 stars 28 forks source link

readme

Recession-Predictor (0.1.0)

Intro

Credits

Author: Terrence Zhang

For Users

Dependencies

Python (3.7.13) \ Modules: requirements.txt

How to Use the Code

  1. Download all folders and files in the repository. Maintain the file organization structure.
  2. Get your personal FRED API key here
  3. Copy and paste your FRED API key into the fred_api_key object in Line 9 of RecessionPredictor_paths.py on your local computer.
  4. Run RecessionPredictor_master.py via the command line. It takes one positional argument process, whose choices are backtest or deploy:
    • backtest: runs all modules required for backtesting models. These modules get the data, perform exploratory analysis, build features, conduct backtests, and plot results from the backtest.
    • deploy: runs all modules required for model deployment. These modules get the data, build features, and deploy the chosen model onto the most recent data. Model outputs are saved to th deployment_chart.csv file.

For Developers

License: MIT \ For a more in depth explanation of the code, click here.