Skip to content

Commit b4b4638

Browse files
ScienfitzAdrianSosic
authored andcommitted
Edit text
1 parent c9c1e45 commit b4b4638

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

docs/userguide/insights.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ In what follows, we show results for the campaign studied in the
1010
[full lookup example](./../../examples/Backtesting/full_lookup), which aims at
1111
maximizing the yield of a chemical reaction and involves three substance parameters and
1212
two discrete numerical parameters. We randomly sample 100 measurements from the
13-
lookup table and add them to the campaign, providing a basis for creating a
14-
[`SHAPInsight`](baybe.insights.shap.SHAPInsight).
13+
lookup table and add them to the campaign, providing a basis for creating an insight.
1514
```
1615

1716
## Parameter Importance via SHAP
@@ -34,7 +33,7 @@ the obtained parameter importances for convergence and consistency.
3433
```
3534

3635
### Basic Usage
37-
[`SHAPInsight`](baybe.insights.shap.SHAPInsight) can be obtained in several ways:
36+
A [`SHAPInsight`](baybe.insights.shap.SHAPInsight) can be obtained in several ways:
3837
- From a [`Campaign`](baybe.campaign.Campaign) via
3938
[`from_campaign`](baybe.insights.shap.SHAPInsight.from_campaign):
4039
~~~python
@@ -57,7 +56,10 @@ experimental campaign (for instance, [`from_campaign`](baybe.insights.shap.SHAPI
5756
automatically extracts the `measurements` from the `campaign` object).
5857

5958
### Plots
60-
After creating the insight, various methods are available to visualize the results.
59+
After creating the insight, various methods are available to visualize the results via
60+
the [.plot](baybe.insights.shap.SHAPInsight.plot)
61+
interface, please refer to [available SHAP plots](baybe.insights.shap.SHAP_PLOTS).
62+
6163
~~~python
6264
insight.plot("bar")
6365
~~~
@@ -66,9 +68,6 @@ insight.plot("bar")
6668
This result agrees well with the chemical intuition that ligands are the most important
6769
reactants to activate the conversion, resulting in higher yields.
6870

69-
A subset of SHAP plots is available via the [.plot](baybe.insights.shap.SHAPInsight.plot)
70-
interface, please refer to [available SHAP plots](baybe.insights.shap.SHAP_PLOTS).
71-
7271
Such plots can also be created for data sets other than the background data that
7372
was used to generate the insight. If this is desired, pass your data frame as second
7473
argument:
@@ -114,11 +113,11 @@ Attempts to use other explainers will result in an
114113

115114
A feature importance study can still be performed by looking at the computational
116115
representation of the data points, activated by the `use_comp_rep` flag. Since all
117-
entries in this representation are numeric by default, there are no limitations on the
118-
explainer type used. A study of the computational representation might also be useful
119-
if a deeper analysis of descriptors used is of interest to the user. In general, for
120-
each non-numerical parameter in the experimental representation, there will be several
121-
descriptors the computational representation:
116+
entries in this representation are numeric by construction, there are no limitations on
117+
the explainer type used. A study of the computational representation might also be
118+
useful if a deeper analysis of descriptors used is of interest to the user. In general,
119+
for each non-numerical parameter in the experimental representation, there will be
120+
several descriptors the computational representation:
122121
~~~python
123122
insight = SHAPInsight.from_campaign(campaign, use_comp_rep=True)
124123
insight.plot("bar")

0 commit comments

Comments
 (0)