understandable-machine-intelligence-lab / Quantus

Quantus is an eXplainable AI toolkit for responsible evaluation of neural network explanations
https://quantus.readthedocs.io/
Other
547 stars 76 forks source link

Suggestion on Readability of README #58

Closed p16i closed 2 years ago

p16i commented 2 years ago

While going through README, I have noticed that the section that describes metrics implemented is very long. Perhaps, we could use the <details></details> to hide the content.

More precisely, we could do it like:

(below is snippet from README with the suggested approach)

... The library contains implementations of the following evaluation metrics:

Faithfulness: ... - Paper 1 - Paper 2
Robustness: ... - Paper 1 - Paper 2
annahedstroem commented 2 years ago

Great suggestion - change just committed.