Redraft the evaluation README #510
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
June 3, 2024 17:20
rachaelcodes
reviewed
Jun 4, 2024
| This is so that the user can understand your responses.\ | ||
| """ | ||
| ``` | ||
| You've analysed a dataset, improved the RAG system, and you want those changes to make it into Redbox. Congratulations! |
There was a problem hiding this comment.
Do we want to add something about the margin of difference we want to see in the RAG evaluation metrics to be confident of an improvement?
andy-symonds
approved these changes
Jun 4, 2024
gecBurton
reviewed
Jun 4, 2024
| @@ -1,133 +1,105 @@ | |||
| # Redbox RAG Evaluation | |||
| # 📮 Redbox RAG evaluation | |||
There was a problem hiding this comment.
can we rename this file README.md so that it is automatically displayed?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
Now we have the whole retrieval engine in the evaluation notebook, we can spruce up the README to be a clear, concise, skimmable intro to evaluation.
Changes proposed in this pull request
Guidance to review
Things to check