Update README.md
Browse files
README.md
CHANGED
|
@@ -1,31 +1,64 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 3 |
---
|
| 4 |
-
# OmniCult
|
| 5 |
|
| 6 |
-
|
| 7 |
|
| 8 |
-
##
|
|
|
|
|
|
|
|
|
|
|
|
|
| 9 |
|
| 10 |
-
|
| 11 |
|
| 12 |
-
|
| 13 |
-
|
| 14 |
-
|
| 15 |
-
|
|
|
|
| 16 |
|
| 17 |
-
|
| 18 |
|
| 19 |
-
|
| 20 |
-
* **High Fidelity:** Total removal of OCR noise and modern editorial bloat. Original Victorian punctuation and emphasis are preserved to maintain stylistic depth.
|
| 21 |
-
* **Optimized Chunking:** Text segments are precisely balanced (~2,000 tokens) to fit modern transformer context windows.
|
| 22 |
|
| 23 |
-
|
| 24 |
|
| 25 |
-
|
| 26 |
|
| 27 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 28 |
|
| 29 |
-
|
|
|
|
|
|
|
| 30 |
|
| 31 |
-
|
|
|
|
| 1 |
+
# OmniBook
|
| 2 |
+
|
| 3 |
+
OmniBook is a large‑scale, high‑quality English text corpus designed for pre‑training and fine‑tuning language models of any size – from compact 135M parameter models to larger architectures. It collects thousands of complete books from **Project Gutenberg** and other public domain sources, covering the full spectrum of human knowledge, literature, and science.
|
| 4 |
+
|
| 5 |
+
- **Language:** English
|
| 6 |
+
- **Size:** ~25 GB (raw text)
|
| 7 |
+
- **Source:** Project Gutenberg + curated additions
|
| 8 |
+
- **License:** CC BY‑NC‑SA 4.0
|
| 9 |
+
|
| 10 |
---
|
| 11 |
+
|
| 12 |
+
## 📚 Dataset Composition
|
| 13 |
+
|
| 14 |
+
OmniBook is built around **general culture** and includes:
|
| 15 |
+
|
| 16 |
+
- **Complete works**
|
| 17 |
+
- **Historical scientific texts**
|
| 18 |
+
- **Philosophy and political thought**
|
| 19 |
+
- **Poetry, drama, and essays**
|
| 20 |
+
|
| 21 |
+
All texts are **unmodified** from their original Project Gutenberg sources except for:
|
| 22 |
+
- Removal of boilerplate headers/footers
|
| 23 |
+
- Deduplication of near‑identical editions
|
| 24 |
+
|
| 25 |
---
|
|
|
|
| 26 |
|
| 27 |
+
## 🧠 Key Features
|
| 28 |
|
| 29 |
+
### High Fidelity
|
| 30 |
+
- **No OCR noise** – texts are manually proofread by Project Gutenberg volunteers.
|
| 31 |
+
- **Original punctuation and emphasis** preserved (Victorian‑era italics, archaic spelling where intentional).
|
| 32 |
+
|
| 33 |
+
---
|
| 34 |
|
| 35 |
+
## 📊 Example Record
|
| 36 |
|
| 37 |
+
```json
|
| 38 |
+
{
|
| 39 |
+
"text": "It is a truth universally acknowledged, that a single man in possession of a good fortune, must be in want of a wife..."
|
| 40 |
+
}
|
| 41 |
+
```
|
| 42 |
|
| 43 |
+
**🤝 How to Use This Dataset**
|
| 44 |
|
| 45 |
+
```python
|
|
|
|
|
|
|
| 46 |
|
| 47 |
+
from datasets import load_dataset
|
| 48 |
|
| 49 |
+
dataset = load_dataset("OvercastLab/OmniBook", split="train")
|
| 50 |
|
| 51 |
+
```
|
| 52 |
+
Or stream directly (recommended for large‑scale training):
|
| 53 |
+
```python
|
| 54 |
+
dataset = load_dataset("OvercastLab/OmniBook", streaming=True)
|
| 55 |
+
for example in dataset:
|
| 56 |
+
text = example["text"]
|
| 57 |
+
# your training loop
|
| 58 |
+
```
|
| 59 |
|
| 60 |
+
**📈 Future Plans**
|
| 61 |
+
- Add classical Greek and Latin works (in translation)
|
| 62 |
+
- Expand with early 20th‑century scientific journals (public domain)
|
| 63 |
|
| 64 |
+
OmniBook is maintained by OvercastLab. For questions or contributions, please open an issue on the Hugging Face repository.
|