CHANGELOG.md

Changelog

The changes to this project will be documented in this file.

[3.0.0] - 2024-12-16

• Initial Milestone 4 Release

Added

• Unit tests for all the functions required to run the analysis.

  • The tests are in the tests folder.
    • https://github.com/UBC-MDS/DSCI_522_Group36_taxi_fare_predictor/tree/main/tests
  • Pull Requests:
    • #57
    • #69
  • This change was required by milestone 4.

• Added a Make to the Docker environment.

  • Pull Requests:
  • #73

• Added a Makefile script to run the analysis pipeline

  • Pull Requests:
  • #58

Changed

• Exported the scripts to run the analysis into functions.

  • Note: Many of the functions were initially written in function format, and did not start out as scripts.
  • Pull Requests:
    • #41
    • #27
  • This change was required by milestone 4.

• READEME.md reproducibility sequence

  • Added Makefile support
  • Badges for correctly built images
  • Corrected instructions sequence and command line consistency
  • Pull request:
    • #77
    • #71

• Fixed bugs run_validation.py where it's unable to run due to missing folder structures. Removed unnecessary click commands.

  • Pull requests:
    • #72

Fixed

• Fixed the issues with the README.md file:

  • Added a summary that includes a high-level interpretation of analysis findings and what the findings might mean.
  • Added link to the project dependencies.
  • Improved instructions on how to run the analysis.
  • README.md file:
    • https://github.com/UBC-MDS/DSCI_522_Group36_taxi_fare_predictor/blob/main/README.md
  • Pull requests:
    • #50
    • #71
    • #55
    • #77
  • This change was a fix to the issues mentioned in Milestone 1 feedback about the missing summary, dependencies, and straightforward instructions on how to run the analysis.

• Fixed environment.yml file to include the versions of the packages used, as well as using = for reproducibility.

  • environment.yml file:
    • https://github.com/UBC-MDS/DSCI_522_Group36_taxi_fare_predictor/blame/main/environment.yml
  • This change fixes the issues mentioned in Milestone 1 feedback about versions that are missing from environment files, as well as using >= instead of = in the file.

• Fixed the tables in tables to not be raw code results, and added table labeling.

  • Fixed tables:
    • https://ubc-mds.github.io/DSCI_522_Group36_taxi_fare_predictor/yellow_taxi_analysis.html
  • This changes fixes the issues mentioned in Milestone 1 feedback about the tables being raw code results and not having table labeling.

• Fix the references so that 2 references don't look like they're combined into 1 reference

  • Fixed references:
    • https://ubc-mds.github.io/DSCI_522_Group36_taxi_fare_predictor/yellow_taxi_analysis.html#references
  • This change fixes the issues mentioned in Milestone 1 feedback about 2 references looking like they are combined into 1 big reference.

• Fixed GitHub Pages not showing correct images.

  • Addressed to Adrian's comment's on the same peer review issue. (Comment 2) UBC-MDS/data-analysis-review-2024#16 (comment)
  • Pull request:
    • https://github.com/UBC-MDS/DSCI_522_Group36_taxi_fare_predictor/pull/66/files

• Fixed to pin Dockerfile base image version (tag) and add a step to the docker-publish.yml workflow so that it automatically updates the docker-compose.yml file with the tag of the new image that is built and published

  • This change fixes the issues mentioned in Milestone 2 feedback about Dockerfile base image version (tag) was not pinned
  • Fixed Docker files:
    • https://github.com/UBC-MDS/DSCI_522_Group36_taxi_fare_predictor/blob/main/docker-compose.yml
    • https://github.com/UBC-MDS/DSCI_522_Group36_taxi_fare_predictor/blob/main/.github/workflows/docker-publish.yml

• Moved around files in the repository to make it more organized.

  • Pull request:
    • #49
    • #71
  • This change was a fix to the issues mentioned in Milestone 1 feedback that "Having too many files in the project root makes the project organization less understandable." and Adrian's comment's on the peer review issue that "The organization of the folders is a bit messy and hard to navigate.". (Comment 1) UBC-MDS/data-analysis-review-2024#16 (comment)

• Added a detailed discussion on the assumptions of linear regression in the limination and next step

  • Pull Requests:
  • #74
  • This change incorporates feedback from Adrian Leung (Comment 3) to discuss the assumptions of linear regression and the potential consequences of violating these assumptions, making the motivation for the next steps more convincing.UBC-MDS/data-analysis-review-2024#16 (comment)

• Referenced figures explicitly in the results section

  • Pull Requests:
  • #74
  • This change addresses feedback from Julian Daduica (Comment 1), where figures are now referenced by their exact numbers in the results section, ensuring clarity in the report.UBC-MDS/data-analysis-review-2024#16 (comment)

• Removed unnecessary weblinks from the dataset section

  • Pull Requests:
  • #74
  • This update fixes the issue mentioned by Julian Daduica (Comment 3) regarding redundant weblinks in the dataset section. The unnecessary weblinks in brackets were deleted, and the hyperlink remains in the reference section.UBC-MDS/data-analysis-review-2024#16 (comment)

• Added better docstrings to modeling.py that explain the function better

  • Pull Request:
    • #85
  • This fixes the issue mentioned by Julian Daduica (Comment 2) regarding the lack of detailed docstrings in the modeling.py file. UBC-MDS/data-analysis-review-2024#16 (comment)

[2.0.0] - 2024-12-08

Added

• Initial Milestone 3 Release

[1.0.0] - 2024-11-30

Added

• Initial Milestone 2 Release

[0.0.1] - 2024-11-23

Added

• Initial Milestone 1 Release