docs: include data folder

Lindstaedt · Apr 16, 2019 · d21af80 · d21af80
1 parent 8b6c927
commit d21af80
Show file tree

Hide file tree

Showing 16 changed files with 3 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,7 @@
 confidential-API-key.txt
 
 # exclude data from source control by default
-/data/
+
 
 # Created by https://www.gitignore.io/api/python,pycharm+all
 # Edit at https://www.gitignore.io/?templates=python,pycharm+all

diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 ## Installation
 This project is using the Anaconda distribution of Python version 3.5. Libraries used listed in detail in the requirements.txt file. They primarily include Pandas, Matplotlib, Numpy, Seaborn, TA-Lib (https://github.com/mrjbq7/ta-lib), and Pandas Datareader. Additionally, TPOT (https://epistasislab.github.io/tpot/) is used.
-A free key from Quandl.com is required to load historical stock data. Locally, the notebooks will save data in a subfolder "/data" that is not included in this repo since all data is built from the Quandl data.
+A free key from Quandl.com is required to load historical stock data. 
 
 ## Project Motivation
 This project is the capstone project of my completion of the Udacity Data Science Nanodegree.
@@ -26,7 +26,7 @@ The goal is to build tool that can make trading recommendations for stock purcha
 
 Additional files and folders
  - confidential-API-key.txt - not included in the GitHub repo - a file containing my personal Quandl API key
- - /data subfolder - not included in repo but will be used by notebooks to temporarily save generated dataset that will be processed in the next workbooks
+ - /data subfolder - contains preprocessed data, model predictions, and other intermediate datasets that are used by the notebooks
  - /src/models/TPOT - output from TPOT optimizer
 
 ## Results

diff --git a/data/interim/df_X_base_data.parq b/data/interim/df_X_base_data.parq
diff --git a/data/interim/df_Xy.parq b/data/interim/df_Xy.parq
diff --git a/data/model_predictions/y_pred_GridSearch_vbetahalf.pkl b/data/model_predictions/y_pred_GridSearch_vbetahalf.pkl
diff --git a/data/model_predictions/y_pred_GridSearch_vbetaone.pkl b/data/model_predictions/y_pred_GridSearch_vbetaone.pkl
diff --git a/data/model_predictions/y_pred_GridSearch_vbetatwo.pkl b/data/model_predictions/y_pred_GridSearch_vbetatwo.pkl
diff --git a/data/model_predictions/y_pred_TPOT.pkl b/data/model_predictions/y_pred_TPOT.pkl
diff --git a/data/model_predictions/y_pred_firstRF.pkl b/data/model_predictions/y_pred_firstRF.pkl
diff --git a/data/processed/X_test.parq b/data/processed/X_test.parq
diff --git a/data/processed/X_train.parq b/data/processed/X_train.parq
diff --git a/data/processed/df_Xy_all_tickers_final.parq b/data/processed/df_Xy_all_tickers_final.parq
diff --git a/data/processed/df_downloaded_all_tickers.parq b/data/processed/df_downloaded_all_tickers.parq
diff --git a/data/processed/symbols.parq b/data/processed/symbols.parq
diff --git a/data/processed/y_test.pkl b/data/processed/y_test.pkl
diff --git a/data/processed/y_train.pkl b/data/processed/y_train.pkl