From 4a91ae6eebd39d19a7203466ec4d50388cfeb497 Mon Sep 17 00:00:00 2001 From: kamilest Date: Fri, 11 Oct 2024 15:43:54 +0100 Subject: [PATCH] Describe the meaning of entries in the schema. --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index f218b57..c31b2a7 100644 --- a/README.md +++ b/README.md @@ -138,9 +138,15 @@ Prediction = TypedDict( ) ``` +where `boolean_value` represents the ground truth value, `predicted_boolean_value` is a binary prediction +(which for most methods depends on the decision threshold), and `predicted_boolean_probability` could be +interpreted as a score in \[0, 1\] or as a probabilistic uncertainty level for the prediction. + TODO: make the predicted values/probabilities optional and evaluate metrics based on availability of these values +TODO: update this in MEDS-evaluation README. + ### Evaluate the model You can use the `meds-evaluation` package by running `meds-evaluation-cli` and providing the path to