distance-explainer 0.4.0__tar.gz

distance_explainer-0.4.0/CITATION.cff

@@ -0,0 +1,23 @@
+# YAML 1.2
+---
+cff-version: "1.2.0"
+title: "distance_explainer"
+authors:
+  -
+    family-names: Meijer
+    given-names: Christiaan
+    orcid: "https://orcid.org/0000-0002-5529-5761"
+  -
+    family-names: Bos
+    given-names: Patrick
+    orcid: "https://orcid.org/0000-0002-6033-960X"
+
+date-released: 2023-10-19
+doi: 10.5281/zenodo.10018768.
+version: "0.4.0"
+repository-code: "git@github.com:dianna-ai/distance_explainer"
+keywords:
+  - XAI
+  - embedded spaces
+message: "If you use this software, please cite it using these metadata."
+license: Apache-2.0

distance_explainer-0.4.0/LICENSE

@@ -0,0 +1,204 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+

distance_explainer-0.4.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include CITATION.cff
+include LICENSE
+include README.md

distance_explainer-0.4.0/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.1
+Name: distance_explainer
+Version: 0.4.0
+Summary: XAI method to explain distances in embedded spaces
+Home-page: https://github.com/dianna-ai/distance_explainer
+Author: Christiaan Meijer
+Author-email: c.meijer@esciencecenter.nl
+Project-URL: Bug Tracker, https://github.com/dianna-ai/distance_explainer/issues
+Keywords: XAI,embedded spaces
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: dianna>=1.4
+Requires-Dist: numpy
+Requires-Dist: pytest
+Requires-Dist: tqdm
+Requires-Dist: scikit-learn
+Requires-Dist: pyyaml
+Requires-Dist: dataclass_wizard
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: bump2version; extra == "dev"
+Requires-Dist: coverage[toml]; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: sphinx; extra == "dev"
+Requires-Dist: sphinx_rtd_theme; extra == "dev"
+Requires-Dist: sphinx-autoapi; extra == "dev"
+Requires-Dist: tox; extra == "dev"
+Requires-Dist: myst_parser; extra == "dev"
+Provides-Extra: publishing
+Requires-Dist: twine; extra == "publishing"
+Requires-Dist: wheel; extra == "publishing"
+
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10018768.svg)](https://doi.org/10.5281/zenodo.10018768) [![workflow pypi badge](https://img.shields.io/pypi/v/distance_explainer.svg?colorB=blue)](https://pypi.python.org/project/distance_explainer/)
+
+# `distance_explainer`
+
+XAI method to explain distances in embedded spaces.
+
+![overview schema](https://github.com/user-attachments/assets/bbd5a79c-c50b-47a2-89fc-d8ed3053c845)
+
+
+## Installation
+
+To install distance_explainer from GitHub repository, do:
+
+```console
+git clone git@github.com:dianna-ai/distance_explainer.git
+cd distance_explainer
+python3 -m pip install .
+```
+## How to use
+
+See our [tutorial](tutorial.ipynb) how to use this package.
+In short:
+```python
+image1 = np.random.random((100, 100, 3))
+image2 = np.random.random((100, 100, 3))
+
+image2_embedded = model(image2)
+explainer = DistanceExplainer(axis_labels={2: 'channels'})
+attribution_map = explainer.explain_image_distance(model, image1, image2_embedded)
+```
+## Contributing
+
+If you want to contribute to the development of distance_explainer,
+have a look at the [contribution guidelines](docs/CONTRIBUTING.md).
+
+## Credits
+
+This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [NLeSC/python-template](https://github.com/NLeSC/python-template).

distance_explainer-0.4.0/README.md

@@ -0,0 +1,38 @@
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10018768.svg)](https://doi.org/10.5281/zenodo.10018768) [![workflow pypi badge](https://img.shields.io/pypi/v/distance_explainer.svg?colorB=blue)](https://pypi.python.org/project/distance_explainer/)
+
+# `distance_explainer`
+
+XAI method to explain distances in embedded spaces.
+
+![overview schema](https://github.com/user-attachments/assets/bbd5a79c-c50b-47a2-89fc-d8ed3053c845)
+
+
+## Installation
+
+To install distance_explainer from GitHub repository, do:
+
+```console
+git clone git@github.com:dianna-ai/distance_explainer.git
+cd distance_explainer
+python3 -m pip install .
+```
+## How to use
+
+See our [tutorial](tutorial.ipynb) how to use this package.
+In short:
+```python
+image1 = np.random.random((100, 100, 3))
+image2 = np.random.random((100, 100, 3))
+
+image2_embedded = model(image2)
+explainer = DistanceExplainer(axis_labels={2: 'channels'})
+attribution_map = explainer.explain_image_distance(model, image1, image2_embedded)
+```
+## Contributing
+
+If you want to contribute to the development of distance_explainer,
+have a look at the [contribution guidelines](docs/CONTRIBUTING.md).
+
+## Credits
+
+This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [NLeSC/python-template](https://github.com/NLeSC/python-template).

distance_explainer-0.4.0/pyproject.toml

@@ -0,0 +1,95 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.coverage.run]
+branch = true
+source = ["distance_explainer"]
+command_line = "-m pytest"
+
+[tool.tox]
+legacy_tox_ini = """
+[tox]
+envlist = py39,py310,py311
+skip_missing_interpreters = true
+[testenv]
+commands = pytest
+extras = dev
+"""
+
+[tool.ruff]
+# Enable Pyflakes `E` and `F` codes by default.
+select = [
+    "F",  # Pyflakes
+    "E",  # pycodestyle (error)
+    "W",    # pycodestyle (warning)
+    # "C90",  # mccabe
+    "I",    # isort
+    "D",    # pydocstyle
+    # "PL",   # Pylint
+    # "PLC",  # Convention
+    # "PLE",  # Error
+    # "PLR",  # Refactor
+    # "PLW",  # Warning
+
+]
+ignore = [
+    'D100',  # Missing module docstring
+    # The following list excludes rules irrelevant to the Google style
+    'D203',
+    'D204',
+    'D213',
+    'D215',
+    'D400',
+    'D401',
+    'D404',
+    'D406',
+    'D407',
+    'D408',
+    'D409',
+    'D413',
+]
+
+# Allow autofix for all enabled rules (when `--fix`) is provided.
+fixable = ["A", "B", "C", "D", "E", "F", "I"]
+unfixable = []
+
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".hg",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "venv",
+    ".venv",
+    "scripts",
+]
+per-file-ignores = {}
+
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+target-version = "py39"
+line-length = 120
+
+[tool.ruff.isort]
+known-first-party = ["distance_explainer"]
+force-single-line = true
+no-lines-before = ["future","standard-library","third-party","first-party","local-folder"]

distance_explainer-0.4.0/setup.cfg

@@ -0,0 +1,57 @@
+[metadata]
+author = Christiaan Meijer
+author_email = c.meijer@esciencecenter.nl
+classifiers = 
+	Development Status :: 2 - Pre-Alpha
+	Intended Audience :: Developers
+	License :: OSI Approved :: Apache Software License
+	Natural Language :: English
+	Programming Language :: Python :: 3
+	Programming Language :: Python :: 3.9
+	Programming Language :: Python :: 3.10
+	Programming Language :: Python :: 3.11
+	Programming Language :: Python :: 3.12
+description = XAI method to explain distances in embedded spaces
+keywords = 
+	XAI
+	embedded spaces
+long_description = file: README.md
+long_description_content_type = text/markdown
+name = distance_explainer
+project_urls = 
+	Bug Tracker = https://github.com/dianna-ai/distance_explainer/issues
+url = https://github.com/dianna-ai/distance_explainer
+version = 0.4.0
+
+[options]
+python_requires = >=3.9
+install_requires = 
+	dianna>=1.4
+	numpy
+	pytest
+	tqdm
+	scikit-learn
+	pyyaml
+	dataclass_wizard
+
+[options.extras_require]
+dev = 
+	build
+	bump2version
+	coverage [toml]
+	ruff
+	pytest
+	pytest-cov
+	sphinx
+	sphinx_rtd_theme
+	sphinx-autoapi
+	tox
+	myst_parser
+publishing = 
+	twine
+	wheel
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

distance_explainer-0.4.0/src/distance_explainer.egg-info/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.1
+Name: distance_explainer
+Version: 0.4.0
+Summary: XAI method to explain distances in embedded spaces
+Home-page: https://github.com/dianna-ai/distance_explainer
+Author: Christiaan Meijer
+Author-email: c.meijer@esciencecenter.nl
+Project-URL: Bug Tracker, https://github.com/dianna-ai/distance_explainer/issues
+Keywords: XAI,embedded spaces
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: dianna>=1.4
+Requires-Dist: numpy
+Requires-Dist: pytest
+Requires-Dist: tqdm
+Requires-Dist: scikit-learn
+Requires-Dist: pyyaml
+Requires-Dist: dataclass_wizard
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: bump2version; extra == "dev"
+Requires-Dist: coverage[toml]; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: sphinx; extra == "dev"
+Requires-Dist: sphinx_rtd_theme; extra == "dev"
+Requires-Dist: sphinx-autoapi; extra == "dev"
+Requires-Dist: tox; extra == "dev"
+Requires-Dist: myst_parser; extra == "dev"
+Provides-Extra: publishing
+Requires-Dist: twine; extra == "publishing"
+Requires-Dist: wheel; extra == "publishing"
+
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10018768.svg)](https://doi.org/10.5281/zenodo.10018768) [![workflow pypi badge](https://img.shields.io/pypi/v/distance_explainer.svg?colorB=blue)](https://pypi.python.org/project/distance_explainer/)
+
+# `distance_explainer`
+
+XAI method to explain distances in embedded spaces.
+
+![overview schema](https://github.com/user-attachments/assets/bbd5a79c-c50b-47a2-89fc-d8ed3053c845)
+
+
+## Installation
+
+To install distance_explainer from GitHub repository, do:
+
+```console
+git clone git@github.com:dianna-ai/distance_explainer.git
+cd distance_explainer
+python3 -m pip install .
+```
+## How to use
+
+See our [tutorial](tutorial.ipynb) how to use this package.
+In short:
+```python
+image1 = np.random.random((100, 100, 3))
+image2 = np.random.random((100, 100, 3))
+
+image2_embedded = model(image2)
+explainer = DistanceExplainer(axis_labels={2: 'channels'})
+attribution_map = explainer.explain_image_distance(model, image1, image2_embedded)
+```
+## Contributing
+
+If you want to contribute to the development of distance_explainer,
+have a look at the [contribution guidelines](docs/CONTRIBUTING.md).
+
+## Credits
+
+This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [NLeSC/python-template](https://github.com/NLeSC/python-template).

distance_explainer-0.4.0/src/distance_explainer.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+CITATION.cff
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+setup.cfg
+src/distance_explainer.py
+src/distance_explainer.egg-info/PKG-INFO
+src/distance_explainer.egg-info/SOURCES.txt
+src/distance_explainer.egg-info/dependency_links.txt
+src/distance_explainer.egg-info/requires.txt
+src/distance_explainer.egg-info/top_level.txt
+tests/test_distance.py

distance_explainer-0.4.0/src/distance_explainer.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

distance_explainer-0.4.0/src/distance_explainer.egg-info/requires.txt

@@ -0,0 +1,24 @@
+dianna>=1.4
+numpy
+pytest
+tqdm
+scikit-learn
+pyyaml
+dataclass_wizard
+
+[dev]
+build
+bump2version
+coverage[toml]
+ruff
+pytest
+pytest-cov
+sphinx
+sphinx_rtd_theme
+sphinx-autoapi
+tox
+myst_parser
+
+[publishing]
+twine
+wheel

distance_explainer-0.4.0/src/distance_explainer.egg-info/top_level.txt

@@ -0,0 +1 @@
+distance_explainer

distance_explainer-0.4.0/src/distance_explainer.py

@@ -0,0 +1,205 @@
+"""Documentation about distance_explainer."""
+
+import logging
+import dianna.utils
+import numpy as np
+import numpy.typing
+from dianna.utils.maskers import generate_interpolated_float_masks_for_image
+from sklearn.metrics import pairwise_distances
+from tqdm import tqdm
+
+logging.getLogger(__name__).addHandler(logging.NullHandler())
+
+__author__ = "Christiaan Meijer"
+__email__ = "c.meijer@esciencecenter.nl"
+__version__ = "0.4.0"
+
+
+class DistanceExplainer:
+    """Explainer object to explain an image with respect to a reference point in an embedded space."""
+    # axis labels required to be present in input image data
+    required_labels = ('channels',)
+
+    def __init__(self, n_masks=1000, feature_res=8, p_keep=.5,  # pylint: disable=too-many-arguments
+                 mask_selection_range_max=0.2, mask_selection_range_min=0, mask_selection_negative_range_max=1,
+                 mask_selection_negative_range_min=0.8, axis_labels=None, batch_size=10,
+                 preprocess_function=None):
+        """Creates an explainer object to explain an image with respect to a reference point in an embedded space.
+
+        Args:
+            n_masks: Number of masks to use to mask the input image. More increases reliability and computation.
+            feature_res: Number of features per dimension in the image. Determines the super pixel size in the masks.
+            p_keep: Probability of keeping features unmasked. Higher means less masked input.
+            batch_size: Number of masked inputs to process in a single batch by the model
+            axis_labels: Axis labels
+            preprocess_function: Preprocess function
+            mask_selection_range_max: Top end of range of outcomes that will be selected.
+            mask_selection_range_min: Lower end of range of outcomes that will be selected.
+            mask_selection_negative_range_max: Top end of range of outcomes that will be selected and weighted -1.
+            mask_selection_negative_range_min: Lower end of range of outcomes that will be selected and weighted -1.
+        """
+        self.n_masks = n_masks
+        self.feature_res = feature_res
+        self.p_keep = p_keep
+        self.preprocess_function = preprocess_function
+        self.masks = None
+        self.predictions = None
+        self.axis_labels = axis_labels if axis_labels is not None else []
+        self.mask_selection_range_max = mask_selection_range_max
+        self.mask_selection_range_min = mask_selection_range_min
+        self.mask_selection_negative_range_max = mask_selection_negative_range_max
+        self.mask_selection_negative_range_min = mask_selection_negative_range_min
+        self.batch_size = batch_size
+
+    def explain_image_distance(self, model_or_function, input_data, embedded_reference, masks=None) -> tuple[
+        numpy.typing.NDArray, float]:
+        """Explain an image with respect to a reference point in an embedded space.
+
+        Args:
+            model_or_function: Model that will encode the input_data into an embedded space
+            input_data: Input data to be explained, by exploring what parts make it closer to the reference point.
+            embedded_reference: Reference point in the embedded space
+            masks: User specified masks, in case no autogenerated masks should be used.
+
+        Returns:
+            attribution_map map
+        """
+        full_preprocess_function, input_data = self._prepare_input_data(input_data)
+        runner = dianna.utils.get_function(model_or_function, preprocess_function=full_preprocess_function)
+        active_p_keep = 0.5 if self.p_keep is None else self.p_keep  # Could autotune here (See #319)
+
+        # data shape without batch axis and channel axis
+        img_shape = input_data.shape[1:3]
+        # Expose masks for to make user inspection possible
+        if masks is None:
+            self.masks = generate_interpolated_float_masks_for_image(img_shape, active_p_keep, self.n_masks,
+                                                                     self.feature_res)
+        else:
+            self.masks = masks
+            if self.masks.shape[0] != self.n_masks:
+                raise ValueError(f"Configured n_masks ({self.n_masks}) is not equal to the number of masks passed "
+                                 f"({self.masks.shape[0]}).")
+
+        # Make sure multiplication is being done for correct axes
+        masked = input_data * self.masks
+
+        batch_predictions = []
+
+        for i in tqdm(range(0, self.n_masks, self.batch_size), desc='Explaining'):
+            new_predictions = runner(masked[i:i + self.batch_size])
+            batch_predictions.append(new_predictions)
+
+        self.predictions = np.concatenate(batch_predictions)
+
+        def describe(x, name):
+            return f'Description of {name}\nmean:{np.mean(x)}\nstd:{np.std(x)}\nmin:{np.min(x)}\nmax:{np.max(x)}'
+
+        statistics = []
+
+        highest_distances_masks, highest_mask_weights = self._get_lowest_distance_masks_and_weights(
+            embedded_reference,
+            self.predictions, self.masks,
+            self.mask_selection_negative_range_min,
+            self.mask_selection_negative_range_max)
+
+        if len(highest_mask_weights) > 0:
+            statistics.append(describe(highest_mask_weights, 'highest_mask_weights'))
+            unnormalized_sal_highest = np.mean(highest_distances_masks, axis=0)
+        else:
+            unnormalized_sal_highest = 0
+
+        lowest_distances_masks, lowest_mask_weights = self._get_lowest_distance_masks_and_weights(
+            embedded_reference,
+            self.predictions, self.masks,
+            self.mask_selection_range_min,
+            self.mask_selection_range_max)
+
+        if len(lowest_mask_weights) > 0:
+            statistics.append(describe(lowest_mask_weights, 'lowest_mask_weights'))
+            unnormalized_sal_lowest = np.mean(lowest_distances_masks, axis=0)
+        else:
+            unnormalized_sal_lowest = 0
+
+        self.statistics = '\n'.join(statistics)
+        unnormalized_sal = unnormalized_sal_lowest - unnormalized_sal_highest
+
+        attribution_map = unnormalized_sal
+
+        return attribution_map
+
+    @staticmethod
+    def _get_lowest_distance_masks_and_weights(embedded_reference, predictions, masks, mask_selection_range_min,
+                                               mask_selection_range_max):
+        distances = DistanceExplainer.calculate_distances(predictions, embedded_reference[None, ...])
+
+        lowest_distances_indices = np.argsort(distances, axis=0)[
+                                   int(len(predictions) * mask_selection_range_min)
+                                   :int(len(predictions) * mask_selection_range_max)]
+        mask_weights = np.exp(-distances[lowest_distances_indices])
+        lowest_distances_masks = masks[lowest_distances_indices]
+        return lowest_distances_masks, mask_weights
+
+    @staticmethod
+    def calculate_distances(predictions: np.ndarray, embedded_reference: np.ndarray) -> np.ndarray:
+        """Calculate the distances to the reference point in an embedded space using cosine distance with range [0,1].
+
+        Args:
+            predictions: Batch of points in the embedded space for with distances are calculated
+            embedded_reference: Point to calculate the distance to
+
+        Returns:
+            Distances from each point to the reference point
+        """
+        distances = pairwise_distances(predictions, embedded_reference,
+                                       metric='cosine') / 2  # divide by 2 to have [0.1] output range
+        return distances
+
+    def _prepare_input_data(self, input_data):
+        input_data_xarray = dianna.utils.to_xarray(input_data, self.axis_labels, DistanceExplainer.required_labels)
+        input_data_xarray_expanded = input_data_xarray.expand_dims('batch', 0)
+        # ensure channels axis is last and keep track of where it was so we can move it back
+        channels_axis_index = input_data_xarray_expanded.dims.index('channels')
+        prepared_input_data = dianna.utils.move_axis(input_data_xarray_expanded, 'channels', -1)
+        # create preprocessing function that puts model input generated by RISE into the right shape and dtype,
+        # followed by running the user's preprocessing function
+        full_preprocess_function = self._get_full_preprocess_function(channels_axis_index, prepared_input_data.dtype)
+        return full_preprocess_function, prepared_input_data
+
+    def _prepare_image_data(self, input_data):
+        """Transforms the data to be of the shape and type RISE expects.
+
+        Args:
+            input_data (xarray): Data to be explained
+
+        Returns:
+            transformed input data, preprocessing function to use with dianna.utils.get_function()
+        """
+        # ensure channels axis is last and keep track of where it was so we can move it back
+        channels_axis_index = input_data.dims.index('channels')
+        input_data = dianna.utils.move_axis(input_data, 'channels', -1)
+        # create preprocessing function that puts model input generated by RISE into the right shape and dtype,
+        # followed by running the user's preprocessing function
+        full_preprocess_function = self._get_full_preprocess_function(channels_axis_index, input_data.dtype)
+        return input_data, full_preprocess_function
+
+    def _get_full_preprocess_function(self, channel_axis_index, dtype):
+        """Creates a full preprocessing function.
+
+        Creates a preprocessing function that incorporates both the (optional) user's
+        preprocessing function, as well as any needed dtype and shape conversions
+
+        Args:
+            channel_axis_index (int): Axis index of the channels in the input data
+            dtype (type): Data type of the input data (e.g. np.float32)
+
+        Returns:
+            Function that first ensures the data has the same shape and type as the input data,
+            then runs the users' preprocessing function
+        """
+
+        def moveaxis_function(data):
+            return dianna.utils.move_axis(data, 'channels', channel_axis_index).astype(dtype).values
+
+        if self.preprocess_function is None:
+            return moveaxis_function
+        return lambda data: self.preprocess_function(moveaxis_function(data))

distance_explainer-0.4.0/tests/test_distance.py

@@ -0,0 +1,79 @@
+"""Tests for the distance_explainer."""
+import dataclasses
+import os
+from typing import Callable
+import numpy as np
+import pytest
+from numpy.typing import ArrayLike
+from distance_explainer import DistanceExplainer
+from tests.config import Config
+from tests.config import get_default_config
+
+DUMMY_EMBEDDING_DIMENSIONALITY = 10
+
+
+@pytest.fixture(autouse=True)
+def set_all_the_seeds(seed_value=0):
+    """Set all necessary seeds."""
+    os.environ['PYTHONHASHSEED'] = str(seed_value)
+    np.random.seed(seed_value)
+
+
+@pytest.fixture()
+def dummy_model() -> Callable:
+    """Get a dummy model that returns a random embedding for every input in a batch."""
+    return lambda x: np.random.randn(x.shape[0], DUMMY_EMBEDDING_DIMENSIONALITY)
+
+
+@pytest.fixture
+def dummy_data() -> tuple[ArrayLike, ArrayLike]:
+    """Get random dummy data."""
+    embedded_reference = np.random.randn(DUMMY_EMBEDDING_DIMENSIONALITY)
+    input_arr = np.random.random((32, 32, 3))
+    return embedded_reference, input_arr
+
+
+def get_explainer(config: Config, axis_labels={2: 'channels'}, preprocess_function=None) -> DistanceExplainer:
+    """Get explainer object."""
+    explainer = DistanceExplainer(mask_selection_range_max=config.mask_selection_range_max,
+                                  mask_selection_range_min=config.mask_selection_range_min,
+                                  mask_selection_negative_range_max=config.mask_selection_negative_range_max,
+                                  mask_selection_negative_range_min=config.mask_selection_negative_range_min,
+                                  n_masks=config.number_of_masks,
+                                  axis_labels=axis_labels,
+                                  preprocess_function=preprocess_function,
+                                  feature_res=config.feature_res,
+                                  p_keep=config.p_keep)
+    return explainer
+
+
+def test_distance_explainer_saliency(dummy_data: tuple[ArrayLike, ArrayLike],
+                                     dummy_model: Callable):
+    """Code output should be identical to recorded saliency."""
+    embedded_reference, input_arr = dummy_data
+    explainer = get_explainer(get_default_config())
+    expected_saliency, expected_value = np.load('./tests/test_data/test_dummy_data_exact_expected_output.npz').values()
+
+    saliency = explainer.explain_image_distance(dummy_model, input_arr, embedded_reference)
+
+    assert saliency.shape == (1,) + input_arr.shape[:2] + (1,)  # Has correct shape
+    assert np.allclose(expected_saliency, saliency)  # Has correct saliency
+
+
+@pytest.mark.parametrize("empty_side,expected_tag",
+                         [({"mask_selection_range_max": 0.}, "pos_empty"),
+                          ({"mask_selection_negative_range_min": 1.}, "neg_empty")])
+def test_distance_explainer_one_sided_saliency(dummy_data: tuple[ArrayLike, ArrayLike],
+                                               dummy_model: Callable,
+                                               empty_side: dict[str, float],
+                                               expected_tag: str):
+    """Code output should be identical to recorded saliency."""
+    embedded_reference, input_arr = dummy_data
+    expected_saliency, expected_value = np.load(
+        f'./tests/test_data/test_dummy_data_exact_expected_output_{expected_tag}.npz').values()
+    config = dataclasses.replace(get_default_config(), **empty_side)
+    explainer = get_explainer(config)
+
+    saliency = explainer.explain_image_distance(dummy_model, input_arr, embedded_reference)
+    assert saliency.shape == (1,) + input_arr.shape[:2] + (1,)  # Has correct shape
+    assert np.allclose(expected_saliency, saliency)  # Has correct saliency