What's Changed
Bigger PRs
* **Refactor `custom_preprocess()` for more robustness** by dkrako, reviewed by annahedstroem, leanderweber in https://github.com/understandable-machine-intelligence-lab/Quantus/pull/167
- Make the implementation `custom_preprocess()` more flexible: instead of passing the complete tuple with `model, x_batch, y_batch, a_batch, s_batch, ..` we instead pass a dictionary with the variable names as keys.
* **Batched evaluation** by dkrako, reviewed by annahedstroem, leanderweber in https://github.com/understandable-machine-intelligence-lab/Quantus/pull/168
- This PR implements the classes BatchedMetric and BatchedPerturbationMetric
- This is a rewrite of this PR: https://github.com/understandable-machine-intelligence-lab/Quantus/pull/87
- It solves the following issue: https://github.com/understandable-machine-intelligence-lab/Quantus/issues/80
- This will speed up a lot of metrics.
- Not all metrics in Quantus are yet updated with BatchedPerturbationMetric. The efforts of deploying this new construct with more metrics for efficiency gains will continue.
* **Change normalisation default, fix bug in normalise_by_negative, adapt citations, absolute imports** by leanderweber, reviewed by annahedstroem, dkrako in https://github.com/understandable-machine-intelligence-lab/Quantus/pull/166
- Make some Updates to the readthedocs
- Update and Unify Citations in all Metrics
- Update, unify, and sort all imports
- Change all relative imports to absolute
- Rethink star imports. Specifically, restructure helpers to distinguish internal functions and functions that should be user-accessible.
- Change the normalisation_func default to normalise_by_max instead of normalise_by_negative due to the latter treating pos/neg values differently
- Target some bugs within the normalisation functions and their application
- Merge installation options rework (see PR https://github.com/understandable-machine-intelligence-lab/Quantus/pull/172)
- Updated and cleaned-up README.md file
* **Mypy: fix errors fix** by dilyabareeva, reviewed by annahedstroem in https://github.com/understandable-machine-intelligence-lab/Quantus/pull/171
- An in-depth look at the typing, branched from mypy-static-type-checker
- Fix errors or reject with reason
Smaller PRs
* **Installation option refactoring to be more concise** by leanderweber, reviewed by annahedstroem in https://github.com/understandable-machine-intelligence-lab/Quantus/pull/172
- Refactored installation options, e.g., "extras" removed, instead singular XAI libraries are targetable.
- Updated Quantus package dependencies
* **Bugfixes to Installation and Tutorials** by leanderweber, reviewed by annahedstroem in https://github.com/understandable-machine-intelligence-lab/Quantus/pull/176
* **Tabular data minimal example** by dilyabareeva, reviewed by annahedstroem in https://github.com/understandable-machine-intelligence-lab/Quantus/pull/175
- Jupyter notebook/ tutorial based on Titanic data, showing with a minimal example how to use Quantus
* **Add time series tutorial** by dkrako, reviewed by annahedstroem in https://github.com/understandable-machine-intelligence-lab/Quantus/pull/177
* Remove coverage>=6.2 by annahedstroem in https://github.com/understandable-machine-intelligence-lab/Quantus/pull/179
**Full Changelog**: https://github.com/understandable-machine-intelligence-lab/Quantus/compare/v0.2.2...v0.3.0