Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Trust score high level docs and exposing confidence in alibi #53

Merged
merged 1 commit into from
May 2, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions alibi/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from . import datasets, explainers, utils
from . import confidence, datasets, explainers, utils
from .version import __version__

__all__ = ['datasets', 'explainers', 'utils']
__all__ = ['confidence', 'datasets', 'explainers', 'utils']
2 changes: 1 addition & 1 deletion doc/source/methods/Trust Scores.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"[source](../api/alibi.confidence.rst)"
"[[source]](../api/alibi.confidence.rst)"
]
},
{
Expand Down
11 changes: 11 additions & 0 deletions doc/source/overview/algorithms.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,14 @@ of the instance to keep the same prediciton). The PN instance identifies the fea
minimally and necessarily absent to maintain the original prediction (a PN acts as the closest
instance that would result in a different prediction). [Documentation](../methods/CEM.ipynb),
[tabular example](../examples/cem_iris.ipynb), [image classification](../examples/cem_mnist.ipynb).


## Model Confidence
These algorihtms provide instance-specific scores measuring the model confidence for making a
certain prediction.

|Algorithm|Classification|Regression|Categorical features|Tabular|Text|Images|Needs training set|
|---|---|---|---|---|
|[Trust Scores](../methods/Trust\ Scores.ipynb)|✔|✘|✘|✔|✔[^1]|✔[^2]|Yes|
[^1]: Depending on model
[^2]: May require dimensionality reduction
15 changes: 13 additions & 2 deletions doc/source/overview/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,25 @@ To get a list of the latest available model explanation algorithms, you can type
import alibi
alibi.explainers.__all__
```
<div class="highlight"><pre>
```
['AnchorTabular', 'AnchorText', 'AnchorImage', 'CEM']
</pre></div>
```

For gauging model confidence:
```python
alibi.confidence.__all__
```
```
['TrustScore']
```



For detailed information on the methods:
* [Overview of available methods](../overview/algorithms.md)
* [Anchor explanations](../methods/Anchors.ipynb)
* [Contrastive Explanation Method (CEM)](../methods/CEM.ipynb)
* [Trust Scores](../methods/Trust\ Scores.ipynb)

## Basic Usage
We will use the [Anchor method on tabular data](../methods/Anchors.ipynb#Tabular-Data) to illustrate
Expand Down