GLEASON_CNN / README.md
yasintuncer
Add README.md for dataset preparation helpers and usage instructions
ca13212
# Dataset Preparation Helpers
Bu repodaki dosyalar, **Gleason_CNN** histopatoloji verisetini [histopathai](https://github.com/histopathai) platformuna yüklemek için kullanılan yardımcı araçlardır.
## Kaynak Verisi
**Gleason_CNN** — Prostate cancer TMA dataset with Gleason annotation masks
Harvard Dataverse: https://dataverse.harvard.edu/dataset.xhtml?persistentId=doi:10.7910/DVN/OCYCMP
DOI: `10.7910/DVN/OCYCMP`
Lisans: CC-BY-4.0
**Atıf:**
> Arvaniti, E., Fricker, K.S., Moret, M., Rupp, N., Hermanns, T., Fankhauser, C., Stenner, F., Umbehr, M., Rodrigues-Pita, F.A., Wild, P., Rueschoff, J.H., Claassen, M. (2018).
> *Automated Gleason grading of prostate cancer tissue microarrays via deep learning.*
> Scientific Reports, 8, 12054. https://doi.org/10.1038/s41598-018-30535-1
## Dosyalar
| Dosya | Açıklama |
|---|---|
| `unzip-files.py` | `dataverse_files.zip` içeriğini `origin/` dizinine açar (görüntüler + maskler). |
| `extract_polygons.py` | Palette PNG masklerden polygon koordinatlarını çıkarır, `polygons.csv` oluşturur. Mask indeksleri: 0=Benign, 1=G3, 2=G4, 3=G5, 4=unlabelled (atlanır). |
| `validate_polygons.py` | Polygon CSV'sini doğrular ve orijinal patch üzerine çizilmiş görsel karşılaştırmalar üretir. |
| `dataset_creator.ipynb` | Ham görüntü ve annotation verilerinden `DatasetBuilder` ile JSON tabanlı dataset yapısı oluşturur. Workspace, Patient, Image ve Annotation entity'lerini tanımlar. |
| `upload_dataset.ipynb` | EDA yaparak TMA-dengeli %10 alt küme seçer (seed=42), ardından `IngestPipeline` ile işlenmiş slide'ları GCS'e ve metadata'yı Firestore'a yükler. |
| `polygons.csv` | `extract_polygons.py` çıktısı — image başına polygon koordinatları ve etiketleri. |
## Ön Koşullar
### 1. `histopathai` Paketi
`dev-ingestor` reposundan paketi yükleyin:
```bash
pip install -e /path/to/dev-ingestor
# cloud bağımlılıklarıyla birlikte:
pip install -e "/path/to/dev-ingestor[cloud]"
```
### 2. Ek Bağımlılıklar
```bash
pip install pyvips pandas matplotlib tqdm Pillow
```
### 3. Environment Değişkenleri
`upload_dataset.ipynb` çalıştırılmadan önce notebook içindeki aşağıdaki değerlerin doldurulmuş olması gerekir:
| Değişken | Açıklama |
|---|---|
| `SA_KEY_PATH` | GCP service account JSON dosyasının yolu |
| `PROJECT_ID` | Google Cloud proje ID'si |
| `PROC_BUCKET` | İşlenmiş slide'ların yükleneceği GCS bucket adı |
| `DB_NAME` | Firestore veritabanı adı (varsayılan: `"(default)"`) |
## Akış
```
Gleason_CNN (Harvard Dataverse)
│ dataverse_files.zip
unzip-files.py → origin/ (JPG görüntüler + palette PNG maskler)
extract_polygons.py → polygons.csv
validate_polygons.py → görsel doğrulama (isteğe bağlı)
dataset_creator.ipynb → JSON dataset yapısı (Workspace / Patient / Image / Annotation)
upload_dataset.ipynb → GCS + Firestore (IngestPipeline)
```