docs: clarify metric input requirements#39
Open
GioiaZheng wants to merge 1 commit into
Open
Conversation
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
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.
Why
RAGChecker users need a clear way to tell which input fields are required for each metric. The tutorial explains the metric groups, but it does not map metrics to their intermediate checks or clarify which metrics can be used without reference answers.
Refs #29.
What changed
faithfulnessis reference-free in its computation, while the other listed metrics rely ongt_answerdirectly or indirectly.Validation
METRIC_REQUIREMENTSand the metric computation paths.git diff --check.Risk / follow-up
Low risk; documentation-only change. If this structure looks useful, the same summary could be mirrored in the README later.