This document outlines the improvements and changes made to the project based on the peer review. It provides the clear evidence of changes by displaying commit messages, pull requests, issues and specific lines of code.
-
Folder names Update: We have updated the folder names as per the feedback.You can find more details in commit.
-
README.md Update: We have updated the docker installation redirection link on README.md as per the feedback. You can find more details in pull request and commit.
-
Docstring Update: We have updated the docstrings to all the python scripts under scripts folder as per the feedback. You can find more details below:
- data_fetch_clean.py: commit and pull request
- eda.py: commit and pull request
- split.py: commit and pull request
- preprocessor_and_estimator.py: commit and pull request
- evaluate-save-on-earth.py: commit and pull request
-
EDA plot update: We added a descriptive plot title to both EDA distribution plots to make it easier for the audiences to understand. To further improve the readability, we removed the 'year' subplot to make the message more clear that we have a skewed distribution for all the energy consumption features. This change has been requested from feedback1, feedback2. You can find more details in pull request and commit
-
Updating final report: Adding raw data description to provide details of CO2 emission, energy consumption and energy generation datasets. Updating data wrangling rationale and showing the final processed dataset that used for modeling. This change has been requested from feedback. You can find more details in pull request and commit
-
Docker Command update: We have corrected the docker command in README.md as per the feedback. You can find more details in pull request and commit
-
Update Contributing file: We have added detailed steps for creating pull request and issue in CONTRIBUTING.md file as per the feedback. You can find more details in pull request and commit