Skip to content

Commit 3d1c127

Browse files
authored
fixed the package name cehrbert -> cehrbert_data for hf_readmission t… (#106)
* fixed the package name cehrbert -> cehrbert_data for hf_readmission task in README * created a section to warn users about the incompatibility between OMOP and MEDS formats
1 parent 13d65ca commit 3d1c127

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,12 @@ Build the project
6262
pip install -e .[dev]
6363
```
6464

65+
## OMOP vs. MEDS Format Considerations
66+
CEHR-BERT can be trained using either the OMOP or MEDS data formats; however, models trained on one format are not compatible with those trained on the other.
67+
This incompatibility arises because CEHR-BERT uses different concept identifiers depending on the format: standard concept IDs (e.g., SNOMED for conditions) in OMOP,
68+
and source concept IDs (e.g., ICD-9/10) in MEDS. The mappings between these terminologies are many-to-many, making direct alignment between formats unreliable.
69+
It is therefore crucial to use a consistent data format across pretraining, fine-tuning, and downstream tasks such as linear probing.
70+
6571
## Instructions for Use with [MEDS](https://github.com/Medical-Event-Data-Standard/meds)
6672
Step 1. Convert MEDS to the [meds_reader](https://github.com/som-shahlab/meds_reader) database
6773
---------------------------
@@ -222,7 +228,7 @@ export SPARK_EXECUTOR_MEMORY="12g"
222228
```
223229
Generate the HF readmission prediction task
224230
```console
225-
python -u -m cehrbert.prediction_cohorts.hf_readmission \
231+
python -u -m cehrbert_data.prediction_cohorts.hf_readmission \
226232
-c hf_readmission -i ~/Documents/omop_test/ -o ~/Documents/omop_test/cehr-bert \
227233
-dl 1985-01-01 -du 2020-12-31 \
228234
-l 18 -u 100 -ow 360 -ps 0 -pw 30 \

0 commit comments

Comments
 (0)