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

fix merge_attributions #210

Merged
merged 4 commits into from
Aug 2, 2023
Merged

Conversation

DanielSc4
Copy link
Contributor

@DanielSc4 DanielSc4 commented Aug 1, 2023

Description

The merge_attributions method is moved out of the FeatureAttributionOutput class as described in #209.

Related Issue

Fix #209

Type of Change

  • 💥 Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • I've read the CODE_OF_CONDUCT.md document.
  • I've read the CONTRIBUTING.md guide.
  • I've successfully run the style checks using make fix-style.
  • I've written tests for all new methods and classes that I created and successfully ran make test.
  • I've written the docstring in Google format for all the methods and classes that I used.

@DanielSc4 DanielSc4 changed the title fix merge_attributions #209 fix merge_attributions Aug 1, 2023
@gsarti
Copy link
Member

gsarti commented Aug 1, 2023

Note: this implements a breaking change for merging attributions, defining merge_attributions as a stand-alone function rather than a static method to prevent misleading usage from FeatureAttributionOutput instances.

@DanielSc4
Copy link
Contributor Author

Oops, I wrote it without thinking. I just edited the description accordingly.

@DanielSc4
Copy link
Contributor Author

I also report that the merge_attributions function could be moved to Main Functions in the documentation (here) since it is now callable with inseq.merge_attributions(...).

@gsarti gsarti added the bug Something isn't working label Aug 2, 2023
@gsarti gsarti added this to the v0.5 milestone Aug 2, 2023
@gsarti
Copy link
Member

gsarti commented Aug 2, 2023

@DanielSc4 I updated docs in inseq-team:fix-merge_attributions. You should be able to pull my commit in your fork, and it will be reflected here. I can proceed with the merge afterwards!

@DanielSc4
Copy link
Contributor Author

The fork is now up-to-date w/ inseq-team/inseq:fix-merge_attributions! The PR should now be ready to be merged 🚀.

Copy link
Member

@gsarti gsarti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@gsarti gsarti merged commit d4663af into inseq-team:main Aug 2, 2023
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Confusing call of merge_attributions method
2 participants