thanminh01 commited on
Commit
0b95a19
·
verified ·
1 Parent(s): c37b086

Add dataset README: embeddings vs Run-Information layout

Browse files
Files changed (1) hide show
  1. README.md +80 -0
README.md ADDED
@@ -0,0 +1,80 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ pretty_name: WSI_Embedding
3
+ task_categories:
4
+ - feature-extraction
5
+ size_categories:
6
+ - 1K<n<10K
7
+ ---
8
+
9
+ # WSI_Embedding
10
+
11
+ Patch and slide embeddings for whole-slide images, plus the run records used to produce them.
12
+
13
+ **Original WSIs are not in this repo.** They stay on HPC / the source dataset remotes. Do not expect `.svs` / `.tif` here.
14
+
15
+ Repo: [`thanminh01/WSI_Embedding`](https://huggingface.co/datasets/thanminh01/WSI_Embedding)
16
+
17
+ ## Top-level layout
18
+
19
+ | Path | What it is | Download when |
20
+ |---|---|---|
21
+ | `embeddings/<dataset>/<model>/<mag>x_<patch>px_<overlap>px_overlap/` | Encoder tensors (`.h5` / `.pt` / WSI-LLaVA json) and per-model TRIDENT `_config_` / `_logs_` | You need features |
22
+ | `Run-Information/runs-report/<dataset>/` | Job logs, VALIDATION, SLURM, perf, TRIDENT `runs/*.json`, cohort CSVs | You need provenance |
23
+ | `Run-Information/prep/<dataset>/` | Contours, geojson, thumbnails, `wsi_states`, patch-coord h5 `(N,2)`, overlay jpgs | You need QC / failed-mask / tiny-slide evidence |
24
+ | `Run-Information/parked/<dataset>/` | Encoder files for slides excluded from the official cohort | You need the parked cases |
25
+
26
+ Selective download: pull only `embeddings/DHMC-LUAD/titan/...` or only `Run-Information/prep/TCGA-LUAD`.
27
+
28
+ ## Datasets
29
+
30
+ ### DHMC-LUAD (encoder cohort 143)
31
+
32
+ There are **two HPC job directories**. They are **not** duplicates of the same run:
33
+
34
+ | Hub name | HPC folder | Role |
35
+ |---|---|---|
36
+ | `DHMC-LUAD` | `runs-information/full-int-DHMC-LUAD/` | Canonical shared coords + later encoders (Virchow/PRISM/KEEP/MUSK/WSI-LLaVA/PRISM2, MUSK 1024-d redo) |
37
+ | `DHMC-LUAD-TITAN-CONCH` | `runs-information/full-int-DHMC-LUAD (TITAN CONCH)/` | First encoder pack: TITAN + CONCH v1.5 / v1 at 20×/512 |
38
+
39
+ Use `DHMC-LUAD` for current coords, masks, and later-model logs. Use `DHMC-LUAD-TITAN-CONCH` for the original TITAN/CONCH job (SLURM 15450381 / 15450382).
40
+
41
+ Kept encoders (see per-model folders under `embeddings/DHMC-LUAD/`): TITAN 768, CONCH v1.5 768, CONCH v1 512, Virchow 2560, PRISM 1280, Virchow2 2560, Virchow2 CLS 1280, PRISM2, KEEP 768, MUSK **1024-d vision CLS** (`ms_aug=False`, no CLIP head in the stored tensor), WSI-LLaVA captions + case-bank. GigaPath tiles at 512 exist only as the WSI-LLaVA tile encoder, not as an official GigaPath product.
42
+
43
+ ### TCGA-LUAD (encoder cohort 531)
44
+
45
+ 531 diagnostic slides after parking **10 TCGA-05 DX1** cases (tiny GDC canvas + failed tissue mask). Those 10 are **not** in `embeddings/` tensors (except leftovers under `parked/`). Their `wsi_states`, thumbnails, contours, and coords **are** in `Run-Information/prep/TCGA-LUAD/` so the failure stays inspectable.
46
+
47
+ Tensors for TCGA-LUAD may still be landing on HPC; this `Run-Information` tree is uploaded independently.
48
+
49
+ ### TCGA-LUSC
50
+
51
+ Not in this `Run-Information` snapshot: prep was still writing on the cluster at upload time. Encoder tensors are not published yet.
52
+
53
+ ## Canonical mag / patch
54
+
55
+ | Models | Setting |
56
+ |---|---|
57
+ | TITAN, CONCH v1.5, CONCH v1, WSI-LLaVA | 20× / 512 |
58
+ | PRISM, Virchow, Virchow2, Virchow2 CLS, PRISM2 | 20× / 224 |
59
+ | KEEP | 20× / 256 |
60
+ | MUSK | 20× / 384 |
61
+
62
+ ## How to download
63
+
64
+ ```bash
65
+ # tensors only, one model
66
+ huggingface-cli download thanminh01/WSI_Embedding \
67
+ --repo-type dataset \
68
+ --include "embeddings/DHMC-LUAD/titan/**"
69
+
70
+ # QC / logs only
71
+ huggingface-cli download thanminh01/WSI_Embedding \
72
+ --repo-type dataset \
73
+ --include "Run-Information/**"
74
+ ```
75
+
76
+ ## What is intentionally absent
77
+
78
+ - Original whole-slide images
79
+ - HPC `runs-information/full-int-*/features_*` trees (those tensors live under `embeddings/` so they are not uploaded twice)
80
+ - `TCGA-LUSC` run snapshot while segmentation/coords were still in flight