Skip to content

Commit 1499924

Browse files
authored
Add note about when ground truth labels are required (#146)
To reduce some confusion, add a note mentioning that ground truth labels are only required for context_recall, since the tool can generate other metrics in a "ground truth" free manner.
1 parent 8e91b16 commit 1499924

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/quickstart.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@
6666
"- question: `list[str]` - These are the questions you RAG pipeline will be evaluated on. \n",
6767
"- answer: `list[str]` - The answer generated from the RAG pipeline and give to the user.\n",
6868
"- contexts: `list[list[str]]` - The contexts which where passed into the LLM to answer the question.\n",
69-
"- ground_truths: `list[list[str]]` - The ground truth answer to the questions.\n",
69+
"- ground_truths: `list[list[str]]` - The ground truth answer to the questions. (only required if you are using context_recall)\n",
7070
"\n",
7171
"Ideally your list of questions should reflect the questions your users give, including those that you have been problamatic in the past.\n",
7272
"\n",

0 commit comments

Comments
 (0)