Update README.md

README.md

@@ -8,268 +8,25 @@ app_file: app.py
 pinned: false
 ---
 
-# 🏥 Türkçe Tıbbi Doküman RAG Sistemi — Eşik Kontrollü Semantik Arama
+# 🏥 Tıbbi RAG Sistemi: Halüsinasyon Korumalı Arama
 
-`umutertugrul/turkish-hospital-medical-articles` veri setinden chunk'lanmış Türkçe
-tıbbi makaleler üzerinde çalışan, **halüsinasyonu threshold ile engelleyen** bir
-retrieval sistemi. Sorunun cevabı doküman kümesinde yoksa (benzerlik skoru eşiğin
-altındaysa) sistem "Bu sorunun cevabı dokümanlarımda yer almamaktadır" der ve LLM'e
-hiç bağlam göndermez.
+Bu proje, Türkçe tıbbi dokümanlar üzerinde çalışan ve **eşik değeri (threshold)** kullanarak LLM'lerin uydurma (halüsinasyon) yapmasını engelleyen bir RAG sistemidir. Aranan cevap veritabanında belirli bir benzerlik skorunun altındaysa, sistem "cevap yok" döner ve LLM'e yanıltıcı bir bağlam göndermez.
 
----
-
-## ⚠️ Önemli Not: Bu Repo Nasıl Hazırlandı
-
-Bu depoyu hazırladığım geliştirme ortamında **Hugging Face Hub'a ağ erişimi
-yoktu** (gerçek veri setini indiremedim, gerçek embedding modelini çalıştıramadım).
-Bu yüzden:
-
-- Tüm kod **gerçek veri seti ve gerçek embedding modeliyle çalışacak şekilde**
-  yazıldı (`EMBEDDING_BACKEND=real`).
-- Kodun uçtan uca **doğru çalıştığını kanıtlamak için**, gerçek şemayı taklit eden
-  6 makalelik küçük bir **sentetik korpus** (`data/synthetic_corpus.py`) ve
-  TF-IDF tabanlı bir **mock embedder** (`EMBEDDING_BACKEND=mock`) kullanılarak
-  pipeline baştan sona test edildi — chunking, ChromaDB'ye yazma, arama,
-  threshold sweep, 30 soruluk eval dahil. Sonuçlar `eval/eval_results.md`'de.
-- **Gerçek teslim için** `EMBEDDING_BACKEND=real` ile `python src/build_index.py`
-  komutunu internet erişimi olan bir ortamda (Colab, kendi makineniz, HF Space)
-  çalıştırmanız ve `eval/test_questions.json`'daki soruları gerçek veri setinden
-  gelen gerçek chunk içeriğine göre güncellemeniz gerekiyor (aşağıda adım adım
-  anlatılıyor).
-
----
-
-## 1) Veri Seti ve Örnekleme
-
-- **Kaynak:** [`umutertugrul/turkish-hospital-medical-articles`](https://huggingface.co/datasets/umutertugrul/turkish-hospital-medical-articles)
-  — 14 hastane/sağlık kuruluşunun web sitesinden toplanmış Türkçe tıbbi makaleler.
-- **Neden bu veri seti?** Şeması (`url`, `title`, `text`, `__source`) ödevin
-  istediği zorunlu (`url`) ve önerilen opsiyonel (`title`, `__source`) sütunlarla
-  birebir örtüşüyor, ek dönüştürme gerektirmiyor.
-- **Örnekleme:** `src/config.py::SAMPLE_SIZE` ile kontrol edilir (varsayılan 300,
-  100-1.000 aralığında). `src/data_loader.py::load_articles()` tüm 14 parquet
-  dosyasını birleştirip `random.Random(seed).sample()` ile rastgele örnekler.
-
-## 2) Chunking Stratejisi: Sabit Token Sayısı + Overlap
-
-**Neden bu yöntem?**
-- Paragraf bazlı (`\n\n`) bölme, kaynak makalelerin paragraf uzunluklarına bağımlı
-  kalır — bazı makalelerde tek bir dev paragraf, bazılarında çok kısa paragraflar
-  olabilir, bu da embedding kalitesini tutarsızlaştırır.
-- Semantik chunking daha iyi sonuç verebilir ama ek bir model/karmaşıklık
-  gerektirir; bu ödev kapsamında (100-1000 makale, sınırlı süre) kontrolü kolay,
-  öngörülebilir ve **embedding modelinin gerçekte işlediği birimle (token)
-  birebir eşleşen** sabit-token yaklaşımı tercih edildi.
-- **Overlap (80 token)**, bir cümle/bilginin chunk sınırında ikiye bölünüp
-  anlamının kaybolmasını önler — chunk sonundaki bağlamın bir kısmı bir sonraki
-  chunk'ın başında tekrar eder.
-
-**Parametreler** (`src/config.py`):
-```python
-CHUNK_SIZE_TOKENS = 400      # embedding modelinin 8192 token context'ine göre
-                              # rahat, ama tek konuya odaklı chunk'lar üretecek
-                              # kadar küçük
-CHUNK_OVERLAP_TOKENS = 80    # chunk_size'ın ~%20'si — yaygın pratik
-```
-
-**Tokenizer:** Chunk boyutu, embedding modelinin **kendi tokenizer'ı**
-(`AutoTokenizer.from_pretrained("magibu/embeddingmagibu-200m")`) ile sayılır
-(`src/chunking.py::get_tokenizer`). Böylece "400 token" hem chunking'de hem
-embedding'de aynı anlama gelir. Gerçek tokenizer indirilemediğinde (offline
-test) basit bir whitespace tokenizer'a düşülür — bu durum log'da açıkça belirtilir.
-
-İmplementasyon: `src/chunking.py::chunk_text()` — token dizisini `step = chunk_size
-- overlap` adımlarıyla kaydırarak diliyor, her dilim `tokenizer.decode()` ile
-tekrar metne çevriliyor. Doğruluğu `tests/test_chunking.py` ile test edildi
-(overlap'in gerçekten örtüştüğü, kısa metinlerin tek chunk kaldığı, metadata'nın
-korunduğu doğrulandı — 4/4 test geçti).
-
-## 3) Vektör Veritabanı Şeması ve Mimarisi
-
-**Seçim: ChromaDB** (dosya tabanlı, `PersistentClient`, ek sunucu gerektirmez).
-
-**Önemli tasarım kararı:** Chroma'nın kendi embedding fonksiyonu **kullanılmaz**
-(`embedding_function=None` mantığı) — embedding'ler her zaman `src/embedder.py`
-tarafından ayrı üretilip Chroma'ya hazır vektör olarak verilir. Bu, "vektör
-veritabanı" (nerede saklanır/aranır) ile "embedding modeli" (vektör nasıl
-üretilir) kararlarını birbirinden bağımsız tutar — ödev talimatında da özellikle
-vurgulanan ayrım.
-
-**Çıktı — HF Dataset'e yüklenebilir parquet** (`output/turkish_medical_chunks.parquet`),
-zorunlu 3 sütun + opsiyonel metadata:
-
-| Sütun | Açıklama |
-|---|---|
-| `url` | Chunk'ın ait olduğu makalenin kaynak linki |
-| `chunk_text` | Parçalanmış metin |
-| `chunk_vector` | 768 boyutlu (gerçek modelde) float listesi |
-| `title` | Makale başlığı (opsiyonel metadata) |
-| `__source` | Kaynak hastane (opsiyonel metadata) |
-| `parent_id` | Chunk'ın ait olduğu makalenin index'i (parent-child ilişkisi) |
-| `chunk_id` | `{parent_id}_{chunk_index}` formatında benzersiz id |
-
-## 4) Embedding Modeli
-
-**Seçim: `magibu/embeddingmagibu-200m`** (önerilen model).
-
-- **Boyut:** 768 (ℓ₂-normalize edilmiş).
-- **Context window:** 8.192 token — uzun makaleleri chunk'lamadan önce
-  endişelenmeden büyük chunk boyutları (400 token) seçebilmemizi sağladı.
-- **Neden bu model?** Türkçe'ye özel distile edilmiş (152M/200M parametre),
-  TR-MTEB benchmark'ında (STS, retrieval, NLI görevlerinde) rekabetçi skorlar
-  veriyor, `sentence-transformers` ile tek satırda kullanılabiliyor:
-  ```python
-  from sentence_transformers import SentenceTransformer
-  model = SentenceTransformer("magibu/embeddingmagibu-200m", trust_remote_code=True)
-  vectors = model.encode(texts, normalize_embeddings=True)  # (N, 768)
-  ```
-- Gerçek kullanım `src/embedder.py::RealEmbedder` sınıfında implemente edildi.
-
-**Offline test (mock) backend:** Bu geliştirme ortamında modele erişilemediği
-için, `src/embedder.py::MockEmbedder` TF-IDF tabanlı deterministik bir embedder
-sağlar — gerçek semantik bir model DEĞİLDİR, sadece pipeline'ın (chunking ->
-embedding -> ChromaDB -> arama -> threshold) uçtan uca doğru çalıştığını
-kanıtlamak için kullanılmıştır (bkz. aşağıdaki eval sonuçları).
-
-## 5) Test Veri Seti (30 Soru) ve Değerlendirme
-
-📄 [`eval/test_questions.json`](eval/test_questions.json) — 20 pozitif + 10 negatif soru.
-
-⚠️ **Bu dosyadaki sorular ÖRNEK/PLACEHOLDER'dır** — 6 makalelik sentetik
-korpusa göre yazıldı (offline test için). **Gerçek teslimde**, `output/
-turkish_medical_chunks.parquet`'i gerçek veri setiyle ürettikten sonra, bu
-dosyayı gerçek chunk içeriğinden alınan 20 pozitif + veri setinde kesinlikle
-geçmeyen 10 negatif soruyla güncellemeniz gerekir.
-
-**Format:**
-```json
-{"id": "p01", "type": "positive", "question": "...", "expected_source_url": "https://..."}
-{"id": "n01", "type": "negative", "question": "..."}
-```
-
-## 6) Eşik (Threshold) Analizi
-
-`eval/run_eval.py`, 30 soruyu çalıştırıp **threshold sweep** yapar (0.05'ten
-0.95'e kadar 0.05 adımlarla), her adımda confusion matrix (TP/FN/TN/FP) ve
-accuracy/precision/recall/F1 hesaplar; en iyi F1'i veren threshold'u önerir.
-Tam tablo: [`eval/eval_results.md`](eval/eval_results.md).
+## 🚀 Hızlı Başlangıç
 
-**Mock backend ile elde edilen örnek sonuç** (sadece offline pipeline testi,
-gerçek model ile YENİDEN ÇALIŞTIRILMALI):
-
-| Threshold | TP | FN | TN | FP | Accuracy | Precision | Recall | F1 |
-|---|---|---|---|---|---|---|---|---|
-| 0.05 | 20 | 0 | 5 | 5 | 0.833 | 0.800 | 1.000 | 0.889 |
-| **0.10** | **18** | **2** | **8** | **2** | **0.867** | **0.900** | **0.900** | **0.900** |
-| 0.15 | 11 | 9 | 10 | 0 | 0.700 | 1.000 | 0.550 | 0.710 |
-| 0.20 | 5 | 15 | 10 | 0 | 0.500 | 1.000 | 0.250 | 0.400 |
-
-- **Retrieval doğruluğu** (pozitif sorularda doğru kaynak makalenin bulunması): 18/20.
-- **Threshold=0.10 seçildi** çünkü en yüksek F1'i (0.900) veriyor: 2 negatif soru
-  hâlâ yanlışlıkla "yanıtlanıyor" (FP) ve 2 pozitif soru yanlışlıkla reddediliyor
-  (FN) — ama toplamda en dengeli nokta burası. Threshold'u 0.05'e çekmek recall'ı
-  1.0'a çıkarır ama FP sayısını (halüsinasyon riskini) artırır; 0.15'e çıkarmak
-  FP'yi sıfırlar ama pozitif sorularda cevap verme oranını (recall) düşürür.
-  Bu, klasik **precision-recall trade-off**'udur; tıbbi bir sistemde
-  "yanlışlıkla uydurma cevap verme" (FP) riski, "bilinen bir cevabı reddetme"
-  (FN) riskinden genelde daha maliyetli kabul edilir — bu yüzden FP=0 olan
-  0.15 gibi biraz daha muhafazakâr bir threshold da savunulabilir bir seçimdir.
-
-**⚠️ Gerçek embedding modeliyle mutlaka yeniden çalıştırın:** TF-IDF cosine
-skorları (0.0-0.3 aralığında) ile gerçek sentence-embedding cosine skorları
-(genellikle 0.4-0.8 aralığında) çok farklı dağılımlara sahiptir. `EMBEDDING_
-BACKEND=real python eval/run_eval.py` çalıştırıldığında tamamen farklı (muhtemelen
-çok daha yüksek) bir threshold önerilecektir — `src/config.py::SIMILARITY_
-THRESHOLD` bu yeni değere göre güncellenmelidir.
-
----
-
-## 7) Kurulum ve Çalışt��rma
+*Not: Proje çevrimdışı (offline) test edilebilmesi için mock (sahte) verilerle geliştirilmiştir. Gerçek veri ve modellerle çalışmak için internet bağlantısı gereklidir ve tüm komutlar `EMBEDDING_BACKEND=real` değişkeni ile çalıştırılmalıdır.*
 
 ```bash
-git clone <bu-repo>
+# 1. Kurulum
+git clone <repo-url>
 cd turkish-medical-rag
 pip install -r requirements.txt
-```
-
-### Adım 1 — Index oluştur (chunking + embedding + ChromaDB + parquet export)
 
-```bash
-# Hızlı/offline test (sentetik veri + TF-IDF mock embedder):
-EMBEDDING_BACKEND=mock python src/build_index.py
-
-# GERÇEK teslim (internet + GPU önerilir):
+# 2. İndeks Oluşturma (Chunking -> Embedding -> ChromaDB)
 EMBEDDING_BACKEND=real python src/build_index.py
-```
-
-Çıktılar: `chroma_db/` (vektör veritabanı) ve `output/turkish_medical_chunks.parquet`
-(HF Dataset'e yüklenecek dosya).
-
-### Adım 2 — Eval / threshold analizi çalıştır
 
-```bash
+# 3. Eşik (Threshold) Analizi
 EMBEDDING_BACKEND=real python eval/run_eval.py
-```
-
-Çıktı: konsola threshold sweep tablosu + `eval/eval_results.md` raporu.
-Önerilen threshold'u `src/config.py::SIMILARITY_THRESHOLD`'a yazın.
-
-### Adım 3 — Arama / demo
-
-```bash
-# Komut satırından hızlı test:
-EMBEDDING_BACKEND=real python src/search.py
-
-# Gradio arayüzü:
-EMBEDDING_BACKEND=real python app.py
-```
-
-### Testler
-
-```bash
-python tests/test_chunking.py
-```
-
----
-
-## 8) Proje Yapısı
-
-```
-turkish-medical-rag/
-├── app.py                       # Gradio arayüzü (retrieval + threshold demosu)
-├── src/
-│   ├── config.py                 # Tüm parametreler (chunk size, threshold, model id'leri)
-│   ├── data_loader.py             # HF dataset yükleme (+ offline sentetik fallback)
-│   ├── chunking.py                # Sabit token + overlap chunking
-│   ├── embedder.py                # RealEmbedder (magibu) + MockEmbedder (TF-IDF, offline test)
-│   ├── vector_store.py            # ChromaDB wrapper
-│   ├── build_index.py             # Ana pipeline (load->chunk->embed->store->export)
-│   └── search.py                  # Sorgu + threshold kararı + "cevap yok" mantığı
-├── data/
-│   └── synthetic_corpus.py        # SADECE offline test için 6 makalelik sentetik korpus
-├── eval/
-│   ├── test_questions.json        # 30 test sorusu (20 pozitif + 10 negatif) — ÖRNEK
-│   ├── run_eval.py                # Threshold sweep + confusion matrix + rapor
-│   └── eval_results.md            # (üretilir) eval sonuçları
-├── tests/
-│   └── test_chunking.py           # Chunking birim testleri
-├── requirements.txt
-├── .gitignore
-└── README.md
-```
-
-## 9) Sonraki Adım: LLM'e Bağlama
-
-Bu repo asıl olarak **retrieval + threshold** mekanizmasını (ödevin odak
-noktası) implemente ediyor. Bir sohbet asistanına bağlamak için:
-
-```python
-from src.search import RAGSearcher, format_answer_for_llm
-
-searcher = RAGSearcher()
-result = searcher.search(kullanici_sorusu)
-context = format_answer_for_llm(result)  # threshold altındaysa direkt ret mesajı döner
 
-# context'i bir LLM'in sistem promptuna ekleyip "SADECE bu bağlama dayanarak
-# cevap ver, bağlamda yoksa uydurma" talimatı vermek yeterli.
-```
+# 4. Arama ve Gradio Arayüzü
+EMBEDDING_BACKEND=real python app.py