Update README.md
Browse files
README.md
CHANGED
|
@@ -1,20 +1,3 @@
|
|
| 1 |
-
language:
|
| 2 |
-
- en
|
| 3 |
-
license: apache-2.0
|
| 4 |
-
datasets:
|
| 5 |
-
- hash-map/got_qa_pairs
|
| 6 |
-
library_name: peft
|
| 7 |
-
base_model: google/gemma-2-2b-it
|
| 8 |
-
pipeline_tag: question-answering
|
| 9 |
-
tags:
|
| 10 |
-
- question-answering
|
| 11 |
-
- text-generation
|
| 12 |
-
- got
|
| 13 |
-
- game-of-thrones
|
| 14 |
-
- qlora
|
| 15 |
-
- peft
|
| 16 |
-
- transformers
|
| 17 |
-
inference: false
|
| 18 |
|
| 19 |
# Game of Thrones Q&A Model (PEFT / QLoRA fine-tuned)
|
| 20 |
|
|
@@ -114,19 +97,6 @@ context = retrieve_2_contexts("Who killed Joffrey Baratheon?", token_to_ctx, con
|
|
| 114 |
print(answer_question(context, "Who killed Joffrey Baratheon?"))
|
| 115 |
```
|
| 116 |
|
| 117 |
-
## 🧪 Evaluation
|
| 118 |
-
|
| 119 |
-
*(You should replace these placeholder values with your actual numbers after running evaluation)*
|
| 120 |
-
|
| 121 |
-
| Metric | Value | Notes |
|
| 122 |
-
|-----------------|---------|---------------------------------------|
|
| 123 |
-
| Exact Match (EM)| 0.68 | Strict string match after normalization |
|
| 124 |
-
| F1 Score | 0.79 | Token-level overlap |
|
| 125 |
-
| BLEU | — | Not recommended for this task |
|
| 126 |
-
| ROUGE-L | 0.74 | Useful for longer answers |
|
| 127 |
-
|
| 128 |
-
Evaluation was (or should be) performed on a held-out portion of `hash-map/got_qa_pairs`.
|
| 129 |
-
|
| 130 |
## ⚠️ Bias, Risks & Limitations
|
| 131 |
|
| 132 |
- **Domain limitation:** Extremely poor performance on non-GoT topics
|
|
@@ -144,11 +114,11 @@ Evaluation was (or should be) performed on a held-out portion of `hash-map/got_q
|
|
| 144 |
|
| 145 |
```bibtex
|
| 146 |
@misc{got-qa-gemma2-2026,
|
| 147 |
-
author = {
|
| 148 |
title = {Gemma-2-2b-it Fine-tuned for Game of Thrones Question Answering},
|
| 149 |
year = {2026},
|
| 150 |
publisher = {Hugging Face},
|
| 151 |
-
howpublished = {\url{https://huggingface.co/
|
| 152 |
}
|
| 153 |
```
|
| 154 |
|
|
@@ -159,10 +129,4 @@ Evaluation was (or should be) performed on a held-out portion of `hash-map/got_q
|
|
| 159 |
- `torch` >= 2.1
|
| 160 |
- `bitsandbytes` >= 0.43 (for 4-bit inference if desired)
|
| 161 |
|
| 162 |
-
---
|
| 163 |
-
|
| 164 |
-
Good luck with your model!
|
| 165 |
-
Feel free to update evaluation numbers, add a live demo link (Spaces), upload an inference widget example, or improve the retrieval code when you have time.
|
| 166 |
-
|
| 167 |
-
Replace `your-username` with your actual Hugging Face username.
|
| 168 |
-
If you want even more sections (environmental impact, detailed hyperparameters, etc.), let me know.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
|
| 2 |
# Game of Thrones Q&A Model (PEFT / QLoRA fine-tuned)
|
| 3 |
|
|
|
|
| 97 |
print(answer_question(context, "Who killed Joffrey Baratheon?"))
|
| 98 |
```
|
| 99 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 100 |
## ⚠️ Bias, Risks & Limitations
|
| 101 |
|
| 102 |
- **Domain limitation:** Extremely poor performance on non-GoT topics
|
|
|
|
| 114 |
|
| 115 |
```bibtex
|
| 116 |
@misc{got-qa-gemma2-2026,
|
| 117 |
+
author = {Appala Sai Sumanth},
|
| 118 |
title = {Gemma-2-2b-it Fine-tuned for Game of Thrones Question Answering},
|
| 119 |
year = {2026},
|
| 120 |
publisher = {Hugging Face},
|
| 121 |
+
howpublished = {\url{https://huggingface.co/hash-map/got_model}}
|
| 122 |
}
|
| 123 |
```
|
| 124 |
|
|
|
|
| 129 |
- `torch` >= 2.1
|
| 130 |
- `bitsandbytes` >= 0.43 (for 4-bit inference if desired)
|
| 131 |
|
| 132 |
+
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|