Bug: `explain` type is incorrect in `History` factory

[clementjumel]

Hi! I find your work with edsnlp really cool, and I'm working on integrating it in one of our tools at Arkhn 🙂 I found a very little mistake which prevents us from trying the History component at all and which should be very easy to fix!

Description

In the History class, you use an attribute explain, which is a boolean, however in the corresponding factory, you made it a string (right here).

As a consequence, spaCy converts the parameter to a string, so the "explain mode" is always on, which is an issue when we try to serialize the documents (e.g. with doc.to_bytes()) as the history cues are not serializable. 😬

How to reproduce the bug

import spacy

nlp = spacy.blank("fr")
nlp.add_pipe("eds.history")

name, component = nlp.pipeline[-1]
print(name)
print(component.explain)
print(type(component.explain))
print(bool(component.explain))

which gives:

eds.history
False
<class 'str'>
True

the last line exhibits that the explain feature here is always activated 😕

Your Environment

• Operating System: MacOS
• Python Version Used: 3.9.13
• spaCy Version Used: 3.1.3
• EDS-NLP Version Used: 0.6.2
• Environment Information:

[percevalw]

Hi @clementjumel, thanks for using the library and letting us know about this issue! Would you like to submit a PR to fix this?

[clementjumel]

Hi @clementjumel, thanks for using the library and letting us know about this issue! Would you like to submit a PR to fix this?

Sure, here it goes: #117 🙂

For some reason, locally, not all tests were passing before & after the change, even following the installation described here. 😬 Besides, given the nature of the fix, I don't think it's worth the implementation of tests for the fix!