CHANGELOG.md

• .DS_Store and .ipynb_checkpoints should not be committed.
  • Delete .DS_Store
  • Delete .npm directory
  • Delete .ipynb_checkpoints directory
  • Delete notebook/.ipynb_checkpoints directory
• The email under "enforcement" should be tied to the team
  • Update CODE_OF_CONDUCT.md change to correct email address
  • Update CODE_OF_CONDUCT.md add email address
• Raw and processed/intermediate data are mixed in the data directory (they should be in subfolders, or at least clearly labelled).
  • clean unused data files
• Did not render report to PDF or HTML.
  • edited scripts, README file, rendered to html and pdf
• versions are missing from environment files(s) for some R or Python packages
  • Added versions to packages
• Does not clearly report the major findings.
  • Final PDF
• Does not discuss importance and limitations of findings.
  • Final PDF
• Does not explain why this problem is important or interesting.
  • Final PDF
• Did not reference the data set when referring to it.
  • Update README.md with reference
• Important methodology descriptions missing (e.g., did not explain in narrative what metric was being used for model parameter optimization).
  • Final PDF
• Some key references are missing.
  • Final PDF
• Many software or packages versions are not pinned in the environment specification file(s).
  • Added versions to packages
• The platform key and value is missing from the docker-compose.yml file, causing issues when running on different chip architectures.
  • Update docker-compose.yml
• Latest tag was used for docker. This is not ideal because if the user has latest locally, but there is a newer version on the container registry, then Docker will not pull it.
  • Update docker-publish.yml
• Committing unnecessary files.
  • Delete .DS_Store
  • Delete .npm directory
  • Delete .ipynb_checkpoints directory
  • Delete notebook/.ipynb_checkpoints directory
• Some branch names are not meaningful (they should reflect the work being done on the branch).
• https://github.com/UBC-MDS/DSCI522-2425-21-housing/branches
• GitHub issues were used somewhat for project communication.
  • Issues
• error occurred when render to html and pdf
  • preprocess_data.py
  • edited eda.py
• create a visualization for this that shows the pairwise correlation between the features and the targets. this can be done by importing altair_ally and using the aly.corr() method.
  • Added new EDA, Dummy baseline, optimized model.
• Baseline model for comparison
  • Added new EDA, Dummy baseline, optimized model.
• Spelling/Grammatical Errors in report
  • corrected Grammatical Errors
• Importance of the Research Question
  • added importance of question and limitations
• Limitations
  • added importance of question and limitations
• The report does not include explicit guidelines for contributors or instructions for seeking support.
  • Update README.md with support section
• In the Summary section, some conclusions about the performance of the final model could have been included
  • include evaluation of model performance
• When creating the Ridge regression model, could have added a step to do a grid search to tune the hyperparameter.