Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve tutorials for experimental partners #65

Open
justin13601 opened this issue Jun 25, 2024 · 4 comments
Open

Improve tutorials for experimental partners #65

justin13601 opened this issue Jun 25, 2024 · 4 comments
Labels
Documentation Improvements or additions to documentation External External contributions from partners priority:medium Things that are medium priority, and warrant attention for next larger version updates

Comments

@justin13601
Copy link
Owner

No description provided.

@justin13601 justin13601 added Documentation Improvements or additions to documentation priority:high Things that are high priority, but do not warrant an immediate hotfix External External contributions from partners labels Jun 25, 2024
@mmcdermott mmcdermott added the Impacts Benchmark Impacts the 2024 Summer / Fall Distributed MEDS Benchmarking Effort label Jul 22, 2024
@justin13601
Copy link
Owner Author

Use MIMIC Demo data for integrated tutorials with MEDS, ACES, modelling etc.

@mmcdermott mmcdermott added priority:medium Things that are medium priority, and warrant attention for next larger version updates and removed priority:high Things that are high priority, but do not warrant an immediate hotfix Impacts Benchmark Impacts the 2024 Summer / Fall Distributed MEDS Benchmarking Effort labels Aug 6, 2024
@Oufattole
Copy link
Contributor

People expressed interest in how to use ACES on MIMICIV. Is the plan to add a MIMICIV tutorial with some explanations of what aces is doing under the hood? Does it make sense for that to be in this repo or in the MEDS-DEV one? I currently have a tutorial in meds-torch that has a step where we pull some aces tasks. I copied it below, maybe you could use it as a start (you probably should use the MEDS-DEV tasks though):

Use ACES to extract labels using a task config definition:

We can manually extract the supervised task labels from our meds dataset using aces. First install aces:

conda create -n aces python=3.12
conda activate aces
pip install es-aces==0.5.0
pip install hydra-joblib-launcher

Second, run the following command to extract the supervised task labels:

TASKS=(
    "mortality/in_hospital/first_24h"
    "mortality/in_icu/first_24h"
    "mortality/post_hospital_discharge/1y"
    "readmission/30d"
)
for TASK_NAME in "${TASKS[@]}"; do
    SINGLE_TASK_DIR="${MIMICIV_MEDS_DIR}/tasks/${TASK_NAME}"
    mkdir -p $SINGLE_TASK_DIR # create a directory for the task
    cp MIMICIV_INDUCTIVE_EXPERIMENTS/configs/tasks/${TASK_NAME}.yaml "${SINGLE_TASK_DIR}.yaml"
    aces-cli --multirun hydra/launcher=joblib data=sharded data.standard=meds data.root="$MIMICIV_MEDS_DIR/data" "data.shard=$(expand_shards $MIMICIV_MEDS_DIR/data)" cohort_dir="$TASKS_DIR" cohort_name="$TASK_NAME"
done

@justin13601
Copy link
Owner Author

We considered a MIMIC-IV tutorial, but was not sure about how to effectively do so (explain what ACES is doing under the hood) without display snippets of the data. Do you have any ideas? If we don't display any data, wouldn't it be just calling a series of general commands/python functions, which may not be as helpful as we want a end-to-end tutorial to be...

@Oufattole
Copy link
Contributor

Oufattole commented Oct 29, 2024

Ahhh good point, you can't really show much under the hood stuff due to privacy constraints. How about demonstrating

  1. a MIMICIV a workflow of getting cohort stats on various cohorts on MIMICIV cohorts as aggregate statistics are safe (number of patients, prevalence of binary prediction target, and other capabilities of interest)
  2. how file structures work, specifically giving a visual of what the input and output directories should look like in your sharded vs unshareded workflows on MIMICIV. I'm not sure if this is the best way to demonstrate file structures, but I took a stab at it for meds-tab in the usage guide.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation External External contributions from partners priority:medium Things that are medium priority, and warrant attention for next larger version updates
Projects
None yet
Development

No branches or pull requests

3 participants