Release version 0.8.1

Lots of changes big and small with this release:

PairwiseSequenceClassificationExplainer (#87,#82,#58)

This has been a fairly requested feature and one that I am very happy to release, especially as I have had the desire to explain the outputs ofCrossEncoder models as of late.

ThePairwiseSequenceClassificationExplainer is a variant of theSequenceClassificationExplainer that is designed to work with classification models that expect the input sequence to be two inputs separated by a models' separator token. Common examples of this areNLI models andCross-Encoderswhich are commonly used to score two inputs similarity to one another.

This explainer calculates pairwise attributions for two passed inputs text1 and text2 using the model and tokenizer given in the constructor.

Also, since a common use case for pairwise sequence classification is to compare two inputs similarity - models of this nature typically only have a single output node rather than multiple for each class. The pairwise sequence classification has some useful utility functions to make interpreting single node outputs clearer.

By default for models that output a single node the attributions are with respect to the inputs pushing the scores closer to 1.0, however if you want to see the attributions with respect to scores closer to 0.0 you can passflip_sign=True when calling the explainer. For similarity-based models, this is useful, as the model might predict a score closer to 0.0 for the two inputs and in that case, we would flip the attributions sign to explain why the two inputs are dissimilar.

Example Usage

For this example we are using"cross-encoder/ms-marco-MiniLM-L-6-v2", a high quality cross-encoder trained on theMSMarco dataset a passage ranking dataset for question answering and machine reading comprehension.

fromtransformersimportAutoModelForSequenceClassification,AutoTokenizerfromtransformers_interpret.explainers.sequence_classificationimportPairwiseSequenceClassificationExplainermodel=AutoModelForSequenceClassification.from_pretrained("cross-encoder/ms-marco-MiniLM-L-6-v2")tokenizer=AutoTokenizer.from_pretrained("cross-encoder/ms-marco-MiniLM-L-6-v2")pairwise_explainer=PairwiseSequenceClassificationExplainer(model,tokenizer)# the pairwise explainer requires two string inputs to be passed, in this case given the nature of the model# we pass a query string and a context string. The question we are asking of our model is "does this context contain a valid answer to our question"# the higher the score the better the fit.query="How many people live in Berlin?"context="Berlin has a population of 3,520,031 registered inhabitants in an area of 891.82 square kilometers."pairwise_attr=explainer(query,context)

Which returns the following attributions:

>>>pairwise_attr[('[CLS]',0.0), ('how',-0.037558652124213034), ('many',-0.40348581975409786), ('people',-0.29756140282349425), ('live',-0.48979015417391764), ('in',-0.17844527885888117), ('berlin',0.3737346097442739), ('?',-0.2281428913480142), ('[SEP]',0.0), ('berlin',0.18282430604641564), ('has',0.039114659489254834), ('a',0.0820056652212297), ('population',0.35712150914643026), ('of',0.09680870840224687), ('3',0.04791760029513795), (',',0.040330986539774266), ('520',0.16307677913176166), (',',-0.005919693904602767), ('03',0.019431649515841844), ('##1',-0.0243808667024702), ('registered',0.07748341753369632), ('inhabitants',0.23904087299731255), ('in',0.07553221327346359), ('an',0.033112821611999875), ('area',-0.025378852244447532), ('of',0.026526373859562906), ('89',0.0030700151809002147), ('##1',-0.000410387092186983), ('.',-0.0193147139126114), ('82',0.0073800833347678774), ('square',0.028988305990861576), ('kilometers',0.02071182933829008), ('.',-0.025901070914318036), ('[SEP]',0.0)]

Visualize Pairwise Classification attributions

Visualizing the pairwise attributions is no different to the sequence classification explaine. We can see that in both thequery andcontext there is a lot of positive attribution for the wordberlin as well the wordspopulation andinhabitants in thecontext, good signs that our model understands the textual context of the question asked.

pairwise_explainer.visualize("cross_encoder_attr.html")

If we were more interested in highlighting the input attributions that pushed the model away from the positive class of this single node output we could pass:

pairwise_attr=explainer(query,context,flip_sign=True)

This simply inverts the sign of the attributions ensuring that they are with respect to the model outputting 0 rather than 1.

RoBERTa Consitency Improvements (#65)

Thanks to some great detective work by@dvsrepo,@jogonba2,@databill86, and@VDuchauffour on this issue over the last year we've been able to identify what looks to be the main culprit responsible for the misalignment of scores given for RoBERTa based model inside the package when compared with their actual outputs in the transformers package.

Because this package has to create reference id's for each input type (input_ids, position_ids, token_type_ids) to create a baseline we try and emulate the outputs of the model's tokenizers in an automated fashion, for most BERT-based models this works great but as I have learned from reading this thread (#65) there were significant issues with RoBERTa.

It seems that the main reason for this is that RoBERTa implementsposition_ids in a very different manner to BERT (readthis andthis for extra context). Since we were passing completely incorrect values for position_ids it appears to have thrown the model's predictions off. This release does not fully fix the issue but it does bypass the passing of incorrectposition_ids by simply not passing them to the forward function. We've done this by creating a flag that recognises certain model architectures as being incompatible with how we createposition_ids according theTransformers docs whenposition_ids are not passed:

They are an optional parameter. If no position_ids are passed to the model, the IDs are automatically created as absolute positional embeddings.

So this solution should be good for most situations, however, ideally in the future, we will look into creating RoBERTa compatibleposition_ids within the package itself.

Move to GH actions

This release also moves our testing suite from CircleCI to GH Actions, GH Actions has proven to be easier to integrate with and much more convenient.

Other

• Set the minimum python version to 3.7. As of December 2021 Python 3.6 is no longer officially supported by the python team therefore we have also removed support for it.
• Housekeeping and cleanup around the codebase