Update README. Remove some .gitkeep and reports/ dir

Author: daniel-cortez-stevenson

README.md

@@ -5,109 +5,108 @@ crypto-predict
 ![Docker Build](https://img.shields.io/docker/automated/danielstevenson/crypto-predict.svg)
 ![Docker Build Status](https://img.shields.io/docker/build/danielstevenson/crypto-predict.svg)
 
-This project is a easily reproducible python/flask/docker project to
-create an API that predicts the price of BTC and ETH using OHLCV data.
+This project is a easily reproducible Python/Docker project to create an API that predicts the price of BTC and ETH using OHLCV data. The API is defined using Zalando's connexion package, which leverages the Flask framework.
 
-Current implementation smooths the raw close % change data (previous 72 hours) using a Haar discrete wavelet transformation. This data
-is fed into a stacked autoencoder. The encoded layer of the autoencoder feeds into a dual-layer LSTM with linear activation function. The autoencoder and LSTM are trained simultaneously (network graph coming soon!).
+Current implementation smooths the raw close % change data (previous 72 hours) using a Haar discrete wavelet transformation. This data is fed into a stacked autoencoder. The encoded layer of the autoencoder feeds into a dual-layer LSTM with linear activation function. The autoencoder and LSTM are trained simultaneously (network graph coming soon!).
 
 ***Note: Anaconda is recommended to manage the project environment. Environment creation without Anaconda is untested***
 
-Make Commands
-========
-
-The Makefile contains the central entry points for common tasks related to this project.
-
-Run the following to create the project python environment, install packages, get the training data from Cryptocompare API, featurize the data, and train models for use in the docker API.
-
+## Install the Development Environment
 *from the top project directory*
 ```bash
 mv .env_template .env   # Must have a .env file for some functions to find correct path
 make create_environment
 conda activate crypto_predict
+make install_dev
+make test
+```
+
+## Get/Process Data and Train Models with crypr-* Commands
+```bash
 crypr-data
 crypr-features
 crypr-models
-make run_docker
-make test
 ```
 
-Docker Usage
-============
-### Local
-<i> from top directory </i>
-```docker
-docker build -f ./docker/Dockerfile -t crypr-api .
-docker run -p 5000:5000 crypr-api
+## Run the API with Docker
+*from the top project directory*
+```bash
+make run_docker
 ```
-Now find your prediction at localhost:5000/predict?coin={ETH or BTC}
+Now find your prediction at http://localhost:5000/predict?coin={ETH or BTC}
 
-Future Directions
-=================
+## Future Directions
 - More coins!
 - Visualize price predictions in a web app based on the developed prediction api
 - Use unstructured text data to calculate sentiment or other metrics to use in prediction
 - Use transfer learning from financial markets and other crypto coins to enhance the RNN model
 
-Project Organization
-------------
+## Project Organization
 ```bash
-crypr/
+├── api/                            # connexion pyfiles and config
+│   ├── app.py
+│   └── swagger.yaml
+├── crypr/                          # Python Package
+│   ├── scripts/
+│   │   ├── make_dataset.py
+│   │   ├── make_features.py
+│   │   └── make_train_models.py
+│   ├── tests/
+│   │   ├── data/
+│   │   ├── test_app.py
+│   │   ├── test_base.py
+│   │   ├── test_cryptocompare.py
+│   │   ├── test_model.py
+│   │   ├── test_preprocessor.py
+│   │   └── unit_main_base.py
+│   ├── build.py
+│   ├── cryptocompare.py
+│   ├── decorator.py
+│   ├── models.py
+│   ├── preprocessors.py
+│   ├── train.py
+│   ├── util.py
+│   ├── visualize.py
+│   ├── wavelets.py
+│   └── zoo.py
+├── data/
+│   ├── external/
+│   ├── interim/
+│   ├── processed/                        # Data generated by crypr-features
+│   └── raw/                              # Data retrieved with crypr-data
+├── docker/                               # Deploy the API
+│   ├── Dockerfile
+│   └── wait_for_healthy.sh
+├── models/                               # DL models trained with crypr-models
+├── notebooks/
+│   ├── cwt_rnn_model_dev.ipynb
+│   ├── data_exploration.ipynb
+│   ├── model_dev.ipynb
+│   ├── preprocessing.ipynb
+│   ├── rnn_model_dev.ipynb
+│   ├── statistical_model_dev.ipynb
+│   ├── tree_model_dev.ipynb
+│   ├── wt_multiple_preprocessing.ipynb
+│   ├── wt_single_preprocessing.ipynb
+│   ├── wt_smooth_preprocessing.ipynb
+│   └── wt_smooth_rnn_model_dev.ipynb
+├── references/
+│   ├── bao2017.pdf
+│   └── hsieh2011.pdf
 ├── Dockerfile.dockerhub        # For hub.docker.com automated build hook
 ├── LICENSE
 ├── MANIFEST.in
 ├── Makefile
 ├── README.md
 ├── requirements.txt            # Development Python packages
-├── setup.py
 ├── setup.cfg
-├── crypr/                      # Python Package
-│   ├── api/
-│   │   ├── app.py
-│   │   └── json.py
-│   ├── base/
-│   │   ├── models.py
-│   │   └── preprocessors.py
-│   ├── data/
-│   │   └── cryptocompare.py
-│   ├── features/
-│   │   ├── build.py
-│   │   └── wavelets.py
-│   ├── models/
-│   │   ├── train.py
-│   │   └── zoo.py
-│   ├── plot/
-│   │   └── visualize.py
-│   ├── scripts/
-│   │   ├── make_dataset.py
-│   │   ├── make_features.py
-│   │   └── make_train_models.py
-│   ├── tests/
-│   │   ├── test_app.py
-│   │   ├── test_base.py
-│   │   ├── ...
-│   │   └── unit_xgboost_ETH_tx72_ty1_flag72.pkl
-│   └── util/
-│       ├── common.py
-│       └── io.py
-├── data
-│   ├── external/
-│   ├── interim/
-│   ├── processed/                           # Data generated by crypr-features
-│   │   ├── X_test_BTC_haar_smooth_72.npy
-│   │   ├── X_test_ETH_haar_smooth_72.npy
-│   │   ├── ...
-│   │   └── y_train_ETH_haar_smooth_72.npy
-│   └── raw/                                 # Data retrieved with crypr-data
-│       ├── BTC.csv
-│       └── ETH.csv
-├── docker/                                  # Deploy the API from a container
-│   ├── Dockerfile
-│   └── wait_for_healthy.sh
-├── models/                                  # DL models trained with crypr-models
-├── notebooks/
-├── references/
-└── reports/
-    └── figures/
+├── setup.py
+├── .travis.yml
+├── .gitignore
+├── .env_template
+├── .env                        # Copied from .env_template
+├── .dockerignore
+├── .coveralls.yml
+└── .coveragerc
 ```
 --------