Create README.md
Browse files
README.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: apache-2.0
|
| 3 |
+
language:
|
| 4 |
+
- en
|
| 5 |
+
tags:
|
| 6 |
+
- rag
|
| 7 |
+
- history
|
| 8 |
+
- 20th-century
|
| 9 |
+
- question-answering
|
| 10 |
+
datasets:
|
| 11 |
+
- TinyModels/chronos-wiki-corpus
|
| 12 |
+
---
|
| 13 |
+
|
| 14 |
+
# Chronos 🕰️
|
| 15 |
+
|
| 16 |
+
A retrieval-augmented generation (RAG) bot that answers questions about 20th-century history.
|
| 17 |
+
|
| 18 |
+
## What It Knows
|
| 19 |
+
|
| 20 |
+
- World War I & II
|
| 21 |
+
- The Cold War
|
| 22 |
+
- Major inventions and technological breakthroughs
|
| 23 |
+
- Key political events and figures
|
| 24 |
+
|
| 25 |
+
## How It Works
|
| 26 |
+
|
| 27 |
+
Chronos searches a curated knowledge base of historical Wikipedia articles, then uses a language model to generate answers grounded in those sources. It prefers admitting ignorance over hallucinating.
|
| 28 |
+
|
| 29 |
+
## Usage
|
| 30 |
+
|
| 31 |
+
```python
|
| 32 |
+
from pipeline import Chronos
|
| 33 |
+
bot = Chronos("path/to/model")
|
| 34 |
+
print(bot.ask("What caused World War I?"))
|
| 35 |
+
```
|
| 36 |
+
|
| 37 |
+
The model requires a compatible LLM and tokenizer placed in the same directory.
|
| 38 |
+
|
| 39 |
+
## Built With
|
| 40 |
+
|
| 41 |
+
- FAISS for retrieval
|
| 42 |
+
- Sentence Transformers for embeddings
|
| 43 |
+
- Cross-encoder for answer re-ranking
|
| 44 |
+
|
| 45 |
+
---
|
| 46 |
+
|
| 47 |
+
*Part of the TinyModels collection.*
|