Upload folder using huggingface_hub

README.md

@@ -35,6 +35,67 @@ To help bridge the gap between experimental affinity measurements and computatio
 
 Each dataset captures the results of a yeast mating experiment between two protein libraries—one of binders and one of targets. Detailed experimental context and metadata are provided in the accompanying data cards.
 
+## Quickstart
+
+Load one dataset:
+
+```python
+# Replace with the specific experiment ID you want to load
+from datasets import load_dataset
+ds = load_dataset("aalphabio/public_data_temp", "YM_0549", split="all")
+# From here, cast it to pandas / polars dataframe for analysis if desired
+df = ds.to_pandas()
+
+# ...or load directly with pandas
+import pandas as pd
+ym_id = "YM_0549"
+df = pd.read_parquet(f"hf://datasets/aalphabio/public_data_temp/data/{ym_id}/data.parquet")
+print(df)
+```
+
+Fetch multiple experiments at once:
+
+```python
+from datasets import concatenate_datasets
+
+repo = "aalphabio/public_data_temp"
+cfgs = ["YM_0549", "YM_1068"]
+
+# adds a column for the experiment id
+datasets = [
+    ds.add_column("experiment", [cfg] * len(ds))
+    for ds, cfg in zip(datasets, cfgs)
+]
+combined = concatenate_datasets(datasets)
+print(combined)
+```
+
+Use different experiments for modeling splits:
+
+```python
+from datasets import DatasetDict
+
+ds = DatasetDict({
+    "train": load_dataset(repo, "YM_0693", split="all"),
+    "test": load_dataset(repo, "YM_0988", split="all"),
+})
+print(ds)
+```
+
+## Experiment glossary
+
+| YM ID | Description |
+|:--------|:-------------|
+| YM_0005 | Anti-CoV Ab Panel x CoV2-RBD Mutagenesis |
+| YM_0549 | VHH72 Optimization Variants Iter0 x CoV2-RBD |
+| YM_1068 | VHH72 Optimization Variants Iter1 x CoV2-RBD |
+| YM_0693 | PP489 Optimization Variants Iter0 x TIGIT |
+| YM_0988 | PP489 Optimization Variants Iter1 x TIGIT |
+| YM_0852 | Pembrolizumab-scFv Optimiziation Variants Iter0 x PD-1 |
+| YM_0985 | Pembrolizumab-scFv Optimiziation Variants Iter1 x PD-1 |
+| YM_0989 | Trastuzumab-scFv CDR3 Optimization Variants Iter0 x HER-2 |
+| YM_0990 | Trastuzumab-scFv CDR+FW Optimization Variants Iter0 x HER-2 |
+
 ## Dataset schema
 
 | Column | Description |

data/YM_0988/README.md

@@ -1,4 +1,4 @@
-# PP489 Optimization Variants Iter0 x TIGIT (YM_0988)
+# PP489 Optimization Variants Iter1 x TIGIT (YM_0988)
 
 ## Overview
 

data/YM_0989/README.md

@@ -1,4 +1,4 @@
-# Trastuzumab scFv CDR3 Optimization Variants Iter0 x HER-2 (YM_0989)
+# Trastuzumab-scFv CDR3 Optimization Variants Iter0 x HER-2 (YM_0989)
 
 ## Overview
 

data/YM_0990/README.md

@@ -1,4 +1,4 @@
-# Trastuzumab scFv CDR+FW Optimization Variants Iter0 x HER-2 (YM_0990)
+# Trastuzumab-scFv CDR+FW Optimization Variants Iter0 x HER-2 (YM_0990)
 
 ## Overview