Skip to main content

XAI method to explain distances in embedded spaces

Project description

DOI workflow pypi badge

distance_explainer

XAI method to explain distances in embedded spaces.

overview schema

Installation

To install distance_explainer from GitHub repository, do:

git clone git@github.com:dianna-ai/distance_explainer.git
cd distance_explainer
python3 -m pip install .

How to use

See our tutorial how to use this package. In short:

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.

Credits

This package was created with Cookiecutter and the NLeSC/python-template.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

distance_explainer-0.4.0.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

distance_explainer-0.4.0-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

Details for the file distance_explainer-0.4.0.tar.gz.

File metadata

  • Download URL: distance_explainer-0.4.0.tar.gz
  • Upload date:
  • Size: 11.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for distance_explainer-0.4.0.tar.gz
Algorithm Hash digest
SHA256 10a0a76c8498556b4b68bd32e6347a5dba84cf5fc075f488eb86d123b6070bd1
MD5 d89492e3f36aa8627eeee2222c515a39
BLAKE2b-256 55394447603bbf70be426360a2de405d1d7ada3f3bf8753d10c44ea87edc184f

See more details on using hashes here.

Provenance

The following attestation bundles were made for distance_explainer-0.4.0.tar.gz:

Publisher: release.yml on dianna-ai/distance_explainer

Attestations:

File details

Details for the file distance_explainer-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for distance_explainer-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5925a51994d9c137380fcab658b8de4fce139480f9c3f43793b1be68453f09f5
MD5 6126bd2429f89546588d904330a14849
BLAKE2b-256 16945ed8a7c8f99c62fb54e52160bc45687ea859400dc33be8efe7c559a6d7db

See more details on using hashes here.

Provenance

The following attestation bundles were made for distance_explainer-0.4.0-py3-none-any.whl:

Publisher: release.yml on dianna-ai/distance_explainer

Attestations:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page