Skip to content
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

Return response-level scores for CounterfactualGenerator and AutoEval #68

Closed
dylanbouchard opened this issue Dec 16, 2024 · 2 comments · Fixed by #70
Closed

Return response-level scores for CounterfactualGenerator and AutoEval #68

dylanbouchard opened this issue Dec 16, 2024 · 2 comments · Fixed by #70

Comments

@dylanbouchard
Copy link
Collaborator

dylanbouchard commented Dec 16, 2024

Is your feature request related to a problem? Please describe.
Currently, CounterfactualGenerator and AutoEval return a dictionary containing only metric values. In contrast, ToxicityMetrics and StereotypeMetrics give users the option to return response-level scores for a more detailed investigation into the assessment results. The request here is to give users the option to return analogous, response-level scores for CounterfactualGenerator, and return response-level toxicity, stereotype, and counterfactual scores with AutoEval.

Describe the solution you'd like
Give users option to return response-level scores with CounterfactualGenerator and AutoEval in returned dictionary. For consistency with ToxicityMetrics and StereotypeMetrics, this should be achieved by adding a new boolean argument called return_data to CounterfactualGenerator.evaluate and AutoEval.evaluate. The dictionary format returned should be consistent across these classes: a "metrics" key with metric values, and a "data" key with responses and response-level scores.

Additional context
Along with counterfactual.py, auto.py, demo notebooks, unit tests, and readme should also be updated.

@dylanbouchard
Copy link
Collaborator Author

@mohitcek is assigned to this issue. The requested counterfactual updates are addressed in PR #66

@dylanbouchard dylanbouchard linked a pull request Dec 17, 2024 that will close this issue
@dylanbouchard
Copy link
Collaborator Author

@mohitcek resolved this issue. Changes are reflected in v0.3.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant