Add comprehensive dataset documentation
Browse files
README.md
CHANGED
|
@@ -1,32 +1,54 @@
|
|
| 1 |
-
|
|
|
|
|
|
|
|
|
|
| 2 |
|
| 3 |
-
|
| 4 |
|
| 5 |
-
|
| 6 |
|
| 7 |
-
|
| 8 |
-
|
| 9 |
-
-
|
| 10 |
-
-
|
| 11 |
-
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 12 |
|
| 13 |
## Usage
|
| 14 |
|
|
|
|
| 15 |
```python
|
| 16 |
-
|
| 17 |
-
|
|
|
|
| 18 |
|
| 19 |
-
#
|
| 20 |
-
|
| 21 |
-
|
|
|
|
|
|
|
| 22 |
|
| 23 |
-
#
|
|
|
|
| 24 |
|
| 25 |
-
|
| 26 |
-
|
| 27 |
-
|
| 28 |
-
|
|
|
|
|
|
|
| 29 |
|
| 30 |
-
##
|
|
|
|
| 31 |
|
| 32 |
-
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: Ray Peat Learning Embeddings
|
| 3 |
+
description: Dense vector embeddings for Ray Peat bioenergetic corpus, generated using sentence-transformers/all-mpnet-base-v2
|
| 4 |
+
---
|
| 5 |
|
| 6 |
+
# Ray Peat Learning Embeddings
|
| 7 |
|
| 8 |
+
This dataset contains dense vector embeddings for the Ray Peat bioenergetic corpus, designed for semantic search and retrieval-augmented generation (RAG) applications.
|
| 9 |
|
| 10 |
+
## Dataset Contents
|
| 11 |
+
|
| 12 |
+
- **embeddings_20250728_221826.npy**: Dense vector embeddings (768-dimensional)
|
| 13 |
+
- **metadata_20250728_221826.json**: Metadata and text content for each embedding
|
| 14 |
+
- **ray_peat_embeddings_20250728_221825.pkl**: Complete embeddings in pickle format
|
| 15 |
+
- **checkpoint.json**: Processing checkpoint information
|
| 16 |
+
- **embedding_report.json**: Generation statistics and metrics
|
| 17 |
+
|
| 18 |
+
## Technical Details
|
| 19 |
+
|
| 20 |
+
- **Embedding Model**: sentence-transformers/all-mpnet-base-v2
|
| 21 |
+
- **Dimensions**: 768
|
| 22 |
+
- **Generation Date**: July 28, 2025
|
| 23 |
+
- **Total Embeddings**: ~18,500+ text segments
|
| 24 |
+
- **Source**: Ray Peat bioenergetic articles and materials
|
| 25 |
|
| 26 |
## Usage
|
| 27 |
|
| 28 |
+
### Download Embeddings
|
| 29 |
```python
|
| 30 |
+
from huggingface_hub import snapshot_download
|
| 31 |
+
import numpy as np
|
| 32 |
+
import json
|
| 33 |
|
| 34 |
+
# Download all files
|
| 35 |
+
local_dir = snapshot_download(
|
| 36 |
+
repo_id="abanwild/peatlearn-embeddings",
|
| 37 |
+
repo_type="dataset"
|
| 38 |
+
)
|
| 39 |
|
| 40 |
+
# Load embeddings
|
| 41 |
+
embeddings = np.load(f"{local_dir}/embeddings_20250728_221826.npy")
|
| 42 |
|
| 43 |
+
# Load metadata
|
| 44 |
+
with open(f"{local_dir}/metadata_20250728_221826.json", "r") as f:
|
| 45 |
+
metadata = json.load(f)
|
| 46 |
+
|
| 47 |
+
print(f"Loaded {len(embeddings)} embeddings with {embeddings.shape[1]} dimensions")
|
| 48 |
+
```
|
| 49 |
|
| 50 |
+
### Integration with PeatLearn
|
| 51 |
+
This dataset is designed to work with the [PeatLearn](https://github.com/thewildofficial/PeatLearn) project. The embeddings enable semantic search across Ray Peat's bioenergetic research.
|
| 52 |
|
| 53 |
+
## License
|
| 54 |
+
This dataset is released under the same license as the PeatLearn project.
|