mmcdermott / MEDS-DEV

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

Adding AUMCdb to MEDS-DEV #27

Closed rvandewater closed 1 month ago

rvandewater commented 1 month ago

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 1 month ago

Walkthrough

This pull request includes multiple updates across several files related to the MEDS_DEV project. Key changes involve enhancements to the README.md files for the AUMCdb dataset and general dataset contributions, the introduction of new predicates in the predicates.yaml file, modifications to the extract_task.sh script for improved usability, and the addition of a new dataset template in dataset.md. These changes collectively aim to improve documentation, streamline dataset contributions, and clarify access requirements and task definitions.

Changes

File Path Change Summary
src/MEDS_DEV/datasets/AUMCdb/README.md Updated to provide detailed dataset description, access requirements, supported tasks, and links.
src/MEDS_DEV/datasets/AUMCdb/predicates.yaml Added predicates for ICU admission, discharge, and death with specific regex patterns and codes.
src/MEDS_DEV/datasets/README.md Refined contribution instructions, including specifying packages, dataset information, and PR creation.
src/MEDS_DEV/helpers/extract_task.sh Added help function, argument validation, and execution logging to enhance script usability.
src/MEDS_DEV/templates/dataset.md Introduced a new dataset template outlining structure and components for dataset creation.
src/MEDS_DEV/tasks/criteria/mortality/in_icu/first_24h.yaml Clarified task description, removed hospital discharge predicate, and updated discharge_or_death logic.

Possibly related issues

Possibly related PRs

Suggested reviewers

🐰 In the meadow, changes sprout,
With README updates, there's no doubt.
Predicates added, templates anew,
For datasets bright, a clearer view.
Hop along, let’s document right,
In the world of MEDS, we take flight! 🌼


πŸ“œ Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
πŸ“₯ Commits Files that changed from the base of the PR and between 54cd7c68656319f2f7f88ffd818c948a9efd3ed4 and 65c6c27f7f10aebe833d4086e66ca9b164340fee.
πŸ“’ Files selected for processing (1) * src/MEDS_DEV/tasks/criteria/mortality/in_icu/first_24h.yaml (1 hunks)
πŸ”‡ Additional comments (2)
src/MEDS_DEV/tasks/criteria/mortality/in_icu/first_24h.yaml (2)
Line range hint `1-56`: **Verify predicate definitions are provided.** The configuration uses several undefined predicates (marked with `???`). Please ensure that the following predicates are properly defined: - `icu_admission` - `icu_discharge` - `death` Let's check for the predicate definitions: ```shell #!/bin/bash # Description: Verify that the required predicates are defined somewhere in the codebase # Search for predicate definitions rg -A 5 "predicates:.*(?:icu_admission|icu_discharge|death):" "src/MEDS_DEV/" ``` --- `27-27`: **LGTM! The simplified predicate aligns with the task description.** The removal of `hospital_discharge` from the `discharge_or_death` predicate correctly focuses the task on ICU-specific mortality rather than hospital mortality. Let's verify that this change is consistent across related mortality prediction tasks:
βœ… Verification successful **The simplified predicate is correctly implemented and isolated to ICU mortality** The verification confirms: - `first_24h.yaml` is the only mortality prediction configuration in the codebase - The `hospital_discharge` predicate is only used in readmission tasks and MIMIC-IV dataset definitions - The `discharge_or_death` predicate correctly uses only ICU-specific predicates (`icu_discharge` and `death`) This change maintains a clean separation between ICU-specific and hospital-wide tasks, with no inconsistencies found in related configurations.
🏁 Scripts executed The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # Description: Check for any inconsistencies in mortality prediction configurations # that might still reference hospital_discharge in their predicates # Search for other mortality prediction YAML files that might reference hospital_discharge rg -l "hospital_discharge" "src/MEDS_DEV/tasks/criteria/mortality/" # Check the predicate definitions in related mortality tasks rg "discharge_or_death:\s+expr:" "src/MEDS_DEV/tasks/criteria/mortality/" ``` Length of output: 331 --- Script: ```shell #!/bin/bash # Let's try a different approach to find mortality prediction configurations # Search for YAML files in the mortality directory fd -e yaml . src/MEDS_DEV/tasks/criteria/mortality/ # Then let's examine the predicates section in these files rg -A 10 "predicates:" src/MEDS_DEV/tasks/criteria/mortality/ # Also search for any occurrence of hospital_discharge in the entire MEDS_DEV directory rg "hospital_discharge" src/MEDS_DEV/ ``` Length of output: 1291
--- 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.
rvandewater commented 1 month ago

@mmcdermott Tested and ready for merge with the caveat at #28. Let us know how to deal with that.

mmcdermott commented 1 month ago

Though we'll want to fix the PR issues before merging.

rvandewater commented 1 month ago

Executed the pre-commit linting. Hope that everything works now.