update README

README.md

@@ -1,3 +1,59 @@
----
-license: mit
----
+---
+license: mit
+---
+
+# Structure of Data
+
+The overal structure is as follows:
+```
+full_models
+  ├── CIFAR10
+  ├── CIFAR10_augmented
+  └── LIVING17
+oracles
+└── CIFAR10
+    ├── forget_set_1
+    ├── forget_set_2
+    ├── forget_set_3
+    ├── forget_set_4
+    ├── forget_set_5
+    ├── forget_set_6
+    ├── forget_set_7
+    ├── forget_set_8
+    ├── forget_set_9
+    └── forget_set_10
+```
+Each folder has 
+
+* train_logits_##.pt - logits at the end of training for model `##` for validation points
+* val_logits_##.pt  - logits at the end of training for model `##` for train points
+* `##__val_margins_#.npy` - margins of model `##` at epoch `#` (this is derived from logits)
+* `sd_##____epoch_#.pt` - model `##` checkpoint at epoch `#`
+
+
+# How to download
+
+
+
+Create script `download_folder.sh`
+
+```
+#!/bin/bash
+REPO_URL=https://huggingface.co/datasets/royrin/KLOM-models
+TARGET_DIR=KLOM-models # name it what you wish
+FOLDER=$1  # e.g., "oracles/CIFAR10/forget_set_3"
+
+mkdir -p $TARGET_DIR
+
+git clone --filter=blob:none --no-checkout $REPO_URL $TARGET_DIR
+cd $TARGET_DIR
+git sparse-checkout init --cone
+git sparse-checkout set $FOLDER
+git checkout main
+```
+
+Example how to run script:
+```
+bash download_folder.sh oracles/CIFAR10/forget_set_3
+```
+