-
Notifications
You must be signed in to change notification settings - Fork 69
feat: RuleDictConsistency #387
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
Merged
Merged
Changes from all commits
Commits
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -2678,6 +2678,52 @@ def eval(cls, input_data: Data) -> EvalDetail: | |||||
| return res | ||||||
|
|
||||||
|
|
||||||
| @Model.rule_register("QUALITY_BAD_EFFECTIVENESS", [""]) | ||||||
| class RuleDictConsistency(BaseRule): | ||||||
| """Compare two dict fields and report mismatched keys.""" | ||||||
|
Contributor
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. The docstring is slightly inaccurate as it only mentions mismatched keys. The rule also checks for mismatched values for common keys. Please update the docstring to reflect the full behavior of the rule, which is better described in
Suggested change
|
||||||
|
|
||||||
| _metric_info = { | ||||||
| "category": "Rule-Based TEXT Quality Metrics", | ||||||
| "quality_dimension": "EFFECTIVENESS", | ||||||
| "metric_name": "RuleDictConsistency", | ||||||
| "description": "Checks whether metadata and context dict are consistent by key/value equality", | ||||||
| "evaluation_results": "" | ||||||
| } | ||||||
|
|
||||||
| _required_fields = [RequiredField.METADATA, RequiredField.CONTEXT] | ||||||
|
|
||||||
| @classmethod | ||||||
| def eval(cls, input_data: Data) -> EvalDetail: | ||||||
| res = EvalDetail(metric=cls.__name__) | ||||||
| left_dict = getattr(input_data, "metadata", None) | ||||||
| right_dict = getattr(input_data, "context", None) | ||||||
|
|
||||||
| if not isinstance(left_dict, dict) or not isinstance(right_dict, dict): | ||||||
| res.status = True | ||||||
| res.label = [f"{cls.metric_type}.{cls.__name__}", "INVALID_DICT_FIELD"] | ||||||
| res.reason = [ | ||||||
| "metadata/context must both be dict, " | ||||||
| f"got metadata={type(left_dict).__name__}, context={type(right_dict).__name__}" | ||||||
| ] | ||||||
| return res | ||||||
|
|
||||||
| diff_keys = [] | ||||||
| all_keys = set(left_dict.keys()) | set(right_dict.keys()) | ||||||
| for key in sorted(all_keys, key=lambda x: str(x)): | ||||||
| if key not in left_dict or key not in right_dict or left_dict[key] != right_dict[key]: | ||||||
| diff_keys.append(str(key)) | ||||||
|
|
||||||
| if diff_keys: | ||||||
| res.status = True | ||||||
| res.label = [ | ||||||
| f"{cls.metric_type}.{cls.__name__}.{key}" for key in diff_keys | ||||||
| ] | ||||||
| res.reason = [f"Inconsistent keys: {', '.join(diff_keys)}"] | ||||||
| else: | ||||||
| res.label = [QualityLabel.QUALITY_GOOD] | ||||||
| return res | ||||||
|
|
||||||
|
|
||||||
| if __name__ == "__main__": | ||||||
| data = Data(data_id="", prompt="", content="\n \n \n \n hello \n \n ") | ||||||
| tmp = RuleEnterAndSpace().eval(data) | ||||||
Oops, something went wrong.
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.
The group name
""is unconventional. If this rule is not meant to be part of any group, it's better to use an empty list[]. If it should belong to a group, please use a descriptive name. Using[""]will create a group with an empty string as its name, which is likely not the intention.