Talayhan commited on
Commit
58af350
·
verified ·
1 Parent(s): 9c63a3f

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +53 -15
README.md CHANGED
@@ -8,25 +8,63 @@ app_file: app.py
8
  pinned: false
9
  ---
10
 
11
- # 🏥 Tıbbi RAG Sistemi: Halüsinasyon Korumalı Arama
12
 
13
- 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.
14
 
15
- ## 🚀 Hızlı Başlangıç
16
 
17
- *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.*
18
 
19
- ```bash
20
- # 1. Kurulum
21
- git clone <repo-url>
22
- cd turkish-medical-rag
23
- pip install -r requirements.txt
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
24
 
25
- # 2. İndeks Oluşturma (Chunking -> Embedding -> ChromaDB)
26
- EMBEDDING_BACKEND=real python src/build_index.py
27
 
28
- # 3. Eşik (Threshold) Analizi
29
- EMBEDDING_BACKEND=real python eval/run_eval.py
 
30
 
31
- # 4. Arama ve Gradio Arayüzü
32
- EMBEDDING_BACKEND=real python app.py
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
8
  pinned: false
9
  ---
10
 
11
+ # 🏥 Türkçe Tıbbi RAG Sistemi: Güvenilir ve Eşik Kontrollü Bilgi Getirimi
12
 
13
+ Bu proje, `umutertugrul/turkish-hospital-medical-articles` veri setindeki tıbbi makaleleri temel alan gelişmiş bir retrieval (bilgi getirimi) sistemidir. Sistemin temel amacı **halüsinasyonu (uydurma bilgi üretimini) engellemektir.** Gelen soruya karşılık veritabanında yeterli benzerlikte (belirlenen eşik değerinin üzerinde) bir bağlam bulunamazsa, sistem "Bu sorunun cevabı dokümanlarımda yer almamaktadır" yanıtını verir ve LLM'e (Büyük Dil Modeli) hiçbir eksik veya yanlış bilgi iletmez.
14
 
15
+ ---
16
 
17
+ ## ⚠️ Geliştirme Süreci ve Kritik Uyarılar
18
 
19
+ Bu projenin temel iskeleti **internete kapalı (offline) bir ortamda** inşa edilmiştir. Hugging Face Hub'a erişim sağlanamadığı için gerçek veri setleri ve modeller indirilmeden geliştirme yapılmıştır. Bu durumun getirdiği bazı gereksinimler şunlardır:
20
+
21
+ * **Offline Test Altyapısı:** Kodun sorunsuz çalıştığından emin olmak adına 6 makaleden oluşan bir **sentetik veri seti** (`data/synthetic_corpus.py`) ve TF-IDF temelli bir **mock (sahte) embedder** kullanılmıştır.
22
+ * **Gerçek Ortam Gereksinimi:** Projeyi eksiksiz kapasitesiyle (gerçek veri seti ve semantik modelle) çalıştırmak için internet bağlantısı olan bir ortama (Google Colab, HF Spaces vb.) ihtiyacınız vardır.
23
+ * **Çalıştırma Parametresi:** Gerçek sistemi ayağa kaldırmak için tüm komutlarda mutlaka `EMBEDDING_BACKEND=real` çevresel değişkeni kullanılmalıdır. Ayrıca `eval/test_questions.json` içindeki sorular, gerçek veritabanı oluştuktan sonra yeniden düzenlenmelidir.
24
+
25
+ ---
26
+
27
+ ## 1. Veri Seti Seçimi ve Hazırlık
28
+
29
+ * **Kullanılan Kaynak:** 14 farklı hastane ve sağlık kurumunun web sitesinden derlenen [`umutertugrul/turkish-hospital-medical-articles`](https://huggingface.co/datasets/umutertugrul/turkish-hospital-medical-articles) veri seti tercih edilmiştir.
30
+ * **Neden Tercih Edildi?** Veri setinin sunduğu kolon yapısı (`url`, `title`, `text`, `__source`), projenin gerektirdiği zorunlu ve opsiyonel metadata alanlarıyla birebir uyuşmaktadır.
31
+ * **Veri Örnekleme:** 14 farklı parquet dosyası `src/data_loader.py` üzerinden birleştirilmekte ve `src/config.py` dosyasındaki `SAMPLE_SIZE` parametresine (varsayılan: 300) göre rastgele örneklere ayrılmaktadır.
32
+
33
+ ## 2. Metin Parçalama (Chunking) Yaklaşımı
34
+
35
+ Makalelerin uzunlukları ve paragraf yapıları çok değişken olduğu için "paragraf bazlı bölme" yerine, sistemin istikrarını artıracak **Sabit Token + Örtüşme (Overlap)** stratejisi benimsenmiştir.
36
+
37
+ * `CHUNK_SIZE_TOKENS = 400`: Embedding modelinin kapasitesi göz önünde bulundurularak, konsept bütünlüğünü bozmayacak en ideal boyut seçilmiştir.
38
+ * `CHUNK_OVERLAP_TOKENS = 80`: Bilginin parçalanma sınırlarında (chunk sınırları) kaybolmaması için yaklaşık %20 oranında bir örtüşme payı bırakılmıştır.
39
+
40
+ *Not: Token sayımları doğrudan kullanılan embedding modelinin (`magibu/embeddingmagibu-200m`) kendi tokenizer'ı ile yapılarak tam uyumluluk sağlanmıştır.*
41
 
42
+ ## 3. Vektör Depolama Mimarisi
 
43
 
44
+ * **Veritabanı:** Ek bir sunucu kurulumu gerektirmeyen, disk tabanlı **ChromaDB** kullanılmıştır.
45
+ * **Mimari Karar:** ChromaDB'nin kendi dahili embedding özellikleri devre dışı bırakılmıştır (`embedding_function=None`). Vektörler `src/embedder.py` üzerinden bağımsız olarak üretilip veritabanına kaydedilir. Bu sayede model ve veritabanı bağımlılıkları birbirinden tamamen izole edilmiştir.
46
+ * **Dışa Aktarım:** Oluşturulan veriler Hugging Face'e yüklenebilecek standartlarda bir parquet dosyasına (`output/turkish_medical_chunks.parquet`) dönüştürülür. Çıktı şu sütunları içerir: `url`, `chunk_text`, `chunk_vector`, `title`, `__source`, `parent_id` ve `chunk_id`.
47
 
48
+ ## 4. Kullanılan Embedding Modeli
49
+
50
+ Semantik arama için **`magibu/embeddingmagibu-200m`** modeli entegre edilmiştir.
51
+ * **Özellikleri:** 768 vektör boyutuna ve 8.192 tokenlık oldukça geniş bir bağlam penceresine (context window) sahiptir.
52
+ * **Tercih Sebebi:** Doğrudan Türkçe diline özel distile edilmiş olması ve TR-MTEB testlerinde arama (retrieval) ile STS görevlerinde yüksek performans sergilemesidir.
53
+
54
+ ## 5. Değerlendirme (Evaluation) ve Eşik (Threshold) Mekanizması
55
+
56
+ Proje içerisinde yer alan `eval/run_eval.py` dosyası, sistemin ne kadar doğru yanıt verdiğini test etmek için 20'si veri setinde olan (pozitif), 10'u olmayan (negatif) toplam 30 soruluk bir test grubunu (`eval/test_questions.json`) kullanır.
57
+
58
+ Sistem, 0.05 ile 0.95 arasındaki eşik (threshold) değerlerini tarayarak bir **Confusion Matrix (Karmaşıklık Matrisi)** çıkarır. Tıbbi uygulamalarda "yanlış bilgi uydurmak (False Positive)", "bilinen bir cevabı verememekten (False Negative)" çok daha risklidir. Bu nedenle ideal eşik değeri, F1 skorunu maksimize eden aynı zamanda False Positive oranını minimize eden nokta olarak belirlenir.
59
+
60
+ **Önemli:** Mock (TF-IDF) ortamında belirlenen ideal eşik değeri ile gerçek embedding modelinin üreteceği kosinüs (cosine) benzerlik skorları tamamen farklı dağılımlar gösterecektir. Gerçek modelle değerlendirme script'i çalıştırıldıktan sonra, çıkan yeni ideal oran `src/config.py` içerisindeki `SIMILARITY_THRESHOLD` değerine manuel olarak girilmelidir.
61
+
62
+ ---
63
+
64
+ ## 🚀 Hızlı Kurulum ve Kullanım Rehberi
65
+
66
+ Projeyi bilgisayarınıza indirin ve gerekli kütüphaneleri kurun:
67
+ ```bash
68
+ git clone <bu-repo>
69
+ cd turkish-medical-rag
70
+ pip install -r requirements.txt