Api Reference for Gitbook docs

docs-gb/SUMMARY.md

@@ -97,4 +97,84 @@
 
 ## API Reference
 
-* [Annotation Based Configuration](api-reference/annotation-based-configuration.md)
+  * [`alibi.api`](api/alibi/api.md)
+    * [`alibi.api.defaults`](api/alibi/api/defaults.md)
+    * [`alibi.api.interfaces`](api/alibi/api/interfaces.md)
+  * [`alibi.confidence`](api/alibi/confidence.md)
+    * [`alibi.confidence.model_linearity`](api/alibi/confidence/model_linearity.md)
+    * [`alibi.confidence.trustscore`](api/alibi/confidence/trustscore.md)
+  * [`alibi.datasets`](api/alibi/datasets.md)
+    * [`alibi.datasets.default`](api/alibi/datasets/default.md)
+    * [`alibi.datasets.tensorflow`](api/alibi/datasets/tensorflow.md)
+  * [`alibi.exceptions`](api/alibi/exceptions.md)
+  * [`alibi.explainers`](api/alibi/explainers.md)
+    * [`alibi.explainers.ale`](api/alibi/explainers/ale.md)
+    * [`alibi.explainers.anchors`](api/alibi/explainers/anchors.md)
+      * [`alibi.explainers.anchors.anchor_base`](api/alibi/explainers/anchors/anchor_base.md)
+      * [`alibi.explainers.anchors.anchor_explanation`](api/alibi/explainers/anchors/anchor_explanation.md)
+      * [`alibi.explainers.anchors.anchor_image`](api/alibi/explainers/anchors/anchor_image.md)
+      * [`alibi.explainers.anchors.anchor_tabular`](api/alibi/explainers/anchors/anchor_tabular.md)
+      * [`alibi.explainers.anchors.anchor_tabular_distributed`](api/alibi/explainers/anchors/anchor_tabular_distributed.md)
+      * [`alibi.explainers.anchors.anchor_text`](api/alibi/explainers/anchors/anchor_text.md)
+      * [`alibi.explainers.anchors.language_model_text_sampler`](api/alibi/explainers/anchors/language_model_text_sampler.md)
+      * [`alibi.explainers.anchors.text_samplers`](api/alibi/explainers/anchors/text_samplers.md)
+    * [`alibi.explainers.backends`](api/alibi/explainers/backends.md)
+      * [`alibi.explainers.backends.cfrl_base`](api/alibi/explainers/backends/cfrl_base.md)
+      * [`alibi.explainers.backends.cfrl_tabular`](api/alibi/explainers/backends/cfrl_tabular.md)
+      * [`alibi.explainers.backends.pytorch`](api/alibi/explainers/backends/pytorch.md)
+        * [`alibi.explainers.backends.pytorch.cfrl_base`](api/alibi/explainers/backends/pytorch/cfrl_base.md)
+        * [`alibi.explainers.backends.pytorch.cfrl_tabular`](api/alibi/explainers/backends/pytorch/cfrl_tabular.md)
+      * [`alibi.explainers.backends.tensorflow`](api/alibi/explainers/backends/tensorflow.md)
+        * [`alibi.explainers.backends.tensorflow.cfrl_base`](api/alibi/explainers/backends/tensorflow/cfrl_base.md)
+        * [`alibi.explainers.backends.tensorflow.cfrl_tabular`](api/alibi/explainers/backends/tensorflow/cfrl_tabular.md)
+    * [`alibi.explainers.cem`](api/alibi/explainers/cem.md)
+    * [`alibi.explainers.cfproto`](api/alibi/explainers/cfproto.md)
+    * [`alibi.explainers.cfrl_base`](api/alibi/explainers/cfrl_base.md)
+    * [`alibi.explainers.cfrl_tabular`](api/alibi/explainers/cfrl_tabular.md)
+    * [`alibi.explainers.counterfactual`](api/alibi/explainers/counterfactual.md)
+    * [`alibi.explainers.integrated_gradients`](api/alibi/explainers/integrated_gradients.md)
+    * [`alibi.explainers.partial_dependence`](api/alibi/explainers/partial_dependence.md)
+    * [`alibi.explainers.pd_variance`](api/alibi/explainers/pd_variance.md)
+    * [`alibi.explainers.permutation_importance`](api/alibi/explainers/permutation_importance.md)
+    * [`alibi.explainers.shap_wrappers`](api/alibi/explainers/shap_wrappers.md)
+    * [`alibi.explainers.similarity`](api/alibi/explainers/similarity.md)
+      * [`alibi.explainers.similarity.backends`](api/alibi/explainers/similarity/backends.md)
+        * [`alibi.explainers.similarity.backends.pytorch`](api/alibi/explainers/similarity/backends/pytorch.md)
+          * [`alibi.explainers.similarity.backends.pytorch.base`](api/alibi/explainers/similarity/backends/pytorch/base.md)
+        * [`alibi.explainers.similarity.backends.tensorflow`](api/alibi/explainers/similarity/backends/tensorflow.md)
+          * [`alibi.explainers.similarity.backends.tensorflow.base`](api/alibi/explainers/similarity/backends/tensorflow/base.md)
+      * [`alibi.explainers.similarity.base`](api/alibi/explainers/similarity/base.md)
+      * [`alibi.explainers.similarity.grad`](api/alibi/explainers/similarity/grad.md)
+      * [`alibi.explainers.similarity.metrics`](api/alibi/explainers/similarity/metrics.md)
+  * [`alibi.models`](api/alibi/models.md)
+    * [`alibi.models.pytorch`](api/alibi/models/pytorch.md)
+      * [`alibi.models.pytorch.actor_critic`](api/alibi/models/pytorch/actor_critic.md)
+      * [`alibi.models.pytorch.autoencoder`](api/alibi/models/pytorch/autoencoder.md)
+      * [`alibi.models.pytorch.cfrl_models`](api/alibi/models/pytorch/cfrl_models.md)
+      * [`alibi.models.pytorch.metrics`](api/alibi/models/pytorch/metrics.md)
+      * [`alibi.models.pytorch.model`](api/alibi/models/pytorch/model.md)
+    * [`alibi.models.tensorflow`](api/alibi/models/tensorflow.md)
+      * [`alibi.models.tensorflow.actor_critic`](api/alibi/models/tensorflow/actor_critic.md)
+      * [`alibi.models.tensorflow.autoencoder`](api/alibi/models/tensorflow/autoencoder.md)
+      * [`alibi.models.tensorflow.cfrl_models`](api/alibi/models/tensorflow/cfrl_models.md)
+  * [`alibi.prototypes`](api/alibi/prototypes.md)
+    * [`alibi.prototypes.protoselect`](api/alibi/prototypes/protoselect.md)
+  * [`alibi.saving`](api/alibi/saving.md)
+  * [`alibi.utils`](api/alibi/utils.md)
+    * [`alibi.utils.approximation_methods`](api/alibi/utils/approximation_methods.md)
+    * [`alibi.utils.data`](api/alibi/utils/data.md)
+    * [`alibi.utils.discretizer`](api/alibi/utils/discretizer.md)
+    * [`alibi.utils.distance`](api/alibi/utils/distance.md)
+    * [`alibi.utils.distributed`](api/alibi/utils/distributed.md)
+    * [`alibi.utils.distributions`](api/alibi/utils/distributions.md)
+    * [`alibi.utils.download`](api/alibi/utils/download.md)
+    * [`alibi.utils.frameworks`](api/alibi/utils/frameworks.md)
+    * [`alibi.utils.gradients`](api/alibi/utils/gradients.md)
+    * [`alibi.utils.kernel`](api/alibi/utils/kernel.md)
+    * [`alibi.utils.lang_model`](api/alibi/utils/lang_model.md)
+    * [`alibi.utils.mapping`](api/alibi/utils/mapping.md)
+    * [`alibi.utils.missing_optional_dependency`](api/alibi/utils/missing_optional_dependency.md)
+    * [`alibi.utils.tf`](api/alibi/utils/tf.md)
+    * [`alibi.utils.visualization`](api/alibi/utils/visualization.md)
+    * [`alibi.utils.wrappers`](api/alibi/utils/wrappers.md)
+  * [`alibi.version`](api/alibi/version.md)

docs-gb/api/alibi.md

@@ -0,0 +1 @@
+# `alibi`

docs-gb/api/alibi/api.md

@@ -0,0 +1 @@
+# `alibi.api`

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

@@ -0,0 +1,169 @@
+# `alibi.api.defaults`
+
+This module defines the default metadata and data dictionaries for each explanation method.
+Note that the "name" field is automatically populated upon initialization of the corresponding
+Explainer class.
+
+## Constants
+### `DEFAULT_META_ANCHOR`
+```python
+DEFAULT_META_ANCHOR: dict = {'name': None, 'type': ['blackbox'], 'explanations': ['local'], 'params': {},...
+```
+
+### `DEFAULT_DATA_ANCHOR`
+```python
+DEFAULT_DATA_ANCHOR: dict = {'anchor': [], 'precision': None, 'coverage': None, 'raw': None}
+```
+
+### `DEFAULT_DATA_ANCHOR_IMG`
+```python
+DEFAULT_DATA_ANCHOR_IMG: dict = {'anchor': [], 'segments': None, 'precision': None, 'coverage': None, 'raw': ...
+```
+
+### `DEFAULT_META_CEM`
+```python
+DEFAULT_META_CEM: dict = {'name': None, 'type': ['blackbox', 'tensorflow', 'keras'], 'explanations': [...
+```
+
+### `DEFAULT_DATA_CEM`
+```python
+DEFAULT_DATA_CEM: dict = {'PN': None, 'PP': None, 'PN_pred': None, 'PP_pred': None, 'grads_graph': Non...
+```
+
+### `DEFAULT_META_CF`
+```python
+DEFAULT_META_CF: dict = {'name': None, 'type': ['blackbox', 'tensorflow', 'keras'], 'explanations': [...
+```
+
+### `DEFAULT_DATA_CF`
+```python
+DEFAULT_DATA_CF: dict = {'cf': None, 'all': [], 'orig_class': None, 'orig_proba': None, 'success': None}
+```
+
+### `DEFAULT_META_CFP`
+```python
+DEFAULT_META_CFP: dict = {'name': None, 'type': ['blackbox', 'tensorflow', 'keras'], 'explanations': [...
+```
+
+### `DEFAULT_DATA_CFP`
+```python
+DEFAULT_DATA_CFP: dict = {'cf': None, 'all': [], 'orig_class': None, 'orig_proba': None, 'id_proto': N...
+```
+
+### `KERNEL_SHAP_PARAMS`
+```python
+KERNEL_SHAP_PARAMS: list = ['link', 'group_names', 'grouped', 'groups', 'weights', 'summarise_background...
+```
+Built-in mutable sequence.
+
+If no argument is given, the constructor creates a new empty list.
+The argument must be an iterable if specified.
+
+### `DEFAULT_META_KERNEL_SHAP`
+```python
+DEFAULT_META_KERNEL_SHAP: dict = {'name': None, 'type': ['blackbox'], 'task': None, 'explanations': ['local', ...
+```
+
+### `DEFAULT_DATA_KERNEL_SHAP`
+```python
+DEFAULT_DATA_KERNEL_SHAP: dict = {'shap_values': [], 'expected_value': [], 'categorical_names': {}, 'feature_n...
+```
+
+### `DEFAULT_META_ALE`
+```python
+DEFAULT_META_ALE: dict = {'name': None, 'type': ['blackbox'], 'explanations': ['global'], 'params': {}...
+```
+
+### `DEFAULT_DATA_ALE`
+```python
+DEFAULT_DATA_ALE: dict = {'ale_values': [], 'constant_value': None, 'ale0': [], 'feature_values': [], ...
+```
+
+### `TREE_SHAP_PARAMS`
+```python
+TREE_SHAP_PARAMS: list = ['model_output', 'summarise_background', 'summarise_result', 'approximate', '...
+```
+Built-in mutable sequence.
+
+If no argument is given, the constructor creates a new empty list.
+The argument must be an iterable if specified.
+
+### `DEFAULT_META_TREE_SHAP`
+```python
+DEFAULT_META_TREE_SHAP: dict = {'name': None, 'type': ['whitebox'], 'task': None, 'explanations': ['local', ...
+```
+
+### `DEFAULT_DATA_TREE_SHAP`
+```python
+DEFAULT_DATA_TREE_SHAP: dict = {'shap_values': [], 'shap_interaction_values': [], 'expected_value': [], 'cat...
+```
+
+### `DEFAULT_META_INTGRAD`
+```python
+DEFAULT_META_INTGRAD: dict = {'name': None, 'type': ['whitebox'], 'explanations': ['local'], 'params': {},...
+```
+
+### `DEFAULT_DATA_INTGRAD`
+```python
+DEFAULT_DATA_INTGRAD: dict = {'attributions': None, 'X': None, 'forward_kwargs': None, 'baselines': None, ...
+```
+
+### `DEFAULT_META_CFRL`
+```python
+DEFAULT_META_CFRL: dict = {'name': None, 'type': ['blackbox'], 'explanations': ['local'], 'params': {},...
+```
+
+### `DEFAULT_DATA_CFRL`
+```python
+DEFAULT_DATA_CFRL: dict = {'orig': None, 'cf': None, 'target': None, 'condition': None}
+```
+
+### `DEFAULT_META_SIM`
+```python
+DEFAULT_META_SIM: dict = {'name': None, 'type': ['whitebox'], 'explanations': ['local'], 'params': {},...
+```
+
+### `DEFAULT_DATA_SIM`
+```python
+DEFAULT_DATA_SIM: dict = {'scores': None, 'ordered_indices': None, 'most_similar': None, 'least_simila...
+```
+
+### `DEFAULT_META_PROTOSELECT`
+```python
+DEFAULT_META_PROTOSELECT: dict = {'name': None, 'type': ['data'], 'explanation': ['global'], 'params': {}, 've...
+```
+
+### `DEFAULT_DATA_PROTOSELECT`
+```python
+DEFAULT_DATA_PROTOSELECT: dict = {'prototypes': None, 'prototype_indices': None, 'prototype_labels': None}
+```
+
+### `DEFAULT_META_PD`
+```python
+DEFAULT_META_PD: dict = {'name': None, 'type': ['blackbox'], 'explanations': ['global'], 'params': {}...
+```
+
+### `DEFAULT_DATA_PD`
+```python
+DEFAULT_DATA_PD: dict = {'feature_deciles': None, 'pd_values': None, 'ice_values': None, 'feature_val...
+```
+
+### `DEFAULT_META_PDVARIANCE`
+```python
+DEFAULT_META_PDVARIANCE: dict = {'name': None, 'type': ['blackbox'], 'explanations': ['global'], 'params': {}...
+```
+
+### `DEFAULT_DATA_PDVARIANCE`
+```python
+DEFAULT_DATA_PDVARIANCE: dict = {'feature_deciles': None, 'pd_values': None, 'feature_values': None, 'feature...
+```
+
+### `DEFAULT_META_PERMUTATION_IMPORTANCE`
+```python
+DEFAULT_META_PERMUTATION_IMPORTANCE: dict = {'name': None, 'type': ['blackbox'], 'explanations': ['global'], 'params': {}...
+```
+
+### `DEFAULT_DATA_PERMUTATION_IMPORTANCE`
+```python
+DEFAULT_DATA_PERMUTATION_IMPORTANCE: dict = {'feature_names': None, 'metric_names': None, 'feature_importance': None}
+```