dwb2023 commited on
Commit
91888ae
·
verified ·
1 Parent(s): 53f61e1

add field info

Browse files
Files changed (1) hide show
  1. README.md +85 -0
README.md CHANGED
@@ -29,3 +29,88 @@ configs:
29
  - split: train
30
  path: data/train-*
31
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
29
  - split: train
30
  path: data/train-*
31
  ---
32
+ ---
33
+ dataset_info:
34
+ features:
35
+ - name: user_input
36
+ dtype: string
37
+ - name: reference_contexts
38
+ list: string
39
+ - name: reference
40
+ dtype: string
41
+ - name: synthesizer_name
42
+ dtype: string
43
+ splits:
44
+ - name: train
45
+ num_bytes: 2755
46
+ num_examples: 5
47
+ download_size: 6075
48
+ dataset_size: 2755
49
+ configs:
50
+ - config_name: default
51
+ data_files:
52
+ - split: train
53
+ path: data/train-*
54
+ license: mit
55
+ task_categories:
56
+ - question-answering
57
+ language:
58
+ - en
59
+ tags:
60
+ - ragas
61
+ - golden-testset
62
+ - rag-eval
63
+ - personas
64
+ pretty_name: RAGAS Golden Testset (Personas, AS-IS Schema)
65
+ ---
66
+
67
+ # Dataset Card for ragas-usecase-raw-data
68
+
69
+ ## Dataset Description
70
+
71
+ Source data used to generate [ragas-golden-testset-personas](https://huggingface.co/datasets/dwb2023/ragas-golden-testset-personas). Refer to that dataset for additional information.
72
+
73
+ ### Dataset Summary
74
+
75
+ Capturing here due to some initial challenges with the source data leading to downstream challenges with synthetic data generation. (Garbage In, Garbage Out...)
76
+
77
+ ### Dataset Structure
78
+
79
+ The dataset consists of records following the standard LangChain `Document` format:
80
+
81
+ * `page_content` *(string)*:
82
+ Raw text of the source record. Preserves original whitespace, punctuation, and line breaks.
83
+
84
+ * `metadata` *(struct)*:
85
+ As-is metadata captured at ingestion (not normalized).
86
+
87
+ * `Judge Comments` *(string)*: Free-text qualitative notes from a judge/evaluator.
88
+ * `Judge Score` *(string)*: Score exactly as stored in source (e.g., `"4/5"`, `"Good"`, `"N/A"`).
89
+ * `Project Name` *(string)*: Project/entry name from source.
90
+ * `Score` *(string)*: Additional score field (distinct from `Judge Score`; may differ).
91
+ * `row` *(int64)*: Original source row index (stable pointer back to raw data).
92
+ * `source` *(string)*: Origin identifier (e.g., file name/path/URI).
93
+
94
+ > Notes: Encoding is UTF-8. Scores remain strings by design. Missing/empty fields may occur.
95
+
96
+ ### Supported Tasks
97
+
98
+ This dataset is primarily intended for:
99
+
100
+ * **RAGAS test set generation & evaluation** (e.g., faithfulness, answer correctness)
101
+ * **Loading vector stores for RAG** (retriever benchmarking, recall/precision diagnostics)
102
+
103
+
104
+ ## Additional Information
105
+
106
+ ### Dataset Curators
107
+
108
+ The source dataset was curated by dwb2023 and the AI Makerspace team (refer to the citation below).
109
+
110
+ ### Licensing Information
111
+
112
+ This dataset is released under the MIT License.
113
+
114
+ ### Citation Information
115
+
116
+ If you use this dataset in your research, please cite the [AI Makerspace team](https://aimakerspace.io/the-ai-engineering-bootcamp/). The original notebook and source data is based on their awesome course!