Skip to content

Commit 4e37334

Browse files
authored
Removing deprecated 'robust calculation' flags in user guide. (#49)
Fixed references to robust calculations in the user guides that have been deprecated in the next release.
1 parent 962fd27 commit 4e37334

3 files changed

+2
-5
lines changed

source/user_guide/feature_importance.rst

+1-2
Original file line numberDiff line numberDiff line change
@@ -85,12 +85,11 @@ metrics may be specified together, but for this example they are separated. If r
8585
Local Feature Importance
8686
^^^^^^^^^^^^^^^^^^^^^^^^
8787
To get local feature importance metrics, :py:meth:`Trainee.react`, is first called on a trained and analyzed Trainee. In this method, the desired metrics, ``feature_contributions`` and ``feature_mda``, can be selected as inputs to the ``details`` parameters as key value pairs from a dictionary. These parameters are named individually
88-
and setting them to ``True`` will calculate the desired metrics. To calculate the robust versions, ``robust_computation`` is set to True.
88+
and setting them to ``True`` will calculate the desired metrics. Robust calculations are performed by default.
8989

9090
.. code-block:: python
9191
9292
details = {
93-
'robust_computation':True,
9493
'feature_contributions':True,
9594
'feature_mda':True,
9695
}

source/user_guide/influential_data_counterfactuals_uncertainty.rst

-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,6 @@ We will use the local feature residual to examine the uncertainty for a specific
7575
## Compute local feature residuals
7676
# Details describe the information we are getting from a given react call
7777
details = {
78-
'robust_computation': True,
7978
'feature_residuals': True,
8079
}
8180

source/user_guide/understanding_predictions.rst

+1-2
Original file line numberDiff line numberDiff line change
@@ -93,12 +93,11 @@ the power set of all combinations with and without the case of interest. Robust
9393

9494

9595
To get the case importance metrics, :py:meth:`Trainee.react`, is first called on a trained and analyzed Trainee. In this method, the desired metrics, ``case_contributions`` and ``case_mda``, can be selected as inputs to the ``details`` parameters as key value pairs from a dictionary. These parameters are named individually
96-
and setting them to ``True`` will calculate the desired metrics. To calculate the robust versions, ``robust_computation`` is set to True.
96+
and setting them to ``True`` will calculate the desired metrics. Robust computation is performed by default.
9797

9898
.. code-block:: python
9999
100100
details = {
101-
'robust_computation':True,
102101
'case_contributions':True,
103102
'case_mda':True,
104103
}

0 commit comments

Comments
 (0)