Skip to content

Commit 8b3ccd1

Browse files
Louis Pnicolasservel
andauthored
Improve docstring
Co-authored-by: nicolasservel <nico.servel@gmail.com>
1 parent 3309aca commit 8b3ccd1

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

dataikuapi/apinode_client.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ def predict_record(self, endpoint_id, features, forced_generation=None, dispatch
2626
:param forced_generation: See documentation about multi-version prediction
2727
:param dispatch_key: See documentation about multi-version prediction
2828
:param context: Optional, Python dictionary of additional context information. The context information is logged, but not directly used.
29-
:param with_explanations: Optional, whether individual explanations should be computed for each records. The prediction endpoint must be compatible.
30-
:param explanation_method: Optional, method to compute those explanations. If None, will use the value configured in the endpoint.
29+
:param with_explanations: Optional, whether individual explanations should be computed for each record. The prediction endpoint must be compatible. If None, will use the value configured in the endpoint.
30+
:param explanation_method: Optional, method to compute explanations. Valid values are 'SHAPLEY' or 'ICE'. If None, will use the value configured in the endpoint.
3131
:param n_explanations: Optional, number of explanations to output per prediction. If None, will use the value configured in the endpoint.
3232
:param n_explanations_mc_steps: Optional, precision parameter for SHAPLEY method, higher means more precise but slower (between 25 and 400).
3333
If None, will use the value configured in the endpoint.
@@ -62,8 +62,8 @@ def predict_records(self, endpoint_id, records, forced_generation=None, dispatch
6262
:param records: Python list of records. Each record must be a Python dict. Each record must contain a "features" dict (see predict_record) and optionally a "context" dict.
6363
:param forced_generation: See documentation about multi-version prediction
6464
:param dispatch_key: See documentation about multi-version prediction
65-
:param with_explanations: Optional, whether individual explanations should be computed for each records. The prediction endpoint must be compatible.
66-
:param explanation_method: Optional, method to compute those explanations. If None, will use the value configured in the endpoint.
65+
:param with_explanations: Optional, whether individual explanations should be computed for each record. The prediction endpoint must be compatible. If None, will use the value configured in the endpoint.
66+
:param explanation_method: Optional, method to compute explanations. Valid values are 'SHAPLEY' or 'ICE'. If None, will use the value configured in the endpoint.
6767
:param n_explanations: Optional, number of explanations to output per prediction. If None, will use the value configured in the endpoint.
6868
:param n_explanations_mc_steps: Optional, precision parameter for SHAPLEY method, higher means more precise but slower (between 25 and 400).
6969
If None, will use the value configured in the endpoint.

0 commit comments

Comments
 (0)