Milestone 4

Description

• Function usage demonstration
• vignette

Work organization and retrospective

• Discussed the use of development tools, GitHub infrastructure, etc. in CONTRIBUTING.md

License checklist

• why we chose MIT

Peer Review

• Added documentation for the model_evaluation file
• Added runnable examples using a toy dataset to improve the usability for first time users.
• Provided more detailed explanations of function and package to make them easier to understand and use correctly.
• Move the contributing sections to the bottom of the REAME file
• Added badges: python, license, version, build, codecov

0.1.1 - Milestone 3

workflows

• Add workflows yml files: build.yml, deploy.yml, docs.ymls.

tests

• Add additional tests

quartodoc

• Add documentation reference page

README

• Updated guide for reproducibility

Milestone 2

src

• hyperparameter_tuning_summary.py: Create a summary of the hyperparameter tuning results and extract the best estimator.
• model_compare.py: Evaluates multiple binary classification models using cross-validation and returns a metric/scorer comparison DataFrame.
• model_evaluation.py: Compute standard classification metrics and confusion matrix artifacts.
• utils.py: Creates synthetic data and fitted models for testing ML functions.
• testing_notes.ipynb: Creates synthetic data and fitted models for testing ML functions.

tests

• README.md: Test Notes.
• conftest.py: Pytest fixtures and shared test configuration.
• test_model_compare.py: Pytest fixture to generate synthetic data and models once for all tests.
• test_model_evaluation.py: Tests for model_evaluation_plotting.
• test_param_tuning_summary.py: A test module placeholder for param_tuning_summary function.

README

• Updated environment and dependencies
• A guide for reproducibility

0.0.1

Created Files and Folders

• CODE_OF_CONDUCT.md
• CONTRIBUTING.md
• LICENSE
• README.md
• environment.yml
• pyproject.toml
• src folder: includes the 3 functions
• docs folder
• tests folder

Updated README

• Project Description
• List of Functions
• Positioning in the Python Ecosystem

Three Function Skeleton

• hyperparameter_tuning_summary.py
• model_compare.py
• model_evaluation.py