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
[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[x] Docs (Added to or improved Transformers Interpret's documentation)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
Final Checklist:
[x] My code follows the code style of this project.
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 justfrom transformers_interpret import PairwiseSequenceClassificationExplainer
. The latter is more universal, so I fixed itAlso 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 brokenTests and Coverage
I assume there are no tests for docs ¯_(ツ)_/¯
Types of changes
Final Checklist: