W8Yi commited on
Commit
00de015
·
1 Parent(s): ffa1b75

Add dataset card README for TCGA-mini

Browse files
Files changed (1) hide show
  1. README.md +88 -3
README.md CHANGED
@@ -1,3 +1,88 @@
1
- ---
2
- license: mit
3
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: mit
3
+ pretty_name: TCGA-mini
4
+ size_categories:
5
+ - 1K<n<10K
6
+ tags:
7
+ - pathology
8
+ - whole-slide-imaging
9
+ - tcga
10
+ - medical-imaging
11
+ ---
12
+
13
+ # TCGA-mini
14
+
15
+ `TCGA-mini` is a curated whole-slide imaging (WSI) dataset composed of TCGA `.svs` pathology slides.
16
+
17
+ - Number of slides: `1319` (`.svs`)
18
+ - Location in repo: `slides/`
19
+ - Storage footprint on the Hub: about `1.42 TiB` (`1450.94 GiB`, Git LFS-backed)
20
+
21
+ ## Dataset structure
22
+
23
+ ```text
24
+ TCGA-mini/
25
+ ├── README.md
26
+ └── slides/
27
+ ├── TCGA-xxxx-xxxx-xxZ-00-DX1.svs
28
+ └── ...
29
+ ```
30
+
31
+ ## Data format
32
+
33
+ - File type: Aperio whole-slide image files (`.svs`)
34
+ - Naming: Original TCGA-style slide identifiers are preserved
35
+ - Labels/annotations: Not included in this repo
36
+
37
+ ## Download
38
+
39
+ Download all slides:
40
+
41
+ ```bash
42
+ hf download W8Yi/TCGA-mini \
43
+ --repo-type dataset \
44
+ --include "slides/*.svs" \
45
+ --local-dir ./TCGA-mini
46
+ ```
47
+
48
+ Download a single slide:
49
+
50
+ ```bash
51
+ hf download W8Yi/TCGA-mini \
52
+ --repo-type dataset \
53
+ --include "slides/TCGA-06-0743-01Z-00-DX1.svs" \
54
+ --local-dir ./TCGA-mini
55
+ ```
56
+
57
+ ## Quick usage example (OpenSlide)
58
+
59
+ ```python
60
+ from openslide import OpenSlide
61
+
62
+ slide = OpenSlide("TCGA-mini/slides/TCGA-06-0743-01Z-00-DX1.svs")
63
+ print("levels:", slide.level_count)
64
+ print("dimensions:", slide.dimensions)
65
+ ```
66
+
67
+ ## Intended use
68
+
69
+ This dataset is intended for research and educational use in computational pathology and WSI pipelines.
70
+ It is not intended for clinical diagnosis or direct patient care.
71
+
72
+ ## Source and attribution
73
+
74
+ Slides originate from The Cancer Genome Atlas (TCGA) program.
75
+ Users are responsible for complying with all applicable TCGA/GDC data-use and publication policies.
76
+
77
+ ## Limitations
78
+
79
+ - No train/val/test split is provided
80
+ - No labels or clinical tables are included in this repo
81
+ - Whole-slide files are very large and require substantial storage and I/O throughput
82
+
83
+ ## Citation
84
+
85
+ If you use this dataset, please cite:
86
+
87
+ 1. This Hugging Face dataset repository: `W8Yi/TCGA-mini`
88
+ 2. The TCGA program and relevant data source publications