Fix contexts attribute name in examples documentation#58
Merged
yisz merged 1 commit intorelari-ai:mainfrom May 15, 2024
Merged
Conversation
Contributor
There was a problem hiding this comment.
👍 Looks good to me! Reviewed everything up to 306ffe3 in 1 minute and 17 seconds
More details
- Looked at
22lines of code in1files - Skipped
0files when reviewing. - Skipped posting
1drafted comments based on config settings.
1. docs/src/content/docs/examples/Basics/1_evaluation_on_dataset.md:23
- Draft comment:
Please ensure that the attribute namesretrieved_contextsandground_truth_contextsare consistently used across the entire codebase, including all documentation and code examples. If the previous attribute names wereretrieved_contextandground_truth_context, this change might require updates in other parts of the code or documentation to maintain consistency. - Reason this comment was not posted:
Confidence of 0% on close inspection, compared to threshold of 50%.
Workflow ID: wflow_lIPCiN1Zzu5YtLIF
You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
Contributor
|
@LucasLeRay Thank you for the fix! |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Fix names of
retrieved_contextsandground_truth_contextsattributes fromDatasetin "examples" documentation.This makes it ISO with the quickstart.
Summary:
Updated attribute names in the example documentation to match the
Datasetclass definitions.Key points:
1_evaluation_on_dataset.mdfromretrieved_contextandground_truth_contexttoretrieved_contextsandground_truth_contexts.Generated with ❤️ by ellipsis.dev