Redme.md file updated according to this system
Browse files
README.md
CHANGED
|
@@ -1,8 +1,6 @@
|
|
| 1 |
# CHFReportGenerator 🫀
|
| 2 |
|
| 3 |
-
An evidence-anchored, research-focused system for automated report generation
|
| 4 |
-
in Congestive Heart Failure (CHF) analysis.
|
| 5 |
-
|
| 6 |
---
|
| 7 |
|
| 8 |
## 🔖 Project at a Glance
|
|
@@ -11,26 +9,20 @@ in Congestive Heart Failure (CHF) analysis.
|
|
| 11 |
- **Primary goal:** Generate clinically grounded and explainable CHF reports
|
| 12 |
- **Focus:** Interpretability, transparency, and reproducibility
|
| 13 |
- **Intended users:** Researchers, PhD evaluators, clinicians (research support)
|
| 14 |
-
|
| 15 |
---
|
| 16 |
|
| 17 |
## ✨ Key Features & Contributions
|
| 18 |
|
| 19 |
- **Evidence-anchored reporting**
|
| 20 |
Every generated finding is explicitly linked to supporting evidence.
|
| 21 |
-
|
| 22 |
- **Clinically grounded narratives**
|
| 23 |
Outputs are written in structured, clinically meaningful language.
|
| 24 |
-
|
| 25 |
- **Parameter-efficient fine-tuning (QLoRA)**
|
| 26 |
Adapts a large language model with minimal computational cost.
|
| 27 |
-
|
| 28 |
- **Research-first design**
|
| 29 |
Built to support academic evaluation and reproducibility.
|
| 30 |
-
|
| 31 |
- **Hardware-efficient**
|
| 32 |
4-bit quantization enables large-model usage on limited GPU resources.
|
| 33 |
-
|
| 34 |
---
|
| 35 |
|
| 36 |
## 🧠 Model Overview
|
|
@@ -40,36 +32,10 @@ in Congestive Heart Failure (CHF) analysis.
|
|
| 40 |
- **Quantization:** 4-bit (BitsAndBytes)
|
| 41 |
- **Framework:** Unsloth
|
| 42 |
- **Maximum sequence length:** 2048 tokens
|
|
|
|
| 43 |
|
| 44 |
The base model provides general reasoning and language understanding,
|
| 45 |
while CHF-specific behavior is introduced through lightweight adapters.
|
| 46 |
-
|
| 47 |
-
---
|
| 48 |
-
|
| 49 |
-
## 🔧 Fine-Tuning Method: QLoRA (Brief)
|
| 50 |
-
|
| 51 |
-
This project uses **QLoRA (Quantized Low-Rank Adaptation)**, which combines:
|
| 52 |
-
|
| 53 |
-
- 4-bit quantization of the base model
|
| 54 |
-
- LoRA-based parameter-efficient fine-tuning
|
| 55 |
-
|
| 56 |
-
### How QLoRA is Applied
|
| 57 |
-
|
| 58 |
-
- The base model is loaded in **4-bit precision**
|
| 59 |
-
- All base model weights remain **frozen**
|
| 60 |
-
- Trainable **LoRA adapters** are introduced
|
| 61 |
-
- Only adapter parameters are updated during training
|
| 62 |
-
|
| 63 |
-
### Why QLoRA?
|
| 64 |
-
|
| 65 |
-
- Enables fine-tuning of a 7B model on limited hardware
|
| 66 |
-
- Preserves general medical and linguistic knowledge
|
| 67 |
-
- Reduces overfitting and hallucination risk
|
| 68 |
-
- Supports reproducible, explainable research
|
| 69 |
-
|
| 70 |
-
QLoRA allows CHF-specific adaptation without retraining the full model,
|
| 71 |
-
making it well-suited for PhD-level experimentation.
|
| 72 |
-
|
| 73 |
---
|
| 74 |
|
| 75 |
## ⚙️ Installation
|
|
|
|
| 1 |
# CHFReportGenerator 🫀
|
| 2 |
|
| 3 |
+
An evidence-anchored, research-focused system for automated Congestive Heart Failure (CHF) analysis that provides diagnostic decision support, clinically grounded report generation, and explainable evidence highlighting supporting regions.
|
|
|
|
|
|
|
| 4 |
---
|
| 5 |
|
| 6 |
## 🔖 Project at a Glance
|
|
|
|
| 9 |
- **Primary goal:** Generate clinically grounded and explainable CHF reports
|
| 10 |
- **Focus:** Interpretability, transparency, and reproducibility
|
| 11 |
- **Intended users:** Researchers, PhD evaluators, clinicians (research support)
|
|
|
|
| 12 |
---
|
| 13 |
|
| 14 |
## ✨ Key Features & Contributions
|
| 15 |
|
| 16 |
- **Evidence-anchored reporting**
|
| 17 |
Every generated finding is explicitly linked to supporting evidence.
|
|
|
|
| 18 |
- **Clinically grounded narratives**
|
| 19 |
Outputs are written in structured, clinically meaningful language.
|
|
|
|
| 20 |
- **Parameter-efficient fine-tuning (QLoRA)**
|
| 21 |
Adapts a large language model with minimal computational cost.
|
|
|
|
| 22 |
- **Research-first design**
|
| 23 |
Built to support academic evaluation and reproducibility.
|
|
|
|
| 24 |
- **Hardware-efficient**
|
| 25 |
4-bit quantization enables large-model usage on limited GPU resources.
|
|
|
|
| 26 |
---
|
| 27 |
|
| 28 |
## 🧠 Model Overview
|
|
|
|
| 32 |
- **Quantization:** 4-bit (BitsAndBytes)
|
| 33 |
- **Framework:** Unsloth
|
| 34 |
- **Maximum sequence length:** 2048 tokens
|
| 35 |
+
- **Fine-Tuning Method:** QLoRA
|
| 36 |
|
| 37 |
The base model provides general reasoning and language understanding,
|
| 38 |
while CHF-specific behavior is introduced through lightweight adapters.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 39 |
---
|
| 40 |
|
| 41 |
## ⚙️ Installation
|