mmcdermott / MEDS-DEV

The MEDS Decentralized Extensible Validation (MEDS-DEV) Benchmark: Establishing Reproducibility and Comparability in ML for Health
MIT License
11 stars 6 forks source link

Add a basic example workflow. #16

Closed kamilest closed 1 month ago

kamilest commented 2 months ago

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

coderabbitai[bot] commented 2 months ago

[!CAUTION]

Review failed

The head commit changed during the review from 94cf21677365f1182ee7d87e26b9ff2bcd6f7418 to 96c9bacf78297d2d90cdfbe8231140fc3f0265e3.

Walkthrough

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.

Changes

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.

Sequence Diagram(s)

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?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
mmcdermott commented 1 month ago

@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.