-
Notifications
You must be signed in to change notification settings - Fork 1k
Feature/chrf score #2221
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
Open
kauabh
wants to merge
4
commits into
explodinggradients:main
Choose a base branch
from
kauabh:feature/chrf_score
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Feature/chrf score #2221
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
import typing as t | ||
from dataclasses import dataclass, field | ||
|
||
from langchain_core.callbacks import Callbacks | ||
|
||
from ragas.dataset_schema import SingleTurnSample | ||
from ragas.metrics.base import MetricType, SingleTurnMetric | ||
from ragas.run_config import RunConfig | ||
|
||
|
||
@dataclass | ||
class ChrfScore(SingleTurnMetric): | ||
name: str = "chrf_score" | ||
_required_columns: t.Dict[MetricType, t.Set[str]] = field( | ||
default_factory=lambda: {MetricType.SINGLE_TURN: {"reference", "response"}} | ||
) | ||
language: str = "english" | ||
kwargs: t.Dict[str, t.Any] = field(default_factory=dict) | ||
|
||
def __post_init__(self): | ||
try: | ||
from sacrebleu import corpus_chrf | ||
except ImportError: | ||
raise ImportError( | ||
"sacrebleu is required for chrf score. Please install it using `pip install sacrebleu`" | ||
) | ||
self.corpus_chrf = corpus_chrf | ||
|
||
def init(self, run_config: RunConfig): | ||
pass | ||
|
||
async def _single_turn_ascore( | ||
self, sample: SingleTurnSample, callbacks: Callbacks | ||
) -> float: | ||
reference, response = sample.reference, sample.response | ||
assert isinstance(reference, str), "ChrfScore expects a valid reference string" | ||
assert isinstance(response, str), "ChrfScore expects a valid response string" | ||
|
||
reference_sentences = reference.split(". ") | ||
response_sentences = response.split(". ") | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. CHRF should operate on the entire text as character n-grams. Might not need sentence-level splitting. |
||
|
||
# corpus_chrf expects a list of strings and a list of list of strings | ||
references = [[ref] for ref in reference_sentences] | ||
hypotheses = response_sentences | ||
|
||
score = self.corpus_chrf(hypotheses, references, **self.kwargs).score / 100 | ||
assert isinstance(score, float), "Expecting a float" | ||
return score | ||
|
||
async def _ascore(self, row: t.Dict, callbacks: Callbacks) -> float: | ||
return await self._single_turn_ascore(SingleTurnSample(**row), callbacks) |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
language
is not used anywhere. Did you miss it's code?