create README.md

README.md

@@ -0,0 +1,40 @@
+---
+language: nl
+license: mit
+---
+
+# Regression Model for Respiration Functioning Levels (ICF b440)
+
+## Description
+A fine-tuned regression model that assigns a functioning level to Dutch sentences describing respiration functions. The model is based on a pre-trained Dutch medical language model ([link to be added]()): a RoBERTa model, trained from scratch on clinical notes of the Amsterdam UMC. To detect sentences about respiration functions in clinical text in Dutch, use the [icf-domains](https://huggingface.co/CLTL/icf-domains) classification model.
+
+## Functioning levels
+Level | Meaning
+---|---
+4 | No problem with respiration, and/or respiratory rate is normal (EWS: 9-20).
+3 | Shortness of breath in exercise (saturation ≥90), and/or respiratory rate is slightly increased (EWS: 21-30).
+2 | Shortness of breath in rest (saturation ≥90), and/or respiratory rate is fairly increased (EWS: 31-35).
+1 | Needs oxygen at rest or during exercise (saturation <90), and/or respiratory rate >35.
+0 | Mechanical ventilation is needed.
+
+The predictions generated by the model might sometimes be outside of the scale (e.g. 4.2); this is normal in a regression model.
+
+## Intended uses and limitations
+
+TBD
+
+## Training data
+
+TBD
+
+## Training procedure
+
+TBD
+
+## Evaluation results
+
+TBD
+
+## Authors and references
+
+TBD