Add dataset card for QuCo-RAG BM25 index
Browse filesHi, I'm Niels, part of the community science team at Hugging Face. I've added a dataset card for the QuCo-RAG Elasticsearch data archive. This PR includes:
- Relevant metadata including the `text-retrieval` task category.
- Links to the [associated paper](https://huggingface.co/papers/2512.19134) and the [official GitHub repository](https://github.com/ZhishanQ/QuCo-RAG).
- Usage instructions based on the GitHub documentation to help researchers set up the retrieval environment quickly.
- A BibTeX citation for the paper.
README.md
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
task_categories:
|
| 3 |
+
- text-retrieval
|
| 4 |
+
tags:
|
| 5 |
+
- RAG
|
| 6 |
+
- Elasticsearch
|
| 7 |
+
- BM25
|
| 8 |
+
- Wikipedia
|
| 9 |
+
---
|
| 10 |
+
|
| 11 |
+
# QuCo-RAG Elasticsearch Data Archive
|
| 12 |
+
|
| 13 |
+
This repository contains the pre-built BM25 index (for Elasticsearch) of the Wikipedia dump used in the paper [QuCo-RAG: Quantifying Uncertainty from the Pre-training Corpus for Dynamic Retrieval-Augmented Generation](https://huggingface.co/papers/2512.19134).
|
| 14 |
+
|
| 15 |
+
- **GitHub Repository:** [https://github.com/ZhishanQ/QuCo-RAG](https://github.com/ZhishanQ/QuCo-RAG)
|
| 16 |
+
- **Paper:** [QuCo-RAG: Quantifying Uncertainty from the Pre-training Corpus for Dynamic Retrieval-Augmented Generation](https://huggingface.co/papers/2512.19134)
|
| 17 |
+
|
| 18 |
+
## Introduction
|
| 19 |
+
|
| 20 |
+
QuCo-RAG is a dynamic Retrieval-Augmented Generation (RAG) framework that adaptively determines when to retrieve during generation by quantifying uncertainty grounded in the pre-training corpus. This archive provides a pre-built BM25 index of approximately 21 million Wikipedia passages, allowing researchers to skip the time-consuming indexing process and quickly set up the retrieval environment.
|
| 21 |
+
|
| 22 |
+
## Usage
|
| 23 |
+
|
| 24 |
+
As documented in the official repository, you can use the provided startup script to automatically download this archive and configure Elasticsearch.
|
| 25 |
+
|
| 26 |
+
To use the pre-built index, run the following command from the root of the QuCo-RAG repository:
|
| 27 |
+
|
| 28 |
+
```bash
|
| 29 |
+
bash Start_Elasticsearch_from_hf.sh
|
| 30 |
+
```
|
| 31 |
+
|
| 32 |
+
The script will:
|
| 33 |
+
1. Check if Elasticsearch is already running.
|
| 34 |
+
2. Download the pre-built index (~10GB) from this Hugging Face repository.
|
| 35 |
+
3. Extract and start Elasticsearch with the index pre-loaded.
|
| 36 |
+
4. Verify the index is working correctly.
|
| 37 |
+
|
| 38 |
+
For users on HPC clusters with fast local SSD storage at `/tmp`, an optimized script is available:
|
| 39 |
+
```bash
|
| 40 |
+
bash Start_Elasticsearch_from_hf_HPC.sh
|
| 41 |
+
```
|
| 42 |
+
|
| 43 |
+
## Citation
|
| 44 |
+
|
| 45 |
+
If you use this data or the QuCo-RAG framework in your research, please cite:
|
| 46 |
+
|
| 47 |
+
```bibtex
|
| 48 |
+
@article{min2025qucorag,
|
| 49 |
+
title={QuCo-RAG: Quantifying Uncertainty from the Pre-training Corpus for Dynamic Retrieval-Augmented Generation},
|
| 50 |
+
author={Min, Dehai and Zhang, Kailin and Wu, Tongtong and Cheng, Lu},
|
| 51 |
+
journal={arXiv preprint arXiv:2512.19134},
|
| 52 |
+
year={2025}
|
| 53 |
+
}
|
| 54 |
+
```
|