Skip to content
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.

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

Fix contexts attribute name in examples documentation #58

Merged
merged 1 commit into from
May 15, 2024

Conversation

LucasLeRay
Copy link
Contributor

@LucasLeRay LucasLeRay commented May 15, 2024

Fix names of retrieved_contexts and ground_truth_contexts attributes from Dataset in "examples" documentation.

This makes it ISO with the quickstart.


🚀 This description was created by Ellipsis for commit 306ffe3

Summary:

Updated attribute names in the example documentation to match the Dataset class definitions.

Key points:

  • Corrected attribute names in 1_evaluation_on_dataset.md from retrieved_context and ground_truth_context to retrieved_contexts and ground_truth_contexts.

Generated with ❤️ by ellipsis.dev

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks good to me! Reviewed everything up to 306ffe3 in 1 minute and 17 seconds

More details
  • Looked at 22 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted 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 names retrieved_contexts and ground_truth_contexts are consistently used across the entire codebase, including all documentation and code examples. If the previous attribute names were retrieved_context and ground_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.

@yisz
Copy link
Contributor

yisz commented May 15, 2024

@LucasLeRay Thank you for the fix!

@yisz yisz closed this May 15, 2024
@yisz yisz reopened this May 15, 2024
@yisz yisz merged commit 35f88ed into relari-ai:main May 15, 2024
@LucasLeRay LucasLeRay deleted the fix-contexts-attribute-name-doc branch May 15, 2024 19:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants