Closed kamilest closed 1 month ago
[!CAUTION]
Review failed
The head commit changed during the review from 94cf21677365f1182ee7d87e26b9ff2bcd6f7418 to 96c9bacf78297d2d90cdfbe8231140fc3f0265e3.
The recent changes encompass updates to the .pre-commit-config.yaml
, README.md
, and several files within the src/MEDS_DEV
directory. Key modifications include the update of the pre-commit-hooks
version, enhancements to the README for user guidance, and the introduction of new scripts and configuration files aimed at generating random predictions and managing prediction settings. These updates collectively enhance the structure and usability of the MEDS-DEV project.
Files | Change Summary |
---|---|
.pre-commit-config.yaml |
Updated pre-commit-hooks version from v4.4.0 to v5.0.0 and set default Python version to python3.10 . Consolidated args key format. |
README.md |
Expanded content with detailed setup instructions, workflow steps, and configuration guidance. |
src/MEDS_DEV/configs/predictions.yaml |
Introduced configuration for prediction settings, including directory management and logging. |
src/MEDS_DEV/helpers/generate_predictions.sh |
Added a script for generating random predictions, setting up environment variables, and invoking Python functionality. |
src/MEDS_DEV/helpers/generate_random_predictions.py |
Introduced a module for generating random predictions from dataframes, utilizing Hydra for configuration. |
sequenceDiagram
participant User
participant ShellScript
participant PythonModule
participant Config
User->>ShellScript: Execute generate_predictions.sh
ShellScript->>Config: Load environment variables
ShellScript->>PythonModule: Call generate_random_predictions
PythonModule->>Config: Read configuration settings
PythonModule->>Dataframe: Load datasets
Dataframe->>PythonModule: Provide data
PythonModule->>Dataframe: Generate random predictions
PythonModule->>Output: Save predictions
🐇 In a world of code, so bright and new,
I hop with joy, for changes are due!
From README to scripts, all polished and neat,
The MEDS-DEV project is now quite a treat!
With predictions to make and guidance so clear,
Let’s celebrate progress, give a cheer! 🎉
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
@kamilest can you fix the code quality issues that are causing that workflow to fail? See here for details: https://github.com/mmcdermott/MEDS-DEV/actions/runs/10800915362/job/29959946112?pr=16 I'm happy to have a quick call about how to get it set up so that your terminal automatically checks for these issues on any commit, if that would be of interest.
This is a very rough version of the workflow for installing MEDS-DEV, setting up the task and dataset configurations, running a model (with a helper script for generating random binary classification predictions), and evaluating the results.
Of course this will need to be improved in terms of usability, functionality, and robustness.
Summary by CodeRabbit
New Features
README.md
to include comprehensive setup and usage instructions for the MEDS-DEV project.Documentation
README.md
with detailed workflows, setup instructions, and contribution guidelines.