Skip to content

Commit

Permalink
updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
annahedstroem committed Oct 18, 2022
1 parent e85a726 commit 9b1c1bb
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 11 deletions.
2 changes: 0 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ In this guide, you will get an overview of the workflow and best practices for c
**Questions.** If you have any developer-related questions, please [open an issue](https://github.com/understandable-machine-intelligence-lab/Quantus/issues/new/choose)
or write us at [[email protected]](mailto:[email protected]).

<!-- omit in toc -->

## Table of Contents

- [Reporting Bugs](#reporting-bugs)
Expand Down
2 changes: 0 additions & 2 deletions docs/source/docs_dev/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ In this guide, you will get an overview of the workflow and best practices for c
**Questions.** If you have any developer-related questions, please [open an issue](https://github.com/understandable-machine-intelligence-lab/Quantus/issues/new/choose)
or write us at [[email protected]](mailto:[email protected]).

<!-- omit in toc -->

## Table of Contents

- [Reporting Bugs](#reporting-bugs)
Expand Down
8 changes: 4 additions & 4 deletions docs/source/getting_started/getting_started_example.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The following will give a short introduction to how to get started with Quantus.

**Note**: This example is based on the [PyTorch](https://pytorch.org/) framework, but we also support
Note that this example is based on the [PyTorch](https://pytorch.org/) framework, but we also support
[Tensorflow](https://www.tensorflow.org), which would differ only in the {ref}`preliminaries <prelim>`
(i.e., the model and data loading),
as well as in the available XAI libraries.
Expand Down Expand Up @@ -101,8 +101,8 @@ in `quantus.explain` are limited --- `quantus.explain` is a wrapper around [Cap
[tf.explain](https://github.com/sicara/tf-explain) but does not support every explanation method offered in the
respective libraries.

If you want to use Quantus to evaluate any other explanation method (e.g., your newly built explanation function),
you can simply provide your own function (`callable`, see also {ref}`extending quantus <extend>`).
If you want to use Quantus to evaluate any arbitrary explanation method (e.g., your newly built explanation function),
you can simply provide your own function (`callable`, see also {ref}`Extending quantus <extend>`).
Examples of how to use `quantus.explain`
or your own customised explanation function are included in the next section.
![drawing](../assets/mnist_example.png)
Expand All @@ -118,7 +118,7 @@ To gather quantitative evidence for the quality of the different explanation met
### Quantus metrics

Quantus implements XAI evaluation metrics from different categories,
e.g., Faithfulness, Localisation, Robustness, etc., which all inherit from the base `quantus.Metric` class.
e.g., Faithfulness, Localisation and Robustness etc which all inherit from the base `quantus.Metric` class.
To apply a metric to your setting (e.g., [Max-Sensitivity](https://arxiv.org/abs/1901.09392))
it first needs to be instantiated:

Expand Down
5 changes: 2 additions & 3 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@ Quantus can be installed from PyPI (this way assumes that you have either [PyTor
pip install quantus
```

For a more in-depth guide on how to install Quantus, read more {doc}`here </getting_started/installation>`. This includes instructions for how to install a desired deep learning framework such as PyTorch or tensorflow together with Quantus.
For a more in-depth guide on how to install Quantus, read more [here](https://quantus.readthedocs.io/en/latest/getting_started/installation.html). This includes instructions for how to install a desired deep learning framework such as PyTorch or tensorflow together with Quantus.

# Contents

```{toctree}
:caption: # Installation
:caption: Installation
:maxdepth: 1
getting_started/installation
Expand All @@ -47,7 +47,6 @@ getting_started/getting_started_example
:caption: API Reference
:maxdepth: 1
docs_api/modules
docs_api/quantus
```

Expand Down

0 comments on commit 9b1c1bb

Please sign in to comment.