elie-mada commited on
Commit
c56805d
·
verified ·
1 Parent(s): 39b144a

docs: dataset card

Browse files
Files changed (1) hide show
  1. README.md +69 -0
README.md ADDED
@@ -0,0 +1,69 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: cc-by-nc-4.0
3
+ language: en
4
+ pretty_name: CiteRight RAG Corpus (IP and Innovation Policy)
5
+ tags:
6
+ - rag
7
+ - retrieval
8
+ - citation
9
+ - faithfulness
10
+ - scientific-papers
11
+ size_categories:
12
+ - 1K<n<10K
13
+ ---
14
+
15
+ # CiteRight Corpus
16
+
17
+ Research dataset accompanying the CS-552 (EPFL Spring 2026) Open Project
18
+ **Faithful RAG: Citation Accuracy and Retrieval Robustness in Domain-Specific
19
+ Scientific Literature** by Team CiteRight (Elie Bruno, Andrea Trugenberger,
20
+ Faruk Zahiragic, Yusif Askari).
21
+
22
+ ## Contents
23
+
24
+ | Path | Description |
25
+ |---|---|
26
+ | `chunks/<paper_id>_<coarse\|fine>.json` | Pre-computed semantic chunks per paper (~2 000 chars coarse, ~300 chars fine). |
27
+ | `indexes/<coarse\|fine>.faiss` | FAISS `IndexFlatIP` built from OpenAI `text-embedding-3-small` (1 536-d). |
28
+ | `indexes/<coarse\|fine>_metadata.json` | Row → chunk mapping with paper id, section hierarchy, text. |
29
+ | `processed/<paper_id>/document.md` | Dolphin-1.5 parsed markdown (preserves sections, equations, tables). |
30
+ | `processed/<paper_id>/metadata.json` | Page-level layout metadata from the VLM. |
31
+ | `raw_metadata/<paper_id>.json` | OpenAlex bibliographic record (DOI, year, OA status). |
32
+
33
+ Original PDFs are **not** redistributed: anyone who needs them can refetch
34
+ from OpenAlex using the `id` field in `raw_metadata/<paper_id>.json`.
35
+
36
+ ## Provenance
37
+
38
+ - **Source:** OpenAlex, filtered with `primary_topic.id=t10856` and `open_access.is_oa=true`.
39
+ - **PDF parsing:** [Dolphin 1.5](https://github.com/ByteDance-Seed/Dolphin) on a CUDA 11.8 worker fleet.
40
+ - **Embeddings:** OpenAI `text-embedding-3-small` (1 536-d), normalised for cosine similarity.
41
+
42
+ ## Loading
43
+
44
+ ```python
45
+ from huggingface_hub import snapshot_download
46
+
47
+ local = snapshot_download("citeright/corpus", repo_type="dataset",
48
+ local_dir="/scratch/citeright_artifacts")
49
+ ```
50
+
51
+ Or use the helpers in [`evaluation/common/data_loader.py`](https://github.com/eliemada/cs552-faithful-rag/blob/main/evaluation/common/data_loader.py)
52
+ which auto-resolves to the right cache.
53
+
54
+ ## License
55
+
56
+ Released under [CC-BY-NC-4.0](https://creativecommons.org/licenses/by-nc/4.0/).
57
+ Each underlying paper retains its own license. For takedown requests, open
58
+ a discussion on this repo.
59
+
60
+ ## Citation
61
+
62
+ ```bibtex
63
+ @misc{citeright2026,
64
+ title = {CiteRight: Citation Accuracy and Retrieval Robustness in Scientific RAG},
65
+ author = {Bruno, Elie and Trugenberger, Andrea and Zahiragic, Faruk and Askari, Yusif},
66
+ year = 2026,
67
+ note = {CS-552 Modern NLP Open Project, EPFL}
68
+ }
69
+ ```