dimitripunch commited on
Commit
0283e25
·
verified ·
1 Parent(s): 3fb65e6

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +94 -3
README.md CHANGED
@@ -1,3 +1,94 @@
1
- ---
2
- license: apache-2.0
3
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ ---
4
+ # Fred Test Corpus
5
+
6
+ **Purpose:** Benchmark and regression testing for the **Fred** open-source agentic AI platform ([https://fredk8.dev](https://fredk8.dev)).
7
+
8
+ ---
9
+
10
+ ## Overview
11
+
12
+ This dataset contains a **heterogeneous corpus of PDF documents** used to validate and benchmark the ingestion, vectorization, and retrieval (RAG) components of the Fred platform.
13
+
14
+ It includes real-world documents from three distinct domains:
15
+
16
+ | Folder | Source | Description |
17
+ |:--------|:--------|:-------------|
18
+ | **`ECB/`** | European Central Bank | Recent ECB Working Papers (economic research). |
19
+ | **`OCDE/`** | Organisation for Economic Co-operation and Development | French-language policy and analysis papers. |
20
+ | **`ARXIV-AI/`** | arXiv.org (Artificial Intelligence category) | AI-related scientific preprints from September 2025. |
21
+
22
+ Each folder contains between 8 and 15 representative PDF files, with typical file sizes between **300 KB and 2 MB**.
23
+
24
+ ---
25
+
26
+ ## ⚙️ Intended Use
27
+
28
+ The corpus is designed for **functional and performance testing** of Fred’s document ingestion and retrieval subsystems, including:
29
+
30
+ - **Document ingestion pipeline:** testing metadata extraction, text conversion, and storage backends (e.g. MinIO, OpenSearch, DuckDB).
31
+ - **Embedding & vectorization:** validating chunking, embedding quality, and retrieval accuracy.
32
+ - **RAG agents:** verifying contextual retrieval within Fred’s *DocumentsExpert* and *Knowledge Flow* agents.
33
+ - **Library selection & tagging:** evaluating how agents choose contextually relevant sources from mixed-domain libraries.
34
+
35
+ This corpus is *not* a production dataset; it is meant for open-source experimentation, demos, and reproducibility of Fred agent behavior.
36
+
37
+ ---
38
+
39
+ ## Folder Structure
40
+
41
+ ```
42
+ fred-test-corpus/
43
+ ├── ECB/
44
+ │ ├── ecb.wp3098~f8a4989211.en.pdf
45
+ │ ├── ecb.wp3099~d0ab147fbf.en.pdf
46
+ │ └── ...
47
+ ├── OCDE/
48
+ │ ├── 04b537a4-fr.pdf
49
+ │ ├── 299d5974-fr.pdf
50
+ │ └── ...
51
+ └── ARXIV-AI/
52
+ ├── 2509.03768v1.pdf
53
+ ├── 2509.03827v1.pdf
54
+ └── ...
55
+ ```
56
+
57
+ ---
58
+
59
+ ## ⚖️ Licensing and Sources
60
+
61
+ All included PDFs are **publicly available documents** from:
62
+ - [European Central Bank](https://www.ecb.europa.eu/)
63
+ - [Organisation de Coopération et de Développement Économiques (OCDE)](https://www.oecd.org/)
64
+ - [arXiv.org](https://arxiv.org/)
65
+
66
+ They are redistributed **for non-commercial research and testing purposes only**, under fair-use / open-access terms of their respective publishers.
67
+
68
+ > Fred and its contributors make no claim of ownership over the contents of these documents.
69
+ > This corpus is distributed *solely for reproducibility and testing* of open-source AI workflows.
70
+
71
+ ---
72
+
73
+ ## 🧾 Citation
74
+
75
+ If you use this corpus in your work, please cite:
76
+
77
+ ```
78
+ Fred Open Source Project (2025).
79
+ "Fred Test Corpus for Document Ingestion and RAG Evaluation."
80
+ https://huggingface.co/fredk8/fred-test-corpus
81
+ ```
82
+
83
+ ---
84
+
85
+ ## 🧱 Related Projects
86
+
87
+ - Fred Agentic FRamework](https://github.com/ThalesGroup/fred)
88
+ - [Official Site](https://fredk8.dev)
89
+
90
+ ---
91
+
92
+ **Maintainer:** [ThalesGroup / Fred Open Source](https://github.com/ThalesGroup/fred)
93
+ **License:** Apache 2.0 (for scripts & metadata)
94
+ **Data License:** As per original publishers (non-commercial research use)