Skip to content

Add note about when ground truth labels are required #146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 19, 2023
Merged

Add note about when ground truth labels are required #146

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/quickstart.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
"- question: `list[str]` - These are the questions you RAG pipeline will be evaluated on. \n",
"- answer: `list[str]` - The answer generated from the RAG pipeline and give to the user.\n",
"- contexts: `list[list[str]]` - The contexts which where passed into the LLM to answer the question.\n",
"- ground_truths: `list[list[str]]` - The ground truth answer to the questions.\n",
"- ground_truths: `list[list[str]]` - The ground truth answer to the questions. (only required if you are using context_recall)\n",
"\n",
"Ideally your list of questions should reflect the questions your users give, including those that you have been problamatic in the past.\n",
"\n",
Expand Down