Update README.md

README.md

@@ -1,3 +1,31 @@
----
-license: apache-2.0
----
+---
+license: apache-2.0
+---
+
+# An MRI Foundation Model for Versatile Clinical Applications in Gynecological Cancer via Report Metadata Learning (GynoMRFound)
+
+## Framework and tasks
+
+![image-20260320201025570](https://github.com/khtao/GynoMRFound/blob/main/assets/framework.png)
+
+## ⚡️ Installation
+
+For an editable installation, use the following commands to clone and install this repository.
+
+```bash
+conda create --name GynoMRFound python==3.12
+conda activate GynoMRFound
+
+git clone https://github.com/khtao/GynoMRFound.git
+cd GynoMRFound
+pip install -r requirements.txt
+git clone https://huggingface.co/khtao/GynoMRFound
+```
+
+## 🚀 Inference with GynoMRFound
+
+Make the necessary modifications to create_feature_data.py to load the necessary data and generate the feature dataset.
+
+```bash
+python create_feature_data.py
+```