cdpierse / transformers-interpret

Model explainability that works seamlessly with 🤗 transformers. Explain your transformers model in just 2 lines of code.
Apache License 2.0
1.3k stars 97 forks source link

Fix path for Pairwise Sequence Classification #115

Closed rinapch closed 2 years ago

rinapch commented 2 years ago

PR Description

Hey! It's a tiny PR about fixing the path to PairwiseSequenceClassificationExplainer in README.md. Currently it's

from transformers_interpret.explainers.sequence_classification import PairwiseSequenceClassificationExplainer

Should be either from transformers_interpret.explainers.text.sequence_classification import PairwiseSequenceClassificationExplainer or just from transformers_interpret import PairwiseSequenceClassificationExplainer. The latter is more universal, so I fixed it

Also added a couple of lines in CONTRIBUTION.md about needing to fork the repo in order to create a PR. Maybe it's self-evident, but I definitely tried pushing directly at first :D So maybe it'll help someone in the future

Motivation and Context

The path from transformers_interpret.explainers.sequence_classification import PairwiseSequenceClassificationExplainer is broken

Tests and Coverage

I assume there are no tests for docs ¯_(ツ)_/¯

Types of changes

Final Checklist:

cdpierse commented 2 years ago

Hey sorry for getting to this late, thanks for spotting this, really appreciated, merging now !