renaming ground_truths to ground_truth. #640
Merged
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.
User description
Noticed that there were still references to
ground_truths
in the code and documentation (barring the validation function of course) after we updated this toground_truth
. This PR cleans that part up.Also updated the raise_exceptions error message to read
raise_exceptions=False
instead ofraise_exception=False
Description
ground_truths
toground_truth
across various Python and Markdown files, including documentation and Jupyter Notebooks.Changes walkthrough
2 files
evaluation.py
Update Dataset Type Annotation
src/ragas/evaluation.py
Dataset
type annotation to useground_truth
instead ofground_truths
.base.py
Update Comment to Match Variable Name
src/ragas/metrics/base.py
ground_truth
.15 files
README.md
Correct Dataset Features in README Example
README.md
ground_truth
.answer_correctness.md
Update Dataset Features in Documentation
docs/concepts/metrics/answer_correctness.md
ground_truth
.context_recall.md
Modify Dataset Features in Context Recall Documentation
docs/concepts/metrics/context_recall.md
ground_truth
.semantic_similarity.md
Adjust Dataset Features in Semantic Similarity Documentation
docs/concepts/metrics/semantic_similarity.md
ground_truth
.compare_llms.md
Change Variable Name in Compare LLMS Example
docs/howtos/applications/compare_llms.md
ground_truths
toground_truth
in the example code snippet.custom_prompts.md
Update Dataset Features in Custom Prompts Example
docs/howtos/applications/custom_prompts.md
ground_truth
.data_preparation.md
Correct Dataset Features in Data Preparation Example
docs/howtos/applications/data_preparation.md
ground_truth
.use_prompt_adaptation.md
Update Dataset Features in Prompt Adaptation Example
docs/howtos/applications/use_prompt_adaptation.md
ground_truth
.aws-bedrock.ipynb
Change Dataset Features in AWS Bedrock Notebook
docs/howtos/customisations/aws-bedrock.ipynb
ground_truth
in the Jupyter Notebookexample.
azure-openai.ipynb
Update Dataset Features in Azure OpenAI Notebook
docs/howtos/customisations/azure-openai.ipynb
ground_truth
in the Azure OpenAI Notebookexample.
gcp-vertexai.ipynb
Correct Dataset Features in GCP VertexAI Notebook
docs/howtos/customisations/gcp-vertexai.ipynb
ground_truth
in the GCP VertexAINotebook example.
langchain.ipynb
Change Dataset Features in Langchain Notebook
docs/howtos/integrations/langchain.ipynb
ground_truth
in the Langchain Notebookexample.
langfuse.ipynb
Update Dataset Features in Langfuse Notebook
docs/howtos/integrations/langfuse.ipynb
ground_truth
in the Langfuse Notebookexample.
llamaindex.ipynb
Correct Dataset Features in LlamaIndex Notebook
docs/howtos/integrations/llamaindex.ipynb
ground_truth
in the LlamaIndex Notebookexample.
zeno.ipynb
Update Dataset Features in Zeno Notebook
docs/howtos/integrations/zeno.ipynb
ground_truth
in the Zeno Notebook example.💡 Usage Guide
Checking Your Pull Request
Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.
Talking to CodeAnt AI
Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:
This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.