Skip to content

Commit 99c3421

Browse files
paulb-seldonpaulb-seldon
authored
Api Reference for Gitbook docs (#1061)
* initial render of alibi api ref * update summary level * fix pulling of descriptions from docstrings * update summary.md * add default subpackages (api) * remove constructor eplanation * remove default constructor explanation * restructure hierarchy formatting * remove duplicated params text * remove duplicated params * Nest methods under heading * remove inherited docstrings (rst) * remove inherited docstrings 2 * remove excess mds * Remove generation file (temp) * include inherited descriptions * remove constants, dup params * bring back function defs * bring back constants * revert to constants, functions * revert to reestablish correct formatting * remove dupe descriptions * Delete docs-gb/README.md * Delete docs-gb/SUMMARY-API.md * Delete docs-gb/generate_api_docs.py
1 parent 78ded52 commit 99c3421

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

84 files changed

+8266
-3
lines changed

‎docs-gb/SUMMARY.md‎

Lines changed: 81 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,4 +97,84 @@
9797

9898
## API Reference
9999

100-
* [Annotation Based Configuration](api-reference/annotation-based-configuration.md)
100+
* [`alibi.api`](api/alibi/api.md)
101+
* [`alibi.api.defaults`](api/alibi/api/defaults.md)
102+
* [`alibi.api.interfaces`](api/alibi/api/interfaces.md)
103+
* [`alibi.confidence`](api/alibi/confidence.md)
104+
* [`alibi.confidence.model_linearity`](api/alibi/confidence/model_linearity.md)
105+
* [`alibi.confidence.trustscore`](api/alibi/confidence/trustscore.md)
106+
* [`alibi.datasets`](api/alibi/datasets.md)
107+
* [`alibi.datasets.default`](api/alibi/datasets/default.md)
108+
* [`alibi.datasets.tensorflow`](api/alibi/datasets/tensorflow.md)
109+
* [`alibi.exceptions`](api/alibi/exceptions.md)
110+
* [`alibi.explainers`](api/alibi/explainers.md)
111+
* [`alibi.explainers.ale`](api/alibi/explainers/ale.md)
112+
* [`alibi.explainers.anchors`](api/alibi/explainers/anchors.md)
113+
* [`alibi.explainers.anchors.anchor_base`](api/alibi/explainers/anchors/anchor_base.md)
114+
* [`alibi.explainers.anchors.anchor_explanation`](api/alibi/explainers/anchors/anchor_explanation.md)
115+
* [`alibi.explainers.anchors.anchor_image`](api/alibi/explainers/anchors/anchor_image.md)
116+
* [`alibi.explainers.anchors.anchor_tabular`](api/alibi/explainers/anchors/anchor_tabular.md)
117+
* [`alibi.explainers.anchors.anchor_tabular_distributed`](api/alibi/explainers/anchors/anchor_tabular_distributed.md)
118+
* [`alibi.explainers.anchors.anchor_text`](api/alibi/explainers/anchors/anchor_text.md)
119+
* [`alibi.explainers.anchors.language_model_text_sampler`](api/alibi/explainers/anchors/language_model_text_sampler.md)
120+
* [`alibi.explainers.anchors.text_samplers`](api/alibi/explainers/anchors/text_samplers.md)
121+
* [`alibi.explainers.backends`](api/alibi/explainers/backends.md)
122+
* [`alibi.explainers.backends.cfrl_base`](api/alibi/explainers/backends/cfrl_base.md)
123+
* [`alibi.explainers.backends.cfrl_tabular`](api/alibi/explainers/backends/cfrl_tabular.md)
124+
* [`alibi.explainers.backends.pytorch`](api/alibi/explainers/backends/pytorch.md)
125+
* [`alibi.explainers.backends.pytorch.cfrl_base`](api/alibi/explainers/backends/pytorch/cfrl_base.md)
126+
* [`alibi.explainers.backends.pytorch.cfrl_tabular`](api/alibi/explainers/backends/pytorch/cfrl_tabular.md)
127+
* [`alibi.explainers.backends.tensorflow`](api/alibi/explainers/backends/tensorflow.md)
128+
* [`alibi.explainers.backends.tensorflow.cfrl_base`](api/alibi/explainers/backends/tensorflow/cfrl_base.md)
129+
* [`alibi.explainers.backends.tensorflow.cfrl_tabular`](api/alibi/explainers/backends/tensorflow/cfrl_tabular.md)
130+
* [`alibi.explainers.cem`](api/alibi/explainers/cem.md)
131+
* [`alibi.explainers.cfproto`](api/alibi/explainers/cfproto.md)
132+
* [`alibi.explainers.cfrl_base`](api/alibi/explainers/cfrl_base.md)
133+
* [`alibi.explainers.cfrl_tabular`](api/alibi/explainers/cfrl_tabular.md)
134+
* [`alibi.explainers.counterfactual`](api/alibi/explainers/counterfactual.md)
135+
* [`alibi.explainers.integrated_gradients`](api/alibi/explainers/integrated_gradients.md)
136+
* [`alibi.explainers.partial_dependence`](api/alibi/explainers/partial_dependence.md)
137+
* [`alibi.explainers.pd_variance`](api/alibi/explainers/pd_variance.md)
138+
* [`alibi.explainers.permutation_importance`](api/alibi/explainers/permutation_importance.md)
139+
* [`alibi.explainers.shap_wrappers`](api/alibi/explainers/shap_wrappers.md)
140+
* [`alibi.explainers.similarity`](api/alibi/explainers/similarity.md)
141+
* [`alibi.explainers.similarity.backends`](api/alibi/explainers/similarity/backends.md)
142+
* [`alibi.explainers.similarity.backends.pytorch`](api/alibi/explainers/similarity/backends/pytorch.md)
143+
* [`alibi.explainers.similarity.backends.pytorch.base`](api/alibi/explainers/similarity/backends/pytorch/base.md)
144+
* [`alibi.explainers.similarity.backends.tensorflow`](api/alibi/explainers/similarity/backends/tensorflow.md)
145+
* [`alibi.explainers.similarity.backends.tensorflow.base`](api/alibi/explainers/similarity/backends/tensorflow/base.md)
146+
* [`alibi.explainers.similarity.base`](api/alibi/explainers/similarity/base.md)
147+
* [`alibi.explainers.similarity.grad`](api/alibi/explainers/similarity/grad.md)
148+
* [`alibi.explainers.similarity.metrics`](api/alibi/explainers/similarity/metrics.md)
149+
* [`alibi.models`](api/alibi/models.md)
150+
* [`alibi.models.pytorch`](api/alibi/models/pytorch.md)
151+
* [`alibi.models.pytorch.actor_critic`](api/alibi/models/pytorch/actor_critic.md)
152+
* [`alibi.models.pytorch.autoencoder`](api/alibi/models/pytorch/autoencoder.md)
153+
* [`alibi.models.pytorch.cfrl_models`](api/alibi/models/pytorch/cfrl_models.md)
154+
* [`alibi.models.pytorch.metrics`](api/alibi/models/pytorch/metrics.md)
155+
* [`alibi.models.pytorch.model`](api/alibi/models/pytorch/model.md)
156+
* [`alibi.models.tensorflow`](api/alibi/models/tensorflow.md)
157+
* [`alibi.models.tensorflow.actor_critic`](api/alibi/models/tensorflow/actor_critic.md)
158+
* [`alibi.models.tensorflow.autoencoder`](api/alibi/models/tensorflow/autoencoder.md)
159+
* [`alibi.models.tensorflow.cfrl_models`](api/alibi/models/tensorflow/cfrl_models.md)
160+
* [`alibi.prototypes`](api/alibi/prototypes.md)
161+
* [`alibi.prototypes.protoselect`](api/alibi/prototypes/protoselect.md)
162+
* [`alibi.saving`](api/alibi/saving.md)
163+
* [`alibi.utils`](api/alibi/utils.md)
164+
* [`alibi.utils.approximation_methods`](api/alibi/utils/approximation_methods.md)
165+
* [`alibi.utils.data`](api/alibi/utils/data.md)
166+
* [`alibi.utils.discretizer`](api/alibi/utils/discretizer.md)
167+
* [`alibi.utils.distance`](api/alibi/utils/distance.md)
168+
* [`alibi.utils.distributed`](api/alibi/utils/distributed.md)
169+
* [`alibi.utils.distributions`](api/alibi/utils/distributions.md)
170+
* [`alibi.utils.download`](api/alibi/utils/download.md)
171+
* [`alibi.utils.frameworks`](api/alibi/utils/frameworks.md)
172+
* [`alibi.utils.gradients`](api/alibi/utils/gradients.md)
173+
* [`alibi.utils.kernel`](api/alibi/utils/kernel.md)
174+
* [`alibi.utils.lang_model`](api/alibi/utils/lang_model.md)
175+
* [`alibi.utils.mapping`](api/alibi/utils/mapping.md)
176+
* [`alibi.utils.missing_optional_dependency`](api/alibi/utils/missing_optional_dependency.md)
177+
* [`alibi.utils.tf`](api/alibi/utils/tf.md)
178+
* [`alibi.utils.visualization`](api/alibi/utils/visualization.md)
179+
* [`alibi.utils.wrappers`](api/alibi/utils/wrappers.md)
180+
* [`alibi.version`](api/alibi/version.md)

‎docs-gb/api-reference/annotation-based-configuration.md‎

Lines changed: 0 additions & 2 deletions
This file was deleted.

‎docs-gb/api/alibi.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# `alibi`

‎docs-gb/api/alibi/api.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# `alibi.api`

‎docs-gb/api/alibi/api/defaults.md‎

Lines changed: 169 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,169 @@
1+
# `alibi.api.defaults`
2+
3+
This module defines the default metadata and data dictionaries for each explanation method.
4+
Note that the "name" field is automatically populated upon initialization of the corresponding
5+
Explainer class.
6+
7+
## Constants
8+
### `DEFAULT_META_ANCHOR`
9+
```python
10+
DEFAULT_META_ANCHOR: dict = {'name': None, 'type': ['blackbox'], 'explanations': ['local'], 'params': {},...
11+
```
12+
13+
### `DEFAULT_DATA_ANCHOR`
14+
```python
15+
DEFAULT_DATA_ANCHOR: dict = {'anchor': [], 'precision': None, 'coverage': None, 'raw': None}
16+
```
17+
18+
### `DEFAULT_DATA_ANCHOR_IMG`
19+
```python
20+
DEFAULT_DATA_ANCHOR_IMG: dict = {'anchor': [], 'segments': None, 'precision': None, 'coverage': None, 'raw': ...
21+
```
22+
23+
### `DEFAULT_META_CEM`
24+
```python
25+
DEFAULT_META_CEM: dict = {'name': None, 'type': ['blackbox', 'tensorflow', 'keras'], 'explanations': [...
26+
```
27+
28+
### `DEFAULT_DATA_CEM`
29+
```python
30+
DEFAULT_DATA_CEM: dict = {'PN': None, 'PP': None, 'PN_pred': None, 'PP_pred': None, 'grads_graph': Non...
31+
```
32+
33+
### `DEFAULT_META_CF`
34+
```python
35+
DEFAULT_META_CF: dict = {'name': None, 'type': ['blackbox', 'tensorflow', 'keras'], 'explanations': [...
36+
```
37+
38+
### `DEFAULT_DATA_CF`
39+
```python
40+
DEFAULT_DATA_CF: dict = {'cf': None, 'all': [], 'orig_class': None, 'orig_proba': None, 'success': None}
41+
```
42+
43+
### `DEFAULT_META_CFP`
44+
```python
45+
DEFAULT_META_CFP: dict = {'name': None, 'type': ['blackbox', 'tensorflow', 'keras'], 'explanations': [...
46+
```
47+
48+
### `DEFAULT_DATA_CFP`
49+
```python
50+
DEFAULT_DATA_CFP: dict = {'cf': None, 'all': [], 'orig_class': None, 'orig_proba': None, 'id_proto': N...
51+
```
52+
53+
### `KERNEL_SHAP_PARAMS`
54+
```python
55+
KERNEL_SHAP_PARAMS: list = ['link', 'group_names', 'grouped', 'groups', 'weights', 'summarise_background...
56+
```
57+
Built-in mutable sequence.
58+
59+
If no argument is given, the constructor creates a new empty list.
60+
The argument must be an iterable if specified.
61+
62+
### `DEFAULT_META_KERNEL_SHAP`
63+
```python
64+
DEFAULT_META_KERNEL_SHAP: dict = {'name': None, 'type': ['blackbox'], 'task': None, 'explanations': ['local', ...
65+
```
66+
67+
### `DEFAULT_DATA_KERNEL_SHAP`
68+
```python
69+
DEFAULT_DATA_KERNEL_SHAP: dict = {'shap_values': [], 'expected_value': [], 'categorical_names': {}, 'feature_n...
70+
```
71+
72+
### `DEFAULT_META_ALE`
73+
```python
74+
DEFAULT_META_ALE: dict = {'name': None, 'type': ['blackbox'], 'explanations': ['global'], 'params': {}...
75+
```
76+
77+
### `DEFAULT_DATA_ALE`
78+
```python
79+
DEFAULT_DATA_ALE: dict = {'ale_values': [], 'constant_value': None, 'ale0': [], 'feature_values': [], ...
80+
```
81+
82+
### `TREE_SHAP_PARAMS`
83+
```python
84+
TREE_SHAP_PARAMS: list = ['model_output', 'summarise_background', 'summarise_result', 'approximate', '...
85+
```
86+
Built-in mutable sequence.
87+
88+
If no argument is given, the constructor creates a new empty list.
89+
The argument must be an iterable if specified.
90+
91+
### `DEFAULT_META_TREE_SHAP`
92+
```python
93+
DEFAULT_META_TREE_SHAP: dict = {'name': None, 'type': ['whitebox'], 'task': None, 'explanations': ['local', ...
94+
```
95+
96+
### `DEFAULT_DATA_TREE_SHAP`
97+
```python
98+
DEFAULT_DATA_TREE_SHAP: dict = {'shap_values': [], 'shap_interaction_values': [], 'expected_value': [], 'cat...
99+
```
100+
101+
### `DEFAULT_META_INTGRAD`
102+
```python
103+
DEFAULT_META_INTGRAD: dict = {'name': None, 'type': ['whitebox'], 'explanations': ['local'], 'params': {},...
104+
```
105+
106+
### `DEFAULT_DATA_INTGRAD`
107+
```python
108+
DEFAULT_DATA_INTGRAD: dict = {'attributions': None, 'X': None, 'forward_kwargs': None, 'baselines': None, ...
109+
```
110+
111+
### `DEFAULT_META_CFRL`
112+
```python
113+
DEFAULT_META_CFRL: dict = {'name': None, 'type': ['blackbox'], 'explanations': ['local'], 'params': {},...
114+
```
115+
116+
### `DEFAULT_DATA_CFRL`
117+
```python
118+
DEFAULT_DATA_CFRL: dict = {'orig': None, 'cf': None, 'target': None, 'condition': None}
119+
```
120+
121+
### `DEFAULT_META_SIM`
122+
```python
123+
DEFAULT_META_SIM: dict = {'name': None, 'type': ['whitebox'], 'explanations': ['local'], 'params': {},...
124+
```
125+
126+
### `DEFAULT_DATA_SIM`
127+
```python
128+
DEFAULT_DATA_SIM: dict = {'scores': None, 'ordered_indices': None, 'most_similar': None, 'least_simila...
129+
```
130+
131+
### `DEFAULT_META_PROTOSELECT`
132+
```python
133+
DEFAULT_META_PROTOSELECT: dict = {'name': None, 'type': ['data'], 'explanation': ['global'], 'params': {}, 've...
134+
```
135+
136+
### `DEFAULT_DATA_PROTOSELECT`
137+
```python
138+
DEFAULT_DATA_PROTOSELECT: dict = {'prototypes': None, 'prototype_indices': None, 'prototype_labels': None}
139+
```
140+
141+
### `DEFAULT_META_PD`
142+
```python
143+
DEFAULT_META_PD: dict = {'name': None, 'type': ['blackbox'], 'explanations': ['global'], 'params': {}...
144+
```
145+
146+
### `DEFAULT_DATA_PD`
147+
```python
148+
DEFAULT_DATA_PD: dict = {'feature_deciles': None, 'pd_values': None, 'ice_values': None, 'feature_val...
149+
```
150+
151+
### `DEFAULT_META_PDVARIANCE`
152+
```python
153+
DEFAULT_META_PDVARIANCE: dict = {'name': None, 'type': ['blackbox'], 'explanations': ['global'], 'params': {}...
154+
```
155+
156+
### `DEFAULT_DATA_PDVARIANCE`
157+
```python
158+
DEFAULT_DATA_PDVARIANCE: dict = {'feature_deciles': None, 'pd_values': None, 'feature_values': None, 'feature...
159+
```
160+
161+
### `DEFAULT_META_PERMUTATION_IMPORTANCE`
162+
```python
163+
DEFAULT_META_PERMUTATION_IMPORTANCE: dict = {'name': None, 'type': ['blackbox'], 'explanations': ['global'], 'params': {}...
164+
```
165+
166+
### `DEFAULT_DATA_PERMUTATION_IMPORTANCE`
167+
```python
168+
DEFAULT_DATA_PERMUTATION_IMPORTANCE: dict = {'feature_names': None, 'metric_names': None, 'feature_importance': None}
169+
```

0 commit comments

Comments
 (0)