-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Description
[x] I have checked the documentation and related resources and couldn't resolve my bug.
Describe the bug
In the documentation section Types of Metrics in Ragas, there is a mistake in the description of Non-LLM-based metrics.
It currently says:
All LLM based metrics in ragas are inherited from Metric class.
This is incorrect. Based on the codebase and usage:
- LLM-based metrics inherit from
MetricWithLLM - Non-LLM-based metrics inherit from
Metric
So the line should read:
All Non-LLM-based metrics in ragas are inherited from Metric class.
Ragas version:
N/A (documentation bug)
Python version:
N/A
Code to Reproduce
Not applicable (documentation bug).
Error trace
Not applicable.
Expected behavior
The documentation should correctly describe that Non-LLM-based metrics inherit from Metric, while LLM-based metrics inherit from MetricWithLLM.
Additional context
This may cause confusion for users implementing their own metrics.