Unify outputs types

[SarahAlidoost]

closes #640
relates #691, #713, #711

See an overview of changes here.

[cwmeijer]

Thanks for your PR! Clearly, a lot of work went into it!
I only reviewed 1 or 2 files yet. Could you have a look at my comment on type hints?
I also see that the notebooks are failing.

I think it's because you changed the output type of some explainer so it doesn't match the notebook's code anymore. Could you try and fix those?

[SarahAlidoost]

Thanks for your PR! Clearly, a lot of work went into it! I only reviewed 1 or 2 files yet. Could you have a look at my comment on type hints? I also see that the notebooks are failing. I think it's because you changed the output type of some explainer so it doesn't match the notebook's code anymore. Could you try and fix those?

Thanks for reviewing. I addressed your comment about typing. Regarding the notebook error, as discussed, they will be fixed in a separate PR, see #711

[cwmeijer]

Thanks for this PR! Great addition to our code base and improvement in usability!
I made some suggestions, but all are to some extend details. Whether you change anything or not, I approve merging this PR.
🎖

[elboyran]

Some checks should pass before we merge.

[SarahAlidoost]

Some checks should pass before we merge.

Do you mean the failed checks for running the notebooks? For those checks to be passed, the notebooks should be updated. We decided not to update them in this pull request as it makes the PR large. Please see issue #711. Please let me know if there is another check you want me to fix in this PR.

[elboyran]

Yes, you are correct.

[SarahAlidoost]

Thanks for this PR! Great addition to our code base and improvement in usability! I made some suggestions, but all are to some extend details. Whether you change anything or not, I approve merging this PR. 🎖

Thank you for reviewing and nice comments 👍

[elboyran]

When do we merge this PR?
Please, keep in mind that after merging #699, the tutorials will be at a new location.

Old and proposed folder structure of dianna/tutorials :

main branch

tutorials (4 directories, 38 files)

├── README.md
├── conversion_onnx
│   ├── ...
├── data
│   ├──...
├── demo.ipynb
├── img
│   ├── ...
├── kernelshap_geometric_shapes.ipynb
├── kernelshap_mnist.ipynb
├── kernelshap_tabular_penguin.ipynb
├── kernelshap_tabular_weather.ipynb
├── lime_images.ipynb
├── lime_tabular_penguin.ipynb
├── lime_tabular_weather.ipynb
├── lime_text.ipynb
├── lime_timeseries_coffee.ipynb
├── lime_timeseries_weather.ipynb
├── models
│   ├── ....
├── rise_imagenet.ipynb
├── rise_mnist.ipynb
├── rise_text.ipynb
└── rise_timeseries_weather.ipynb

---

667-reorganize branch

tutorials (5 directories, 20 files)

├── README.md
├── conversion_onnx
│   ├── ...
├── demo.ipynb
└── explainers
├── KernelSHAP
│   ├── kernelshap_geometric_shapes.ipynb
│   ├── kernelshap_mnist.ipynb
│   ├── kernelshap_tabular_penguin.ipynb
│   └── kernelshap_tabular_weather.ipynb
├── LIME
│   ├── lime_images.ipynb
│   ├── lime_tabular_penguin.ipynb
│   ├── lime_tabular_weather.ipynb
│   ├── lime_text.ipynb
│   ├── lime_timeseries_coffee.ipynb
│   └── lime_timeseries_weather.ipynb
└── RISE
├── rise_imagenet.ipynb
├── rise_mnist.ipynb
├── rise_text.ipynb
└── rise_timeseries_weather.ipynb