Skip to content

Commit

Permalink
add link to tutorial from README.md, fixes #17
Browse files Browse the repository at this point in the history
  • Loading branch information
cwmeijer committed Nov 5, 2024
1 parent b561d99 commit c63c97c
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,18 @@ git clone [email protected]: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,
Expand Down

0 comments on commit c63c97c

Please sign in to comment.