diff --git a/README.md b/README.md index e2d6838..6a29974 100644 --- a/README.md +++ b/README.md @@ -27,4 +27,28 @@ First go to [http://0.0.0.0:4000/](http://0.0.0.0:4000/) to ensure the app is ru For training the model: [http://0.0.0.0:4000/train](http://0.0.0.0:4000/train) -For making predictions using the model: [http://0.0.0.0:4000/predict](http://0.0.0.0:4000/predict) \ No newline at end of file +For making predictions using the model: [http://0.0.0.0:4000/predict](http://0.0.0.0:4000/predict) + +## Reviewing pointers: + +Unit tests for the API: unittests/ApiTests.py + +Unit tests for the model: unittests/ModelTests.py + +Unit tests for the logging: unittests/LoggerTests.py + +Run all of the unit tests with a single script: run-tests.py + +Read/write unit tests are isolated from production models and logs + +APIs for training and prediction: /app.py + +Data ingestion automation pipeline: /cslib.py + +Multiple models comparison: notebooks/ + +EDA investigation with visualizations: notebooks/data_ingestion_eda_part1.ipynb + +Containerization within a working Docker image: /Dockerfile + +Visualization to compare the model to the baseline model: notebooks/time_series_iteration.ipynb \ No newline at end of file