fix pulling of descriptions from docstrings

Author: paulb-seldon

docs-gb/SUMMARY-API.md

@@ -0,0 +1,83 @@
+* API Reference
+  * [`alibi`](api/alibi.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/SUMMARY.md

@@ -1,5 +1,3 @@
-# Summary
-
 # Table of contents
 
 ## Overview
@@ -95,87 +93,8 @@
     * [ProtoSelect](source/methods/protoselect.md)
   * Examples
     * [ProtoSelect on Adult Census and CIFAR10](source/examples/protoselect_adult_cifar10.md)
+  
 
 ## API Reference
 
-* [`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)
+* [\[Annotation Based Configuration\]](api-reference/annotation-based-configuration.md)

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

@@ -81,8 +81,8 @@ An explainer instance.
 
 | Name | Type | Default | Description |
 | ---- | ---- | ------- | ----------- |
-| `path` | `Union[str, os.PathLike]` |  |  |
-| `predictor` | `typing.Any` |  |  |
+| `path` | `Union[str, os.PathLike]` |  | Path to a directory containing the saved explainer. |
+| `predictor` | `typing.Any` |  | Model or prediction function used to originally initialize the explainer. |
 
 **Returns**
 - Type: `alibi.api.interfaces.Explainer`
@@ -102,7 +102,7 @@ predictor
 
 | Name | Type | Default | Description |
 | ---- | ---- | ------- | ----------- |
-| `predictor` | `typing.Any` |  |  |
+| `predictor` | `typing.Any` |  | New predictor. |
 
 **Returns**
 - Type: `None`
@@ -122,7 +122,7 @@ path
 
 | Name | Type | Default | Description |
 | ---- | ---- | ------- | ----------- |
-| `path` | `Union[str, os.PathLike]` |  |  |
+| `path` | `Union[str, os.PathLike]` |  | Path to a directory. A new directory will be created if one does not exist. |
 
 **Returns**
 - Type: `None`
@@ -163,7 +163,7 @@ An Explanation object.
 
 | Name | Type | Default | Description |
 | ---- | ---- | ------- | ----------- |
-| `jsonrepr` |  |  |  |
+| `jsonrepr` |  |  | `json` representation of an explanation. |
 
 **Returns**
 - Type: `alibi.api.interfaces.Explanation`

docs-gb/api/alibi/confidence/model_linearity.md

@@ -10,13 +10,13 @@ LinearityMeasure(self, method: str = 'grid', epsilon: float = 0.04, nb_samples:
 
 | Name | Type | Default | Description |
 | ---- | ---- | ------- | ----------- |
-| `method` | `str` | `'grid'` |  |
-| `epsilon` | `float` | `0.04` |  |
-| `nb_samples` | `int` | `10` |  |
-| `res` | `int` | `100` |  |
-| `alphas` | `Optional[numpy.ndarray]` | `None` |  |
-| `model_type` | `str` | `'classifier'` |  |
-| `agg` | `str` | `'pairwise'` |  |
+| `method` | `str` | `'grid'` | Method for sampling. Supported methods: ``'knn'`` | ``'grid'``. |
+| `epsilon` | `float` | `0.04` | Size of the sampling region around the central instance as a percentage of the features range. |
+| `nb_samples` | `int` | `10` | Number of samples to generate. |
+| `res` | `int` | `100` | Resolution of the grid. Number of intervals in which the feature range is discretized. |
+| `alphas` | `Optional[numpy.ndarray]` | `None` | Coefficients in the superposition. |
+| `model_type` | `str` | `'classifier'` | Type of task. Supported values: ``'regressor'`` | ``'classifier'``. |
+| `agg` | `str` | `'pairwise'` | Aggregation method. Supported values: ``'global'`` | ``'pairwise'``. |
 | `verbose` | `bool` | `False` |  |
 
 #### Methods
@@ -35,7 +35,7 @@ X_train
 
 | Name | Type | Default | Description |
 | ---- | ---- | ------- | ----------- |
-| `X_train` | `numpy.ndarray` |  |  |
+| `X_train` | `numpy.ndarray` |  | Training set. |
 
 **Returns**
 - Type: `None`
@@ -60,8 +60,8 @@ Linearity measure.
 
 | Name | Type | Default | Description |
 | ---- | ---- | ------- | ----------- |
-| `predict_fn` | `Callable` |  |  |
-| `x` | `numpy.ndarray` |  |  |
+| `predict_fn` | `Callable` |  | Prediction function. |
+| `x` | `numpy.ndarray` |  | Instance of interest. |
 
 **Returns**
 - Type: `numpy.ndarray`
@@ -86,7 +86,7 @@ Feature range.
 
 | Name | Type | Default | Description |
 | ---- | ---- | ------- | ----------- |
-| `X_train` | `numpy.ndarray` |  |  |
+| `X_train` | `numpy.ndarray` |  | Training set. |
 
 **Returns**
 - Type: `numpy.ndarray`
@@ -130,17 +130,17 @@ Linearity measure.
 
 | Name | Type | Default | Description |
 | ---- | ---- | ------- | ----------- |
-| `predict_fn` | `Callable` |  |  |
-| `x` | `numpy.ndarray` |  |  |
-| `feature_range` | `Union[List[Any], numpy.ndarray, None]` | `None` |  |
-| `method` | `str` | `'grid'` |  |
-| `X_train` | `Optional[numpy.ndarray]` | `None` |  |
-| `epsilon` | `float` | `0.04` |  |
-| `nb_samples` | `int` | `10` |  |
-| `res` | `int` | `100` |  |
-| `alphas` | `Optional[numpy.ndarray]` | `None` |  |
-| `agg` | `str` | `'global'` |  |
-| `model_type` | `str` | `'classifier'` |  |
+| `predict_fn` | `Callable` |  | Predict function. |
+| `x` | `numpy.ndarray` |  | Instance of interest. |
+| `feature_range` | `Union[List[Any], numpy.ndarray, None]` | `None` | Array with min and max values for each feature. |
+| `method` | `str` | `'grid'` | Method for sampling. Supported values: ``'knn'`` | ``'grid'``. |
+| `X_train` | `Optional[numpy.ndarray]` | `None` | Training set. |
+| `epsilon` | `float` | `0.04` | Size of the sampling region as a percentage of the feature range. |
+| `nb_samples` | `int` | `10` | Number of samples to generate. |
+| `res` | `int` | `100` | Resolution of the grid. Number of intervals in which the features range is discretized. |
+| `alphas` | `Optional[numpy.ndarray]` | `None` | Coefficients in the superposition. |
+| `agg` | `str` | `'global'` | Aggregation method. Supported values: ``'global'`` | ``'pairwise'``. |
+| `model_type` | `str` | `'classifier'` | Type of task. Supported values: ``'regressor'`` | ``'classifier'``. |
 
 **Returns**
 - Type: `numpy.ndarray`